dcc_datepickerrange

dcc_datepickerrange is a component for rendering calendars from which users can select a range of dates.

You can use either strings in the form YYYY-MM-DD or date objects from the datetime module to provide dates to Dash components. Strings are preferred because that’s the form dates take as callback arguments. If you are using date objects, we recommend using datetime.date so there is no time part. dcc_datepickerrange accepts dates with a time part, but this can be confusing, particularly for the initial call of a callback. After the user chooses a new date, there will be no time part—only the date. If you already have aDateTime object, you can convert it with Date().

Month and Display Format

The month_format property determines how calendar headers are displayed when the calendar is opened.
The display_format property determines how selected dates are displayed in the dcc_datepickerrange component.

Both of these properties are configured through strings that use a combination of any of the following tokens.

String Token	Example	Description
`YYYY`	`2014`	4 or 2 digit year
`YY`	`14`	2 digit year
`Y`	`-25`	Year with any number of digits and sign
`Q`	`1..4`	Quarter of year. Sets month to first month in quarter.
`M MM`	`1..12`	Month number
`MMM MMMM`	J`an..December`	Month name
`D DD`	`1..31`	Day of month
`Do`	`1st..31st`	Day of month with ordinal
DDD DDDD	`1..365`	Day of year
`X`	`1410715640.579`	Unix timestamp
`x`	`1410715640579`	Unix ms timestamp

Examples

Find a few usage examples below.

Simple DatePickerRange Example

This is a simple example of a dcc_datepickerrange component tied to a callback.

The min_date_allowed and max_date_allowed properties define the minimum and maximum selectable dates on the calendar while initial_visible_month defines the calendar month that is first displayed when the dcc_datepickerrange component is opened.

using Base: start_base_include
using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        id="date-picker-range-example",
        min_date_allowed = Date(1995, 8, 5),
        max_date_allowed = Date(2017, 9, 10),
        initial_visible_month= Date(2017, 8, 5),
        end_date = Date(2017, 8, 25)
    ),
    html_div(id="output-container-date-picker-range")
end

callback!(
    app,
    Output("output-container-date-picker-range", "children"),
    Input("date-picker-range-example", "start_date"),
    Input("date-picker-range-example", "end_date"),
) do start_date, end_date
    string_prefix = "You  have selected: "
    if !isnothing(start_date)
        start_date_string = Dates.format(Date(start_date), "U d, yyyy")
        string_prefix = string_prefix * start_date_string * " | "
    end

    if !isnothing(end_date)
        end_date_string = Dates.format(Date(end_date), "U d, yyyy")
        string_prefix = string_prefix * "End Date: " * end_date_string
    end

    if length(string_prefix) == length("You have selected: ")
        return "Select a date to see it displayed here"
    else
        return string_prefix
    end

end

run_server(app, "0.0.0.0", debug=true)

Month Format Examples

You can set month_format to any permutation of the string tokens shown in Month and Display Format above to change how calendar titles are displayed in the dcc_datepickerrange component.

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        month_format = "MMM Do, YY",
        start_date_placeholder_text = "MMM Do, YY"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        month_format = "M-D-Y-Q",
        start_date_placeholder_text = "M-D-Y-Q"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        month_format = "MMMM Y, DD",
        start_date_placeholder_text = "MMMM Y, DD"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        month_format = "x",
        start_date_placeholder_text = "x"
    )
end

run_server(app, "0.0.0.0", debug=true)

Display Format Examples

You can use any permutation of the string tokens shown in Month and Display Format above to change how selected dates are displayed in the dcc_datepickerrange component.

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        display_format = "MMM Do, YY"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        display_format = "M-D-Y-Q"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        display_format = "MMMM Y, DD"
    )
end

run_server(app, "0.0.0.0", debug=true)

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        end_date = Date(2017, 6, 21),
        display_format = "x"
    )
end

run_server(app, "0.0.0.0", debug=true)

Vertical Calendar and Placeholder Text

The dcc_datepickerrange component can be rendered in two orientations, either horizontally or vertically. If calendar_orientation is set to 'vertical', it will be rendered vertically and will default to 'horizontal' if not defined.

start_date_placeholder_text and end_date_placeholder_text define the grey default text defined in the calendar input boxes when no date is selected.

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "450px")) do
    dcc_datepickerrange(
        calendar_orientation = "vertical",
        start_date_placeholder_text = "Start Period",
        end_date_placeholder_text = "End Period",
    )
end

run_server(app, "0.0.0.0", debug=true)

Minimum Nights, Calendar Clear, and Portals

The minimum_nights property defines the number of nights that must be in between the range of two selected dates.

When the clearable property is set to true, the dcc_datepickerrange renders with a small ‘x’ that the user can select to remove selected dates.

The dcc_datepickerrange component supports two different portal types, one being a full screen portal (with_full_screen_portal) and another being a simple screen overlay, like the one shown below (with_portal).

using Dash, Dates

app = dash()

app.layout = html_div() do
    dcc_datepickerrange(
        minimum_nights = 5,
        clearable = true,
        with_portal= true,
        start_date = Date(2017, 6, 21)
    )
end

run_server(app, "0.0.0.0", debug=true)

