Skip to main content

Internal client of trame

Project description

Test and Release

trame-client is the generic single page application that come with trame. trame-client provides the infrastructure on the client-side (browser) to connect to a trame server, synchronize its state with the server, make method call, load dynamically components and feed a dynamic template provided by the server.

This package is not supposed to be used by itself but rather should come as a dependency of trame. For any specificity, please refer to the trame documentation.

Installing

trame-client can be installed with pip:

pip install --upgrade trame-client

Usage

The Trame Tutorial is the place to go to learn how to use the library and start building your own application.

The API Reference documentation provides API-level documentation.

This library specifically brings the following set of vue.js components to the core client side application. They will be available as a library on NPM to support trame integration into existing vue.js based application.

<trame-connect name="TrameConnect" :config="{}" :exclude="[]" use-url forward-errors>
    <trame-server-template template-name="main" />

    <trame-loading message="welcome" />

    <trame-state-resolver :names="['a', 'b', 'c']" v-slot="{a, b, c, set, trame}">
        <div>
            <div>
                A: {{ a }}
            </div>
            <div>
                B: {{ b }}
            </div>
            <div>
                C: {{ c }}
            </div>
            <br>
            <button @click="trame.state.set('a', a + 1)">A+</button>
            <br>
            <button @click="set('a', a - 1)">A-</button>
            <br>
            <button>B</button>
            <br>
            <button>C</button>
        </div>
    </trame-state-resolver>
</trame-connect>

License

trame-client is made available under the MIT License. For more details, see LICENSE This license has been chosen to match the one use by Vue.js which is instrumental for making that library possible.

Community

Trame | Discussions | Issues | RoadMap | Contact Us

https://zenodo.org/badge/410108340.svg

Enjoying trame?

Share your experience with a testimonial or with a brand approval.

Development

Build client side code base

cd vue[2,3]-app
npm install
npm run build            # build trame client application
cd -

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trame-client-2.6.1.tar.gz (315.3 kB view hashes)

Uploaded Source

Built Distribution

trame_client-2.6.1-py3-none-any.whl (323.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page