One of the great things about Dash is that
The React community is huge. Thousands of components have been built and released with open source licenses by the React community, any of which could be adapted into a Dash component.
To create a Dash component, fork our sample component repository and follow the instructions in the
If you are a Python programmer who is just getting started with React.js, see React for Python Devs.
Dash provides a framework that converts React components
compatible with the Dash ecosystem.
On a high level, this is how that works:
- Components in Dash are serialized as JSON.
To write a Dash-compatible component, all of the props
shared between the Python code and the React code―numbers, strings, booleans,
as well as arrays or objects containing numbers, strings, or booleans―must be serializable as JSON.
In fact, if you try to add a function as a prop to your Dash component, you
will see that the generated Python code for your component will not include
that prop as part of your component’s accepted list of props.
(It’s not going to be listed in the
Keyword arguments enumeration or in the
self._prop_names array of the generated Python file for your component).
- By annotating components with React docstrings (not required but helpful
and encouraged), Dash extracts the information about the component’s name,
properties, and description through React Docgen.
This is exported as a JSON file (metadata.json).
- At build time, Dash reads this JSON file and dynamically creates Python classes
that subclass a core Dash component. These classes include argument validation,
Python docstrings, types, and a basic set of methods. These classes are
write any Python in order to generate a component that can be used in the
- You will find all of the auto-generated files from the build process in the
folder named after your component. When you create your Python package, by default any
non-Python files won’t be included in the actual package. To include these files
in the package, you must list them explicitly in
MANIFEST.in. That is,
my_dash_component/ folder. In the
- The Dash app crawls through the app’s
layout property and checks which
component packages are included in the layout; then it extracts that
layout is serialized as JSON and served to Dash’s front-end. This