materialdashboard 0.0.2

Dashboard with a material design

materialdashboard

materialdashboard is a Dash component library exposing Material-UI components.

Dash components are automatically generated using TypeScript definitions from the source React components.

Installation

pip install materialdashboard

Although it is not listed in the requirements for this package, you will obviously need Dash to include the components in a web app.

Documentation

Although the component properties should be documented from the extracted TypeScript comments, please refer to the Material-UI documentation for more information about each component.

Example

This is a one-file example (two if you count the CSS) setting up the app with a top bar, a drawer, and some main content. When building an actual application, you will probably want to organize the code better and split it into several files.

import dash
from dash.dependencies import Input, Output, State
import dash_html_components as html
import materialdashboard as md


DRAWER_WIDTH = "240px"


# External stylesheets contain the icons and Roboto font.
app = dash.Dash(__name__, external_stylesheets=md.external_stylesheets, suppress_callback_exceptions=True)


app.layout = html.Div(children=[
    # As the name suggests, adds a baseline style to the entire application.
    md.CssBaseline(),

    # The bar displayed at the top of Material applications.
    md.AppBar(position="fixed", className="top_bar", children=[
        md.Toolbar(children=[
            md.IconButton(id="menu", edge="start", color="inherit", style={"marginRight": "10px"}, children=[
                # Only the base Icon component is exposed. Pass the name of the icon you want to display as the child of
                # this component. Remember to pass the external stylesheets when creating your web app.
                md.Icon(children="menu"),
            ]),
            # Typography allows you to have a coherent font and size across your app. Remember to pass the external
            # stylesheets when creating your web app.
            md.Typography(variant="h6", children="Title"),
        ]),
    ]),

    # The drawer allowing navigation between the app's pages. The variant used here is `persistent`, meaning the drawer
    # can be toggled and stay visible while using the rest of the app.
    md.Drawer(id="drawer", className="drawer", classes={"paper": "drawer_paper"}, variant="persistent", anchor="left",
              open=False, children=[
        # An empty toolbar adds the top offset, such that components are not hidden behind the app bar.
        md.Toolbar(),
        md.List(children=[
            md.ListItem(button=True, children=[md.ListItemText(primary="First page")]),
            md.ListItem(button=True, children=[md.ListItemText(primary="Second page")]),
        ]),
    ]),

    # The main content of the app. It needs to be padded if the drawer is open.
    html.Main(id="main", className="main", children=[
        md.Container(maxWidth=False, children=[
            # Same as for the drawer.
            md.Toolbar(),
            # Grid is used for both the grid itself (when `container=True`) and child elements (when `item=True`).
            md.Grid(container=True, alignContent="space-around", alignItems="center", spacing=3,
                    style={"marginTop": "10px"}, children=[
                md.Grid(item=True, md=4, sm=6, children=[
                    md.Typography(children=["Welcome to my app!"])
                ]),
                md.Grid(item=True, md=4, sm=6, xs=12, alignContent="center", children=[
                    # Like for many other components, you can chose between several button variants. Check the
                    # Material-UI documentation for all possible options.
                    md.Button(id="my_button", title="Click me!", children=["Click me!"], variant="contained"),
                ]),
                md.Grid(item=True, md=4, sm=6, xs=12, children=[
                    # A multi-function text field that you can turn into a date selector for example. Unfortunately,
                    # not all browsers are yet supported.
                    md.TextField(id="my_date_field", type="date", value=""),
                ]),
            ]),
        ]),
    ]),
])


@app.callback(
    [Output("drawer", "open"), Output("main", "style")],
    [Input("menu", "n_clicks")],
    [State("drawer", "open")]
)
def drawer_button_click(n_clicks, open):
    # Toggles the drawer state.
    new_open = not open
    return (new_open, {"paddingLeft": DRAWER_WIDTH if new_open else "0"})


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

Add this CSS to the assets directory of the app:

body {
  margin: 0;
}

.top_bar {
  /* Ideally you would get and set those values using Material-UI's theme and style utilities,
     but they are not exposed... yet? */
  z-index: 1300 !important;
}

.main {
  flex-grow: 1;
  display: flex;
}

.drawer {
  width: 240px;
  flex-shrink: 0;
}

.drawer_paper {
  width: 240px;
}

Limitations

Child nodes

Child nodes are only supported for the children property of each component. If Material-UI components expect child components for properties other than children, you will not be able to pass a Dash component to them. You can however pass other types. For example, a string is a valid child node.

Events

Not all events are implemented. Currently, all components support clicks through the n_clicks property. If you need an event that's currently missing, please open an issue or a pull request.