Right to Left Calendars and First Day of Week

When the is_RTL property is set to true the calendar will be rendered from right to left.

The first_day_of_week property allows you to define which day of the week will be set as the first day of the week. In the example below, Tuesday is the first day of the week.

using Dash, Dates

app = dash()

app.layout = html_div(style = Dict("height" => "350px")) do
    dcc_datepickerrange(
        is_RTL = true,
        first_day_of_week = 3,
        start_date = Date(2017, 6, 21)
    )
end

run_server(app, "0.0.0.0", debug=true)

DatePickerRange Properties

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.

start_date (String; optional):
Specifies the starting date for the component. Accepts
datetime.datetime objects or strings in the format ‘YYYY-MM-DD’.

end_date (String; optional):
Specifies the ending date for the component. Accepts datetime.datetime
objects or strings in the format ‘YYYY-MM-DD’.

min_date_allowed (String; optional):
Specifies the lowest selectable date for the component. Accepts
datetime.datetime objects or strings in the format ‘YYYY-MM-DD’.

max_date_allowed (String; optional):
Specifies the highest selectable date for the component. Accepts
datetime.datetime objects or strings in the format ‘YYYY-MM-DD’.

disabled_days (Array of Strings; optional):
Specifies additional days between min_date_allowed and
max_date_allowed that should be disabled. Accepted datetime.datetime
objects or strings in the format ‘YYYY-MM-DD’.

minimum_nights (Real; optional):
Specifies a minimum number of nights that must be selected between the
startDate and the endDate.

updatemode (a value equal to: ‘singledate’ or ‘bothdates’; default 'singledate'):
Determines when the component should update its value. If bothdates,
then the DatePicker will only trigger its value when the user has
finished picking both dates. If singledate, then the DatePicker will
update its value as one date is picked.

start_date_placeholder_text (String; optional):
Text that will be displayed in the first input box of the date picker
when no date is selected. Default value is ‘Start Date’.

end_date_placeholder_text (String; optional):
Text that will be displayed in the second input box of the date picker
when no date is selected. Default value is ‘End Date’.

initial_visible_month (String; optional):
Specifies the month that is initially presented when the user opens
the calendar. Accepts datetime.datetime objects or strings in the
format ‘YYYY-MM-DD’.

clearable (Bool; default false):
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.

reopen_calendar_on_clear (Bool; default false):
If True, the calendar will automatically open when cleared.

display_format (String; optional):
Specifies the format that the selected dates will be displayed valid
formats are variations of “MM YY DD”. For example: “MM YY DD” renders
as ‘05 10 97’ for May 10th 1997 “MMMM, YY” renders as ‘May, 1997’ for
May 10th 1997 “M, D, YYYY” renders as ‘07, 10, 1997’ for September
10th 1997 “MMMM” renders as ‘May’ for May 10 1997.

month_format (String; optional):
Specifies the format that the month will be displayed in the calendar,
valid formats are variations of “MM YY”. For example: “MM YY” renders
as ‘05 97’ for May 1997 “MMMM, YYYY” renders as ‘May, 1997’ for May
1997 “MMM, YY” renders as ‘Sep, 97’ for September 1997.

first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5 or 6; default 0):
Specifies what day is the first day of the week, values must be from
[0, …, 6] with 0 denoting Sunday and 6 denoting Saturday.

show_outside_days (Bool; optional):
If True the calendar will display days that rollover into the next
month.

stay_open_on_select (Bool; default false):
If True the calendar will not close when the user has selected a value
and will wait until the user clicks off the calendar.

calendar_orientation (a value equal to: ‘vertical’ or ‘horizontal’; default 'horizontal'):
Orientation of calendar, either vertical or horizontal. Valid options
are ‘vertical’ or ‘horizontal’.

number_of_months_shown (Real; default 1):
Number of calendar months that are shown when calendar is opened.

with_portal (Bool; default false):
If True, calendar will open in a screen overlay portal, not supported
on vertical calendar.

with_full_screen_portal (Bool; default false):
If True, calendar will open in a full screen overlay portal, will take
precedent over ‘withPortal’ if both are set to true, not supported on
vertical calendar.

day_size (Real; default 39):
Size of rendered calendar days, higher number means bigger day size
and larger calendar overall.

is_RTL (Bool; default false):
Determines whether the calendar and days operate from left to right or
from right to left.

disabled (Bool; default false):
If True, no dates can be selected.

start_date_id (String; optional):
The HTML element ID of the start date input field. Not used by Dash,
only by CSS.

end_date_id (String; optional):
The HTML element ID of the end date input field. Not used by Dash,
only by CSS.

style (Dict; optional):
CSS styles appended to wrapper div.

className (String; optional):
Appends a CSS class to the wrapper div component.

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.

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

loading_state is a Dict with keys:

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

persistence (Bool | String | Real; 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, any persisted_props that
the user has changed while using the app will keep those changes, as
long as the new prop value also matches what was given originally.
Used in conjunction with persistence_type and persisted_props.

persisted_props (Array of values equal to: ‘start_date’ or ‘end_date’; default ['start_date', 'end_date']):
Properties whose user interactions will persist after refreshing the
component or the page.

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.