Install & Compatibility
Where this runs
tested against v1.11.3 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 2.467s · 90.9MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 5.6s · import 2.217s · 91MB
83MB installed
● package 83MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
v
✓ import ipyvuetify as v
✗ import ipyvuetify
The common convention is to import ipyvuetify as 'v' for brevity, similar to 'np' for NumPy.
Btn
✓ v.Btn()
✗ v.v_btn() or v.button()
Vuetify component names (e.g., `<v-btn>`) are translated to Python as CamelCase classes with the 'v-' prefix stripped (e.g., `v.Btn`).
This quickstart demonstrates creating a button and a text field, attaching an event listener to the button, and updating the text field's value using the `v_model` attribute. It showcases basic widget creation, event handling, and displaying components in a Jupyter environment.
import ipyvuetify as v
from IPython.display import display
# Create a text field to display messages
message_output = v.TextField(label="Message", readonly=True, v_model="Click the button!")
# Define a callback function for the button click
def on_button_click(widget, event, data):
message_output.v_model = "Button was clicked!"
# Create a button and attach the event listener
button = v.Btn(children=["Click Me"])
button.on_event('click', on_button_click)
# Display the widgets within a container
display(v.Container(children=[button, message_output]))
Debug
Known issues
breakingipyvuetify's API conventions differ significantly from standard ipywidgets and direct Vuetify HTML. Component names are CamelCase with 'v-' stripped (e.g., `v.Btn` for `<v-btn>`). Attributes are snake_case (e.g., `offset_y` for `offset-y`). Child components and text are passed via the `children` traitlet, and event listeners are set using the `.on_event(event_name, callback)` method. CSS `class` and `style` attributes require an underscore suffix (`class_`, `style_`).fixAlways refer to the ipyvuetify documentation's 'Usage' section or translate directly from Vuetify documentation by applying ipyvuetify's specific naming and API conventions.
affects: All versions
gotchaIn-place mutations of list or dictionary traitlets (e.g., appending to `my_list_traitlet.append('item')`) are not detected by ipywidgets' change notification system, which ipyvuetify relies upon. This means the frontend widget will not update.fixTo update list or dictionary traitlets, always assign a *new* list or dictionary object. For example, `my_widget.items = my_widget.items + ['New Item']` or `my_widget.items = [*my_widget.items, 'New Item']`.
affects: All versions
gotchaThe `value` attribute on ipyvuetify widgets is primarily for *setting* an initial value and does not reflect user interactions or two-way data binding. For interactive components where the user's input needs to be read, use the `v_model` attribute instead.fixInitialize interactive components with `v_model` (e.g., `v.Slider(v_model=25)`), and read the current state from `widget.v_model`.
affects: All versions
breakingipyvuetify 3.0.0a2 and subsequent 3.x alpha releases are unstable, based on Vue 3.x, and primarily for future Solara 3.0 integration. They may have significant visual and functional breakage (e.g., issues with Vuetify2 appearance) and are not recommended for general use with ipyvuetify 1.x-based applications.fixFor stable applications, strictly pin to `ipyvuetify<3.0.0` (i.e., use versions in the 1.x series).
affects: 3.0.0a2 and later alpha/prerelease versions
gotchaFor users of JupyterLab, a separate JupyterLab extension must be installed (`jupyter labextension install jupyter-vuetify`) in addition to the pip package for ipyvuetify widgets to render correctly.fixRun `jupyter labextension install jupyter-vuetify` in your terminal where JupyterLab is installed.
affects: All versions when using JupyterLab
gotchaIn Google Colab environments, `ipyvuetify` widgets may fail to render with an 'Unknown dependency jupyter-vue' error due to how Colab handles widget dependencies. This typically requires specific workarounds involving ensuring the `jupyter-vue` module is explicitly loaded.fixConsult specific Colab-related issues on the `ipyvuetify` GitHub or Colab documentation for current workarounds, often involving programmatic loading of `jupyter-vue`.
affects: All versions when used in Google Colab
gotchaThe `v.FileUpload` widget has been reported to cause kernel crashes (`Kernel died`) when used with `ipykernel` versions greater than 6.29.fixDowngrade `ipykernel` to version <= 6.29 if using `v.FileUpload`, or avoid using the `v.FileUpload` widget until a fix is released.
affects: All versions when using ipykernel > 6.29
Errors
Common errors & fixes
Error displaying widget: model not found
This error often occurs when the JupyterLab or Jupyter Notebook frontend extension for ipyvuetify (jupyter-vuetify) is not installed, enabled, or properly loaded, preventing the browser from rendering the Python widget model.
fixEnsure the ipyvuetify Python package and its corresponding JupyterLab extension are correctly installed and enabled: `pip install ipyvuetify` and `jupyter labextension install jupyter-vuetify` (for JupyterLab < 3) or ensure a compatible `ipywidgets` version is installed.
ModuleNotFoundError: No module named 'ipyvuetify'
The ipyvuetify Python package is not installed in the active Python environment or the environment where Jupyter is running.
fixInstall the ipyvuetify library using pip: `pip install ipyvuetify` or conda: `conda install -c conda-forge ipyvuetify`.
Voila Ipyvuetify coud not instantiate widget error
This issue in Voila often stems from an incompatibility between ipyvuetify and the currently installed version of ipywidgets, particularly with newer ipywidgets v8 versions.
fixDowngrade ipywidgets to a compatible version, for example: `pip install ipywidgets==7.7.1` and then reinstall the JupyterLab manager: `jupyter labextension install @jupyter-widgets/jupyterlab-manager`.
Error: No version of module jupyter-vuetify is registered.
JupyterLab cannot find or recognize the `jupyter-vuetify` frontend extension, which is essential for rendering ipyvuetify widgets, indicating a problem with its installation or registration.
fixInstall or reinstall the JupyterLab extension: `jupyter labextension install jupyter-vuetify`. If using JupyterLab 3+, ensure `ipywidgets` is also up-to-date as `jupyter-vuetify` depends on it.
Upgrade
Version history
1.11.3latest on PyPI · released Jul 2, 2025
Audit
Dependencies
ipywidgetsrequiredipyvuetify is built on top of the ipywidgets machinery.
jupyter-vuerequiredCore dependency for Vue.js integration, known to cause issues in environments like Google Colab.