dccDropdown

dccDropdown is a component that creates a customizable dropdown menu for selecting one or multiple items from a list of options.

Examples

Find a few usage examples below.

An example of a basic dropdown without any extra properties.

from dash import Dash, dcc, html, Input, Output,callback

app = Dash(__name__)
app.layout = html.Div([
    dcc.Dropdown(['NYC', 'MTL', 'SF'], 'NYC', id='demo-dropdown'),
    html.Div(id='dd-output-container')
])


@callback(
    Output('dd-output-container', 'children'),
    Input('demo-dropdown', 'value')
)
def update_output(value):
    return f'You have selected {value}'


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

A dropdown component with the multi property set to True
will allow the user to select more than one value
at a time.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'San Francisco'],
    ['Montreal', 'San Francisco'],
    multi=True
)

Disable Search

The searchable property is set to True by default on all
dccDropdown components. To prevent searching the dropdown
value, just set the searchable property to False.
Try searching for ‘New York’ on this dropdown below and compare
it to the other dropdowns on the page to see the difference.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'San Francisco'],
    searchable=False
)

The clearable property is set to True by default on all
dccDropdown components. To prevent the clearing of the selected dropdown
value, just set the clearable property to False

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'San Francisco'],
    'Montreal',
    clearable=False
)

Placeholder Text

The placeholder property allows you to define
default text shown when no value is selected.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'San Francisco'],
    placeholder="Select a city",
)

To disable the dropdown just set disabled to True.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'San Francisco'],
    disabled=True
)

Disable Options

To disable a particular option inside the dropdown
menu, set the disabled property in the options.

from dash import dcc

dcc.Dropdown([
        {'label': 'New York City', 'value': 'NYC', 'disabled': True},
        {'label': 'Montreal', 'value': 'MTL'},
        {'label': 'San Francisco', 'value': 'SF', 'disabled': True}])

Dynamic Options

This is an example on how to update the options on the server
depending on the search terms the user types. For example purpose
the options are empty on first load, as soon as you start typing
they will be loaded with the corresponding values.

from dash import Dash, dcc, html, dcc, Input, Output, State, callback
from dash.exceptions import PreventUpdate

options = [
    {"label": "New York City", "value": "NYC"},
    {"label": "Montreal", "value": "MTL"},
    {"label": "San Francisco", "value": "SF"},
]

app = Dash(__name__)
app.layout = html.Div([
    html.Div([
        "Single dynamic Dropdown",
        dcc.Dropdown(id="my-dynamic-dropdown")
    ]),
    html.Div([
        "Multi dynamic Dropdown",
        dcc.Dropdown(id="my-multi-dynamic-dropdown", multi=True),
    ]),
])


@callback(
    Output("my-dynamic-dropdown", "options"),
    Input("my-dynamic-dropdown", "search_value")
)
def update_options(search_value):
    if not search_value:
        raise PreventUpdate
    return [o for o in options if search_value in o["label"]]


@callback(
    Output("my-multi-dynamic-dropdown", "options"),
    Input("my-multi-dynamic-dropdown", "search_value"),
    State("my-multi-dynamic-dropdown", "value")
)
def update_multi_options(search_value, value):
    if not search_value:
        raise PreventUpdate
    # Make sure that the set values are in the option list, else they will disappear
    # from the shown select list, but still part of the `value`.
    return [
        o for o in options if search_value in o["label"] or o["value"] in (value or [])
    ]


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

Single dynamic Dropdown

Multi dynamic Dropdown

Components as Option Labels

In previous examples, we’ve set option labels as strings. You can also use Dash components as option labels.
In this example, each label is an html.Span component with an html.Img component and some text inside.

from dash import dcc, html

dcc.Dropdown(
    [
        {
            "label": html.Span(
                [
                    html.Img(src="/assets/images/language_icons/python_50px.svg", height=20),
                    html.Span("Python", style={'font-size': 15, 'padding-left': 10}),
                ], style={'align-items': 'center', 'justify-content': 'center'}
            ),
            "value": "Python",
        },
        {
            "label": html.Span(
                [
                    html.Img(src="/assets/images/language_icons/julia_50px.svg", height=20),
                    html.Span("Julia", style={'font-size': 15, 'padding-left': 10}),
                ], style={'align-items': 'center', 'justify-content': 'center'}
            ),
            "value": "Julia",
        },
        {
            "label": html.Span(
                [
                    html.Img(src="/assets/images/language_icons/r-lang_50px.svg", height=20),
                    html.Span("R", style={'font-size': 15, 'padding-left': 10}),
                ], style={'align-items': 'center', 'justify-content': 'center'}
            ),
            "value": "R",
        },
    ],
    value="Python"
)

