Dash Extensions

2.0.5 · active · verified Sat Apr 11

The `dash-extensions` package is a comprehensive collection of utility functions, syntax extensions, and custom components designed to enhance the Plotly Dash development experience. It provides features like server-side caching, enhanced callbacks (e.g., blocking, multiplexing, server-side outputs), JavaScript interoperability, and enriched Dash components. Currently at version 2.0.5, the library maintains an active and regular release cadence, with multiple patch and major version updates throughout the year to introduce new features and address breaking changes in underlying libraries like Dash.

Warnings

breaking Version 2.0.0 introduced significant breaking changes, primarily requiring Dash 3.0.2 or later. Ensure your core Dash library is updated to avoid compatibility issues. Older `LogTransform`, `NoOutputTransform`, and the `dataiku` module were removed.
Fix: Upgrade Dash to >=3.0.2. Replace `LogTransform` usage with the new `dash_extensions.logging` module. Remove `NoOutputTransform` as Dash 2.17.0+ supports callbacks without outputs. Remove usage of the `dataiku` module.
breaking The `Lottie` component's interface changed in `2.0.0`. Style arguments like `width` or `height` can no longer be passed directly as keyword arguments but must be nested within the `style` dictionary inside the `options` property.
Fix: Refactor Lottie component usage: `Lottie(options=dict(style=dict(width='25%', margin='auto')), ...)` instead of `Lottie(style=dict(width='25%', margin='auto'), ...)` or `Lottie(width='25%', ...)` (if it ever supported direct `width`).
breaking In version 1.0.0, the `ServersideOutputTransform` syntax changed. Instead of replacing `Output` with `ServersideOutput`, you must now wrap the return values of your callback in a `Serverside` object.
Fix: Update callbacks using `ServersideOutputTransform` to wrap return values: `return Serverside(my_data)` instead of relying on the `Output` replacement.
breaking The `OperatorTransform` was removed in version 1.0.0 as similar functionality became available natively in Dash 2.9 through partial property updates.
Fix: Migrate any `OperatorTransform` usage to Dash 2.9's partial property updates for similar functionality.
gotcha For many of the advanced features and 'transforms' provided by `dash-extensions` (like `BlockingCallbackTransform`, `ServersideOutputTransform`, `BaseModelTransform`), you must use `DashProxy` imported from `dash_extensions.enrich` instead of the standard `dash.Dash` app object.
Fix: Always import `DashProxy` with `from dash_extensions.enrich import DashProxy` when leveraging `dash-extensions`' advanced functionalities.
gotcha When using `DashProxy` from `dash_extensions.enrich`, it's generally recommended to import core Dash components (e.g., `html`, `dcc`, `Input`, `Output`, `State`) directly from `dash_extensions.enrich` as well. Importing them from the standard `dash` package might prevent them from benefiting from certain enrichments or transformations.
Fix: Adjust import statements: `from dash_extensions.enrich import html, dcc, Input, Output` instead of `from dash import html, dcc, Input, Output`.

Install

pip install dash-extensions Install with pip

Imports

DashProxy
```
from dash_extensions.enrich import DashProxy
```
Use `DashProxy` from `dash_extensions.enrich` to enable many of the library's advanced features and transforms.
Lottie
```
from dash_extensions import Lottie
```
Components provided by `dash-extensions` are often imported directly from the top-level package.
assign
```
from dash_extensions.javascript import assign
```
Functions for JavaScript interoperability are found in the `javascript` module.
html
```
from dash_extensions.enrich import html
```
When using `DashProxy` from `dash_extensions.enrich`, it's recommended to import core Dash components (like `html`, `dcc`, `Input`, `Output`) also from `dash_extensions.enrich` to ensure full compatibility with enriched features and transforms.

ServersideOutput

from dash_extensions.enrich import ServersideOutput

Quickstart

This minimal example demonstrates how to create a basic Dash application using `DashProxy` from `dash-extensions.enrich` and incorporate a custom `Lottie` component for animated visuals. The `Lottie` component fetches an animation from a URL and displays it, showcasing easy integration of extended functionalities.

import dash_html_components as html # Kept for general compatibility 
from dash_extensions import Lottie
from dash_extensions.enrich import DashProxy

app = DashProxy()

app.layout = html.Div([ 
    html.H1("Dash-Extensions Lottie Example"),
    Lottie(
        options=dict(
            loop=True,
            autoplay=True,
            style=dict(width="25%", margin="auto"),
        ),
        url="https://assets6.lottiefiles.com/packages/lf20_rwwvwgka.json",
    )
])

if __name__ == "__main__":
    app.run_server(debug=True)

view raw JSON →