You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 3, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: dash_core_components/Checklist.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,23 @@ class Checklist(Component):
14
14
- id (string; optional): The ID of this component, used to identify dash components
15
15
in callbacks. The ID needs to be unique across all of the
16
16
components in an app.
17
-
- options (optional): An array of options. options has the following type: list of dict containing keys 'label', 'value', 'disabled'.
17
+
- options (dict; optional): An array of options. options has the following type: list of dicts containing keys 'label', 'value', 'disabled'.
18
18
Those keys have the following types:
19
19
- label (string | number; required): The checkbox's label
20
20
- value (string | number; required): The value of the checkbox. This value
21
21
corresponds to the items specified in the
22
22
`value` property.
23
-
- disabled (boolean; optional): If true, this checkbox is disabled and can't be clicked on.s
23
+
- disabled (boolean; optional): If true, this checkbox is disabled and can't be clicked on.
24
24
- value (list of string | numbers; optional): The currently selected value
25
25
- className (string; optional): The class of the container (div)
26
26
- style (dict; optional): The style of the container (div)
27
27
- inputStyle (dict; optional): The style of the <input> checkbox element
28
-
- inputClassName (string; optional): The class of the <input> checkbox element
28
+
- inputClassName (string; default ''): The class of the <input> checkbox element
29
29
- labelStyle (dict; optional): The style of the <label> that wraps the checkbox input
30
30
and the option's label
31
-
- labelClassName (string; optional): The class of the <label> that wraps the checkbox input
31
+
- labelClassName (string; default ''): The class of the <label> that wraps the checkbox input
32
32
and the option's label
33
-
- loading_state (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'.
33
+
- 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'.
34
34
Those keys have the following types:
35
35
- is_loading (boolean; optional): Determines if the component is loading or not
36
36
- prop_name (string; optional): Holds which property is loading
Copy file name to clipboardExpand all lines: dash_core_components/ConfirmDialogProvider.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,12 @@ class ConfirmDialogProvider(Component):
22
22
in callbacks. The ID needs to be unique across all of the
23
23
components in an app.
24
24
- message (string; optional): Message to show in the popup.
25
-
- submit_n_clicks (number; optional): Number of times the submit was clicked
26
-
- submit_n_clicks_timestamp (number; optional): Last time the submit button was clicked.
27
-
- cancel_n_clicks (number; optional): Number of times the popup was canceled.
28
-
- cancel_n_clicks_timestamp (number; optional): Last time the cancel button was clicked.
25
+
- submit_n_clicks (number; default 0): Number of times the submit was clicked
26
+
- submit_n_clicks_timestamp (number; default -1): Last time the submit button was clicked.
27
+
- cancel_n_clicks (number; default 0): Number of times the popup was canceled.
28
+
- cancel_n_clicks_timestamp (number; default -1): Last time the cancel button was clicked.
29
29
- displayed (boolean; optional): Is the modal currently displayed.
30
-
- loading_state (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'.
30
+
- 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'.
31
31
Those keys have the following types:
32
32
- is_loading (boolean; optional): Determines if the component is loading or not
33
33
- prop_name (string; optional): Holds which property is loading
Copy file name to clipboardExpand all lines: dash_core_components/DatePickerRange.py
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -42,24 +42,24 @@ class DatePickerRange(Component):
42
42
box of the date picker when no date is selected. Default value is 'Start Date'
43
43
- end_date_placeholder_text (string; optional): Text that will be displayed in the second input
44
44
box of the date picker when no date is selected. Default value is 'End Date'
45
-
- day_size (number; optional): Size of rendered calendar days, higher number
45
+
- day_size (number; default 39): Size of rendered calendar days, higher number
46
46
means bigger day size and larger calendar overall
47
-
- calendar_orientation (a value equal to: 'vertical', 'horizontal'; optional): Orientation of calendar, either vertical or horizontal.
47
+
- calendar_orientation (a value equal to: 'vertical', 'horizontal'; default 'horizontal'): Orientation of calendar, either vertical or horizontal.
48
48
Valid options are 'vertical' or 'horizontal'.
49
-
- is_RTL (boolean; optional): Determines whether the calendar and days operate
49
+
- is_RTL (boolean; default False): Determines whether the calendar and days operate
50
50
from left to right or from right to left
51
-
- reopen_calendar_on_clear (boolean; optional): If True, the calendar will automatically open when cleared
52
-
- number_of_months_shown (number; optional): Number of calendar months that are shown when calendar is opened
53
-
- with_portal (boolean; optional): If True, calendar will open in a screen overlay portal,
51
+
- reopen_calendar_on_clear (boolean; default False): If True, the calendar will automatically open when cleared
52
+
- number_of_months_shown (number; default 1): Number of calendar months that are shown when calendar is opened
53
+
- with_portal (boolean; default False): If True, calendar will open in a screen overlay portal,
54
54
not supported on vertical calendar
55
-
- with_full_screen_portal (boolean; optional): If True, calendar will open in a full screen overlay portal, will
55
+
- with_full_screen_portal (boolean; default False): If True, calendar will open in a full screen overlay portal, will
56
56
take precedent over 'withPortal' if both are set to true,
57
57
not supported on vertical calendar
58
-
- first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5, 6; optional): Specifies what day is the first day of the week, values must be
58
+
- first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5, 6; default 0): Specifies what day is the first day of the week, values must be
59
59
from [0, ..., 6] with 0 denoting Sunday and 6 denoting Saturday
60
60
- minimum_nights (number; optional): Specifies a minimum number of nights that must be selected between
61
61
the startDate and the endDate
62
-
- stay_open_on_select (boolean; optional): If True the calendar will not close when the user has selected a value
62
+
- stay_open_on_select (boolean; default False): If True the calendar will not close when the user has selected a value
63
63
and will wait until the user clicks off the calendar
64
64
- show_outside_days (boolean; optional): If True the calendar will display days that rollover into
65
65
the next month
@@ -74,19 +74,19 @@ class DatePickerRange(Component):
74
74
"MMMM, YY" renders as 'May, 1997' for May 10th 1997
75
75
"M, D, YYYY" renders as '07, 10, 1997' for September 10th 1997
76
76
"MMMM" renders as 'May' for May 10 1997
77
-
- disabled (boolean; optional): If True, no dates can be selected.
78
-
- clearable (boolean; optional): Whether or not the dropdown is "clearable", that is, whether or
77
+
- disabled (boolean; default False): If True, no dates can be selected.
78
+
- clearable (boolean; default False): Whether or not the dropdown is "clearable", that is, whether or
79
79
not a small "x" appears on the right of the dropdown that removes
80
80
the selected value.
81
81
- style (dict; optional): CSS styles appended to wrapper div
82
82
- className (string; optional): Appends a CSS class to the wrapper div component.
83
-
- updatemode (a value equal to: 'singledate', 'bothdates'; optional): Determines when the component should update
83
+
- updatemode (a value equal to: 'singledate', 'bothdates'; default 'singledate'): Determines when the component should update
84
84
its value. If `bothdates`, then the DatePicker
85
85
will only trigger its value when the user has
86
86
finished picking both dates. If `singledate`, then
87
87
the DatePicker will update its value
88
88
as one date is picked.
89
-
- loading_state (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'.
89
+
- 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'.
90
90
Those keys have the following types:
91
91
- is_loading (boolean; optional): Determines if the component is loading or not
92
92
- prop_name (string; optional): Holds which property is loading
Copy file name to clipboardExpand all lines: dash_core_components/DatePickerSingle.py
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -30,27 +30,27 @@ class DatePickerSingle(Component):
30
30
- initial_visible_month (string; optional): Specifies the month that is initially presented when the user
31
31
opens the calendar. Accepts datetime.datetime objects or strings
32
32
in the format 'YYYY-MM-DD'
33
-
- day_size (number; optional): Size of rendered calendar days, higher number
33
+
- day_size (number; default 39): Size of rendered calendar days, higher number
34
34
means bigger day size and larger calendar overall
35
-
- calendar_orientation (a value equal to: 'vertical', 'horizontal'; optional): Orientation of calendar, either vertical or horizontal.
35
+
- calendar_orientation (a value equal to: 'vertical', 'horizontal'; default 'horizontal'): Orientation of calendar, either vertical or horizontal.
36
36
Valid options are 'vertical' or 'horizontal'.
37
-
- is_RTL (boolean; optional): Determines whether the calendar and days operate
37
+
- is_RTL (boolean; default False): Determines whether the calendar and days operate
38
38
from left to right or from right to left
39
39
- placeholder (string; optional): Text that will be displayed in the input
40
40
box of the date picker when no date is selected.
41
41
Default value is 'Start Date'
42
-
- reopen_calendar_on_clear (boolean; optional): If True, the calendar will automatically open when cleared
43
-
- number_of_months_shown (number; optional): Number of calendar months that are shown when calendar is opened
44
-
- with_portal (boolean; optional): If True, calendar will open in a screen overlay portal,
42
+
- reopen_calendar_on_clear (boolean; default False): If True, the calendar will automatically open when cleared
43
+
- number_of_months_shown (number; default 1): Number of calendar months that are shown when calendar is opened
44
+
- with_portal (boolean; default False): If True, calendar will open in a screen overlay portal,
45
45
not supported on vertical calendar
46
-
- with_full_screen_portal (boolean; optional): If True, calendar will open in a full screen overlay portal, will
46
+
- with_full_screen_portal (boolean; default False): If True, calendar will open in a full screen overlay portal, will
47
47
take precedent over 'withPortal' if both are set to True,
48
48
not supported on vertical calendar
49
-
- first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5, 6; optional): Specifies what day is the first day of the week, values must be
49
+
- first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5, 6; default 0): Specifies what day is the first day of the week, values must be
50
50
from [0, ..., 6] with 0 denoting Sunday and 6 denoting Saturday
51
-
- stay_open_on_select (boolean; optional): If True the calendar will not close when the user has selected a value
51
+
- stay_open_on_select (boolean; default False): If True the calendar will not close when the user has selected a value
52
52
and will wait until the user clicks off the calendar
53
-
- show_outside_days (boolean; optional): If True the calendar will display days that rollover into
53
+
- show_outside_days (boolean; default True): If True the calendar will display days that rollover into
54
54
the next month
55
55
- month_format (string; optional): Specifies the format that the month will be displayed in the calendar,
56
56
valid formats are variations of "MM YY". For example:
@@ -63,13 +63,13 @@ class DatePickerSingle(Component):
63
63
"MMMM, YY" renders as 'May, 1997' for May 10th 1997
64
64
"M, D, YYYY" renders as '07, 10, 1997' for September 10th 1997
65
65
"MMMM" renders as 'May' for May 10 1997
66
-
- disabled (boolean; optional): If True, no dates can be selected.
67
-
- clearable (boolean; optional): Whether or not the dropdown is "clearable", that is, whether or
66
+
- disabled (boolean; default False): If True, no dates can be selected.
67
+
- clearable (boolean; default False): Whether or not the dropdown is "clearable", that is, whether or
68
68
not a small "x" appears on the right of the dropdown that removes
69
69
the selected value.
70
70
- style (dict; optional): CSS styles appended to wrapper div
71
71
- className (string; optional): Appends a CSS class to the wrapper div component.
72
-
- loading_state (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'.
72
+
- 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'.
73
73
Those keys have the following types:
74
74
- is_loading (boolean; optional): Determines if the component is loading or not
75
75
- prop_name (string; optional): Holds which property is loading
Copy file name to clipboardExpand all lines: dash_core_components/Dropdown.py
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -18,31 +18,31 @@ class Dropdown(Component):
18
18
- id (string; optional): The ID of this component, used to identify dash components
19
19
in callbacks. The ID needs to be unique across all of the
20
20
components in an app.
21
-
- options (optional): An array of options {label: [string|number], value: [string|number]},
22
-
an optional disabled field can be used for each option. options has the following type: list of dict containing keys 'label', 'value', 'disabled'.
21
+
- options (dict; optional): An array of options {label: [string|number], value: [string|number]},
22
+
an optional disabled field can be used for each option. options has the following type: list of dicts containing keys 'label', 'value', 'disabled'.
23
23
Those keys have the following types:
24
24
- label (string | number; required): The dropdown's label
25
25
- value (string | number; required): The value of the dropdown. This value
26
26
corresponds to the items specified in the
27
27
`value` property.
28
-
- disabled (boolean; optional): If true, this option is disabled and cannot be selected.s
28
+
- disabled (boolean; optional): If true, this option is disabled and cannot be selected.
29
29
- value (string | number | list of string | numbers; optional): The value of the input. If `multi` is false (the default)
30
30
then value is just a string that corresponds to the values
31
31
provided in the `options` property. If `multi` is true, then
32
32
multiple values can be selected at once, and `value` is an
33
33
array of items with values corresponding to those in the
34
34
`options` prop.
35
-
- optionHeight (number; optional): height of each option. Can be increased when label lengths would wrap around
35
+
- optionHeight (number; default 35): height of each option. Can be increased when label lengths would wrap around
36
36
- className (string; optional): className of the dropdown element
37
-
- clearable (boolean; optional): Whether or not the dropdown is "clearable", that is, whether or
37
+
- clearable (boolean; default True): Whether or not the dropdown is "clearable", that is, whether or
38
38
not a small "x" appears on the right of the dropdown that removes
39
39
the selected value.
40
-
- disabled (boolean; optional): If true, this dropdown is disabled and the selection cannot be changed.
41
-
- multi (boolean; optional): If true, the user can select multiple values
40
+
- disabled (boolean; default False): If true, this dropdown is disabled and the selection cannot be changed.
41
+
- multi (boolean; default False): If true, the user can select multiple values
42
42
- placeholder (string; optional): The grey, default text shown when no option is selected
43
-
- searchable (boolean; optional): Whether to enable the searching feature or not
43
+
- searchable (boolean; default True): Whether to enable the searching feature or not
44
44
- style (dict; optional): Defines CSS styles which will override styles previously set.
45
-
- loading_state (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'.
45
+
- 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'.
46
46
Those keys have the following types:
47
47
- is_loading (boolean; optional): Determines if the component is loading or not
48
48
- prop_name (string; optional): Holds which property is loading
0 commit comments