wannadream / dash-bootstrap-components Goto Github PK

Bootstrap components for Plotly Dash
Explore the documentation · Report a bug · Request a feature

dash-bootstrap-components is a library of Bootstrap components for use with Plotly Dash, that makes it easier to build consistently styled Dash apps with complex, responsive layouts.

• Installation
• Quick start
• Contributing
• Copyright and license

You can install dash-bootstrap-components with pip:

pip install dash-bootstrap-components

You can also install dash-bootstrap-components with conda through the conda-forge channel:

conda install -c conda-forge dash-bootstrap-components

To use dash-bootstrap-components you must do two things:

• Link a Bootstrap v5 compatible stylesheet
• Incorporate dash-bootstrap-components into your layout

dash-bootstrap-components doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v5 stylesheet of your choice. This means however that in order for the components to be styled properly, you must link to a stylesheet yourself.

For convenience, links to BootstrapCDN for each theme are available through the themes module, which can be used as follows:

import dash
import dash_bootstrap_components as dbc

app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])

For more information on how to link local or external CSS, check out the Dash documentation.

With CSS linked, you can start building your app's layout with our Bootstrap components. These include layout components for organising the content of your app on the page, as well as UI components like navbars, cards, alerts and many more.

See our documentation for a full list of available components.

We welcome contributions to dash-bootstrap-components. If you find a bug or something is unclear please submit a bug report, if you have ideas for new features please feel free to make a feature request.

If you would like to submit a pull request, please read our contributing guide, which contains instructions on how to build and install dash-bootstrap-components locally, how to check your code will pass our linting checks, and how to submit the pull request itself.

Code and documentation is copyright Faculty Science Ltd. 2018-2024, and released under the Apache 2.0 license