dcc.Checklist

dcc.Checklist is a component for rendering a set of checkboxes.
See also RadioItems
for selecting a single option at a time or
Dropdown for
a more compact view.

import dash_core_components as dcc

dcc.Checklist(
    options=[
        {'label': 'New York City', 'value': 'NYC'},
        {'label': 'Montréal', 'value': 'MTL'},
        {'label': 'San Francisco', 'value': 'SF'}
    ],
    value=['NYC', 'MTL']
)  
import dash_core_components as dcc

dcc.Checklist(
    options=[
        {'label': 'New York City', 'value': 'NYC'},
        {'label': 'Montréal', 'value': 'MTL'},
        {'label': 'San Francisco', 'value': 'SF'}
    ],
    value=['NYC', 'MTL'],
    labelStyle={'display': 'inline-block'}
)  

dcc.Checklist Properties

Access this documentation in your Python terminal with:
```python

help(dash_core_components.Checklist)
```

Our recommended IDE for writing Dash apps is Dash Enterprise’s
Data Science Workspaces,
which has typeahead support for Dash Component Properties.
Find out if your company is using
Dash Enterprise
.

id (string; optional): The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.

className (string; optional): The class of the container (div)

inputStyle (dict; optional): The style of the <input> checkbox element

inputClassName (string; default ''): The class of the <input> checkbox element

labelStyle (dict; optional): The style of the <label> that wraps the checkbox input and the option’s label

labelClassName (string; default ''): The class of the <label> that wraps the checkbox input and the option’s label

loading_state (dict; optional): Object that holds the loading state object coming from dash-renderer. loading_state has the following type: dict containing keys ‘is_loading’, ‘prop_name’, ‘component_name’. Those keys have the following types:

  • is_loading (boolean; optional): Determines if the component is loading or not
  • prop_name (string; optional): Holds which property is loading
  • component_name (string; optional): Holds the name of the component that is loading

options (dict; optional): An array of options. options has the following type: list of dicts containing keys ‘label’, ‘value’, ‘disabled’. Those keys have the following types:

  • label (string | number; required): The checkbox’s label
  • value (string | number; required): The value of the checkbox. This value corresponds to the items specified in the value property.
  • disabled (boolean; optional): If true, this checkbox is disabled and can’t be clicked on.

persistence (boolean | string | number; optional): Used to allow user interactions in this component to be persisted when the component - or the page - is refreshed. If persisted is truthy and hasn’t changed from its previous value, a value that the user has changed while using the app will keep that change, as long as the new value also matches what was given originally. Used in conjunction with persistence_type.

persisted_props (list of a value equal to: ‘value’s; default ['value']): Properties whose user interactions will persist after refreshing the component or the page. Since only value is allowed this prop can normally be ignored.

persistence_type (a value equal to: ‘local’, ‘session’, ‘memory’; default 'local'): Where persisted user changes will be stored: memory: only kept in memory, reset on page refresh. local: window.localStorage, data is kept after the browser quit. session: window.sessionStorage, data is cleared once the browser quit.

style (dict; optional): The style of the container (div)

value (list of string | numbers; optional): The currently selected value