Styling Components as Option Labels

You can also style labels by using an html.Span component for each label and then setting styles using the style property:

from dash import dcc, html

dcc.Dropdown(
    [
        {
            "label": html.Span(['Montreal'], style={'color': 'Gold', 'font-size': 20}),
            "value": "Montreal",
        },
        {
            "label": html.Span(['NYC'], style={'color': 'MediumTurqoise', 'font-size': 20}),
            "value": "NYC",
        },
        {
            "label": html.Span(['London'], style={'color': 'LightGreen', 'font-size': 20}),
            "value": "London",
        },
    ], value='Montreal'
)

Custom Search Values

When you use components as option labels, the dropdown’s search uses the option values by default.
You can add an extra string for the search by setting an option’s search property.
Here we set a search value for each option to match that option’s label text.

The value provided to search is in addition to option value. For example, option 2 is displayed when a user searches
for either ‘NYC’ or ‘New York City’.

from dash import dcc, html

dcc.Dropdown(
    [
        {
            "label": html.Span(['Montreal'], style={'color': 'Gold', 'font-size': 20}),
            "value": "MTL",
            "search": "Montreal"
        },
        {
            "label": html.Span(['New York City'], style={'color': 'MediumTurqoise', 'font-size': 20}),
            "value": "NYC",
            "search": "New York City"
        },
        {
            "label": html.Span(['London'], style={'color': 'LightGreen', 'font-size': 20}),
            "value": "LON",
            "search": "London"
        },
    ], value='Montreal',
)

The height of an expanded dropdown is 200px by default. Options that fit within this height are visible on screen,
while the remaining options can be accessed using the dropdown’s vertical scrollbar.
You can change the height with maxHeight if you want more or fewer options to be visible when the dropdown is expanded.
In this example, we set it to 300px.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'Paris', 'London', 'Amsterdam', 'Berlin', 'Rome'],
    'Paris', id='height-example-dropdown', maxHeight=300
)

Option Height

You can change the height of options in the dropdown by setting optionHeight. In this example, we set it to 50px.
The default is 35px.

from dash import dcc

dcc.Dropdown(
    ['New York City', 'Montreal', 'Paris', 'London', 'Amsterdam', 'Berlin', 'Rome'],
    'Paris', id='option-height-example-dropdown', optionHeight=50
)

options (list where each item is a named list; optional):
An array of options {label: [string|number], value: [string|number]},
an optional disabled field can be used for each option.

options is an unnamed list of characters | numerics | logicals |
named list | list where each item is a named list with keys:

disabled (logical; optional):
If TRUE, this option is disabled and cannot be selected.
label (unnamed list of or a singular dash component, character or numeric; required):
The option’s label.
search (character; optional):
Optional search value for the option, to use if the label is a
component or provide a custom search value different from the
label. If no search value and the label is a component, the
value will be used for search.
title (character; optional):
The HTML ‘title’ attribute for the option. Allows for information
on hover. For more information on this attribute, see
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title.
value (character | numeric | logical; required):
The value of the option. This value corresponds to the items
specified in the value property.

value (character | numeric | logical | unnamed list of characters | numerics | logicals; optional):
The value of the input. If multi is FALSE (the default) then value
is just a string that corresponds to the values provided in the
options property. If multi is TRUE, then multiple values can be
selected at once, and value is an array of items with values
corresponding to those in the options prop.

multi (logical; default FALSE):
If TRUE, the user can select multiple values.

clearable (logical; default TRUE):
Whether or not the dropdown is “clearable”, that is, whether or not a
small “x” appears on the right of the dropdown that removes the
selected value.

searchable (logical; default TRUE):
Whether to enable the searching feature or not.

search_value (character; optional):
The value typed in the DropDown for searching.

placeholder (character; optional):
The grey, default text shown when no option is selected.

disabled (logical; default FALSE):
If TRUE, this dropdown is disabled and the selection cannot be changed.

optionHeight (numeric; default 35):
height of each option. Can be increased when label lengths would wrap
around.

maxHeight (numeric; default 200):
height of the options dropdown.

style (named list; optional):
Defines CSS styles which will override styles previously set.

className (character; optional):
className of the dropdown element.

id (character; 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.

loading_state (named list; optional):
Object that holds the loading state object coming from dash-renderer.

loading_state is a named list with keys:

component_name (character; optional):
Holds the name of the component that is loading.
is_loading (logical; optional):
Determines if the component is loading or not.
prop_name (character; optional):
Holds which property is loading.

persistence (logical | character | numeric; 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 (unnamed list of values equal to: ‘value’; 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’ or ‘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.

dccDropdown

Examples

Basic Dropdown

Multi-Value Dropdown

Disable Search

Dropdown Clear