Skip to main content

Vuetify widgets for trame

Project description

Test and Release

Trame-vuetify extend trame widgets and ui with all the beautiful Vuetify UI components. Vuetify is a UI Library with beautifully handcrafted Material Components. No design skills required — everything you need to create amazing applications is at your fingertips.

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-vuetify can be installed with pip:

pip install --upgrade trame-vuetify

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.

The Vuetify website is very well made for exploring components and understanding components’ parameters and controls, while a reference to our wrapper API is available here.

The way trame translate Vue templates into plain Python code is by doing the following.

Material Design Widgets

First you need to import the vuetify module so you can instantiate the various Material Components like illustrated below. Moreover, in the documentation the component names use dashes as separators while in Python we use the Camelcase notation for the class name.

from trame.widgets import vuetify

# <v-btn>Hello World</v-btn>
btn = vuetify.VBtn("Hello World")

Boolean attributes

Implicit attribute values must be made explicit in Python by assigning True to them.

# <v-text-field disabled />
vuetify.VTextField(disabled=True)

Dash and colon separators

Any special characters (- and :) become _ in Python.

# <v-text-field v-model="myText" />
vuetify.VTextField(v_model=("myText",))

Events

Events in vue are prefixed with a @ but in Python we declare them the same way we declare regular attributes.

def runMethod():
    pass

# <v-btn @click="runMethod" />
vuetify.VBtn(click=runMethod)

License

trame-vuetify is made available under the MIT License. For more details, see LICENSE This license has been chosen to match the one use by Vuetify 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.

JavaScript dependency

This Python package bundle the following Vuetify libraries. For client_type="vue2", it exposes vuetify@2.7.1 and for client_type="vue3", it exposes vuetify@3.7.6. If you would like us to upgrade any of those dependencies, please reach out.

Project details


Download files

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

Source Distribution

trame_vuetify-2.8.1.tar.gz (4.9 MB view details)

Uploaded Source

Built Distribution

trame_vuetify-2.8.1-py3-none-any.whl (4.9 MB view details)

Uploaded Python 3

File details

Details for the file trame_vuetify-2.8.1.tar.gz.

File metadata

  • Download URL: trame_vuetify-2.8.1.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for trame_vuetify-2.8.1.tar.gz
Algorithm Hash digest
SHA256 281606797c29b0300ec2b3524c4396ac2b78da1a300d188d603af09eea83bfe2
MD5 668f2bce0d51ab11e1e1e89e7dff4a38
BLAKE2b-256 6b16d71e8f0c07e4ee964014c352caef33e5d7c179f1e19af27d37739c8ef072

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_vuetify-2.8.1.tar.gz:

Publisher: test_and_release.yml on Kitware/trame-vuetify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trame_vuetify-2.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for trame_vuetify-2.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 47d35ab4ec6d37ad1ad8e63c0a2de7c25677f62ef383f1b1e06dd74dda8a3767
MD5 2600d09729de750ce8094953241fbca2
BLAKE2b-256 2e06141c4b3383d89854265d8fae61be23e852bd4d4bdd7f49e10c95f15168c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_vuetify-2.8.1-py3-none-any.whl:

Publisher: test_and_release.yml on Kitware/trame-vuetify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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