Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Commit 720c3d5

Browse files
author
Marc-André Rivet
committed
bump version to 1.0.0
1 parent 1ee491e commit 720c3d5

17 files changed

+411
-288
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

5-
## [Unreleased]
5+
## [1.0.0] - 2019-06-20
66
### Added
77
- `Markdown` components support code highlighting - no need to switch to `SyntaxHighlighter`, which has been removed. Use triple backticks, with the opening backticks followed by the language name or abbreviation. [#562](https://github.com/plotly/dash-core-components/pull/562) Supported languages:
88
- Bash

dash_core_components/Checklist.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,22 @@
66
class Checklist(Component):
77
"""A Checklist component.
88
Checklist is a component that encapsulates several checkboxes.
9-
The values and labels of the checklist is specified in the `options`
10-
property and the checked items are specified with the `values` property.
9+
The values and labels of the checklist are specified in the `options`
10+
property and the checked items are specified with the `value` property.
1111
Each checkbox is rendered as an input with a surrounding label.
1212
1313
Keyword arguments:
1414
- id (string; optional): The ID of this component, used to identify dash components
1515
in callbacks. The ID needs to be unique across all of the
1616
components in an app.
17-
- options (list; optional): An array of options
18-
- values (list; optional): The currently selected value
17+
- options (optional): An array of options. options has the following type: list of dict containing keys 'label', 'value', 'disabled'.
18+
Those keys have the following types:
19+
- label (string | number; required): The checkbox's label
20+
- value (string | number; required): The value of the checkbox. This value
21+
corresponds to the items specified in the
22+
`value` property.
23+
- disabled (boolean; optional): If true, this checkbox is disabled and can't be clicked on.s
24+
- value (list of string | numbers; optional): The currently selected value
1925
- className (string; optional): The class of the container (div)
2026
- style (dict; optional): The style of the container (div)
2127
- inputStyle (dict; optional): The style of the <input> checkbox element
@@ -30,12 +36,12 @@ class Checklist(Component):
3036
- prop_name (string; optional): Holds which property is loading
3137
- component_name (string; optional): Holds the name of the component that is loading"""
3238
@_explicitize_args
33-
def __init__(self, id=Component.UNDEFINED, options=Component.UNDEFINED, values=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, inputClassName=Component.UNDEFINED, labelStyle=Component.UNDEFINED, labelClassName=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
34-
self._prop_names = ['id', 'options', 'values', 'className', 'style', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName', 'loading_state']
39+
def __init__(self, id=Component.UNDEFINED, options=Component.UNDEFINED, value=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, inputClassName=Component.UNDEFINED, labelStyle=Component.UNDEFINED, labelClassName=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
40+
self._prop_names = ['id', 'options', 'value', 'className', 'style', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName', 'loading_state']
3541
self._type = 'Checklist'
3642
self._namespace = 'dash_core_components'
3743
self._valid_wildcard_attributes = []
38-
self.available_properties = ['id', 'options', 'values', 'className', 'style', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName', 'loading_state']
44+
self.available_properties = ['id', 'options', 'value', 'className', 'style', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName', 'loading_state']
3945
self.available_wildcard_properties = []
4046

4147
_explicit_args = kwargs.pop('_explicit_args')

dash_core_components/Dropdown.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,15 @@ class Dropdown(Component):
1818
- id (string; optional): The ID of this component, used to identify dash components
1919
in callbacks. The ID needs to be unique across all of the
2020
components in an app.
21-
- options (list; optional): An array of options {label: [string|number], value: [string|number]},
22-
an optional disabled field can be used for each option
23-
- value (string | list | number | list; optional): The value of the input. If `multi` is false (the default)
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'.
23+
Those keys have the following types:
24+
- label (string | number; required): The dropdown's label
25+
- value (string | number; required): The value of the dropdown. This value
26+
corresponds to the items specified in the
27+
`value` property.
28+
- disabled (boolean; optional): If true, this option is disabled and cannot be selected.s
29+
- value (string | number | list of string | numbers; optional): The value of the input. If `multi` is false (the default)
2430
then value is just a string that corresponds to the values
2531
provided in the `options` property. If `multi` is true, then
2632
multiple values can be selected at once, and `value` is an
@@ -31,7 +37,7 @@ class Dropdown(Component):
3137
- clearable (boolean; optional): Whether or not the dropdown is "clearable", that is, whether or
3238
not a small "x" appears on the right of the dropdown that removes
3339
the selected value.
34-
- disabled (boolean; optional): If true, the option is disabled
40+
- disabled (boolean; optional): If true, this dropdown is disabled and the selection cannot be changed.
3541
- multi (boolean; optional): If true, the user can select multiple values
3642
- placeholder (string; optional): The grey, default text shown when no option is selected
3743
- searchable (boolean; optional): Whether to enable the searching feature or not

dash_core_components/Graph.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ class Graph(Component):
4646
4747
`config` is set separately by the `config` property. figure has the following type: dict containing keys 'data', 'layout', 'frames'.
4848
Those keys have the following types:
49-
- data (list; optional)
49+
- data (list of dicts; optional)
5050
- layout (dict; optional)
51-
- frames (list; optional)
51+
- frames (list of dicts; optional)
5252
- style (dict; optional): Generic style overrides on the plot div
5353
- className (string; optional): className of the parent div
5454
- animate (boolean; optional): Beta: If true, animate between updates using

dash_core_components/Loading.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class Loading(Component):
88
A Loading component that wraps any other component and displays a spinner until the wrapped component has rendered.
99
1010
Keyword arguments:
11-
- children (list | a list of or a singular dash component, string or number; optional): Array that holds components to render
11+
- children (list of a list of or a singular dash component, string or numbers | a list of or a singular dash component, string or number; optional): Array that holds components to render
1212
- id (string; optional): The ID of this component, used to identify dash components
1313
in callbacks. The ID needs to be unique across all of the
1414
components in an app.

dash_core_components/Markdown.py

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class Markdown(Component):
7+
"""A Markdown component.
8+
A component that renders Markdown text as specified by the
9+
GitHub Markdown spec. These component uses
10+
[react-markdown](https://rexxars.github.io/react-markdown/) under the hood.
11+
12+
Keyword arguments:
13+
- children (string | list of strings; optional): A markdown string (or array of strings) that adhreres to the CommonMark spec
14+
- id (string; optional): The ID of this component, used to identify dash components
15+
in callbacks. The ID needs to be unique across all of the
16+
components in an app.
17+
- className (string; optional): Class name of the container element
18+
- dangerously_allow_html (boolean; optional): A boolean to control raw HTML escaping.
19+
Setting HTML from code is risky because it's easy to
20+
inadvertently expose your users to a cross-site scripting (XSS)
21+
(https://en.wikipedia.org/wiki/Cross-site_scripting) attack.
22+
- dedent (boolean; optional): Remove matching leading whitespace from all lines.
23+
Lines that are empty, or contain *only* whitespace, are ignored.
24+
Both spaces and tab characters are removed, but only if they match;
25+
we will not convert tabs to spaces or vice versa.
26+
- highlight_config (optional): Config options for syntax highlighting.. highlight_config has the following type: dict containing keys 'theme'.
27+
Those keys have the following types:
28+
- theme (a value equal to: 'dark', 'light'; optional): Color scheme; default 'light'
29+
- 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+
Those keys have the following types:
31+
- is_loading (boolean; optional): Determines if the component is loading or not
32+
- prop_name (string; optional): Holds which property is loading
33+
- component_name (string; optional): Holds the name of the component that is loading
34+
- style (dict; optional): User-defined inline styles for the rendered Markdown"""
35+
@_explicitize_args
36+
def __init__(self, children=None, id=Component.UNDEFINED, className=Component.UNDEFINED, dangerously_allow_html=Component.UNDEFINED, dedent=Component.UNDEFINED, highlight_config=Component.UNDEFINED, loading_state=Component.UNDEFINED, style=Component.UNDEFINED, **kwargs):
37+
self._prop_names = ['children', 'id', 'className', 'dangerously_allow_html', 'dedent', 'highlight_config', 'loading_state', 'style']
38+
self._type = 'Markdown'
39+
self._namespace = 'dash_core_components'
40+
self._valid_wildcard_attributes = []
41+
self.available_properties = ['children', 'id', 'className', 'dangerously_allow_html', 'dedent', 'highlight_config', 'loading_state', 'style']
42+
self.available_wildcard_properties = []
43+
44+
_explicit_args = kwargs.pop('_explicit_args')
45+
_locals = locals()
46+
_locals.update(kwargs) # For wildcard attrs
47+
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
48+
49+
for k in []:
50+
if k not in args:
51+
raise TypeError(
52+
'Required argument `' + k + '` was not specified.')
53+
super(Markdown, self).__init__(children=children, **args)

dash_core_components/RadioItems.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@ class RadioItems(Component):
1414
- id (string; optional): The ID of this component, used to identify dash components
1515
in callbacks. The ID needs to be unique across all of the
1616
components in an app.
17-
- options (list; optional): An array of options
18-
- value (string; optional): The currently selected value
17+
- options (optional): An array of options. options has the following type: list of dict containing keys 'label', 'value', 'disabled'.
18+
Those keys have the following types:
19+
- label (string | number; required): The radio item's label
20+
- value (string | number; required): The value of the radio item. This value
21+
corresponds to the items specified in the
22+
`value` property.
23+
- disabled (boolean; optional): If true, this radio item is disabled and can't be clicked on.s
24+
- value (string | number; optional): The currently selected value
1925
- style (dict; optional): The style of the container (div)
2026
- className (string; optional): The class of the container (div)
2127
- inputStyle (dict; optional): The style of the <input> radio element

dash_core_components/RangeSlider.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class RangeSlider(Component):
2121
Those keys have the following types:
2222
- label (string; optional)
2323
- style (dict; optional)
24-
- value (list; optional): The value of the input
24+
- value (list of numbers; optional): The value of the input
2525
- allowCross (boolean; optional): allowCross could be set as true to allow those handles to cross.
2626
- className (string; optional): Additional CSS class for the root DOM node
2727
- count (number; optional): Determine how many ranges to render, and multiple handles
@@ -38,6 +38,14 @@ class RangeSlider(Component):
3838
surrounding handles when moving an handle.
3939
When set to a number, the number will be the
4040
minimum ensured distance between handles.
41+
- tooltip (optional): . tooltip has the following type: dict containing keys 'always_visible', 'placement'.
42+
Those keys have the following types:
43+
- always_visible (boolean; optional): Determines whether tooltips should always be visible
44+
(as opposed to the default, visible on hover)
45+
- placement (a value equal to: 'left', 'right', 'top', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional): Determines the placement of tooltips
46+
See https://github.com/react-component/tooltip#api
47+
top/bottom{*} sets the _origin_ of the tooltip, so e.g. `topLeft` will
48+
in reality appear to be on the top right of the handle
4149
- step (number; optional): Value by which increments or decrements are made
4250
- vertical (boolean; optional): If true, the slider will be vertical
4351
- updatemode (a value equal to: 'mouseup', 'drag'; optional): Determines when the component should update
@@ -53,12 +61,12 @@ class RangeSlider(Component):
5361
- prop_name (string; optional): Holds which property is loading
5462
- component_name (string; optional): Holds the name of the component that is loading"""
5563
@_explicitize_args
56-
def __init__(self, id=Component.UNDEFINED, marks=Component.UNDEFINED, value=Component.UNDEFINED, allowCross=Component.UNDEFINED, className=Component.UNDEFINED, count=Component.UNDEFINED, disabled=Component.UNDEFINED, dots=Component.UNDEFINED, included=Component.UNDEFINED, min=Component.UNDEFINED, max=Component.UNDEFINED, pushable=Component.UNDEFINED, step=Component.UNDEFINED, vertical=Component.UNDEFINED, updatemode=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
57-
self._prop_names = ['id', 'marks', 'value', 'allowCross', 'className', 'count', 'disabled', 'dots', 'included', 'min', 'max', 'pushable', 'step', 'vertical', 'updatemode', 'loading_state']
64+
def __init__(self, id=Component.UNDEFINED, marks=Component.UNDEFINED, value=Component.UNDEFINED, allowCross=Component.UNDEFINED, className=Component.UNDEFINED, count=Component.UNDEFINED, disabled=Component.UNDEFINED, dots=Component.UNDEFINED, included=Component.UNDEFINED, min=Component.UNDEFINED, max=Component.UNDEFINED, pushable=Component.UNDEFINED, tooltip=Component.UNDEFINED, step=Component.UNDEFINED, vertical=Component.UNDEFINED, updatemode=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
65+
self._prop_names = ['id', 'marks', 'value', 'allowCross', 'className', 'count', 'disabled', 'dots', 'included', 'min', 'max', 'pushable', 'tooltip', 'step', 'vertical', 'updatemode', 'loading_state']
5866
self._type = 'RangeSlider'
5967
self._namespace = 'dash_core_components'
6068
self._valid_wildcard_attributes = []
61-
self.available_properties = ['id', 'marks', 'value', 'allowCross', 'className', 'count', 'disabled', 'dots', 'included', 'min', 'max', 'pushable', 'step', 'vertical', 'updatemode', 'loading_state']
69+
self.available_properties = ['id', 'marks', 'value', 'allowCross', 'className', 'count', 'disabled', 'dots', 'included', 'min', 'max', 'pushable', 'tooltip', 'step', 'vertical', 'updatemode', 'loading_state']
6270
self.available_wildcard_properties = []
6371

6472
_explicit_args = kwargs.pop('_explicit_args')

dash_core_components/Slider.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ class Slider(Component):
3030
value is included. Otherwise, it is an independent value.
3131
- min (number; optional): Minimum allowed value of the slider
3232
- max (number; optional): Maximum allowed value of the slider
33+
- tooltip (optional): . tooltip has the following type: dict containing keys 'always_visible', 'placement'.
34+
Those keys have the following types:
35+
- always_visible (boolean; optional): Determines whether tooltips should always be visible
36+
(as opposed to the default, visible on hover)
37+
- placement (a value equal to: 'left', 'right', 'top', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional): Determines the placement of tooltips
38+
See https://github.com/react-component/tooltip#api
39+
top/bottom{*} sets the _origin_ of the tooltip, so e.g. `topLeft` will
40+
in reality appear to be on the top right of the handle
3341
- step (number; optional): Value by which increments or decrements are made
3442
- vertical (boolean; optional): If true, the slider will be vertical
3543
- updatemode (a value equal to: 'mouseup', 'drag'; optional): Determines when the component should update
@@ -45,12 +53,12 @@ class Slider(Component):
4553
- prop_name (string; optional): Holds which property is loading
4654
- component_name (string; optional): Holds the name of the component that is loading"""
4755
@_explicitize_args
48-
def __init__(self, id=Component.UNDEFINED, marks=Component.UNDEFINED, value=Component.UNDEFINED, className=Component.UNDEFINED, disabled=Component.UNDEFINED, dots=Component.UNDEFINED, included=Component.UNDEFINED, min=Component.UNDEFINED, max=Component.UNDEFINED, step=Component.UNDEFINED, vertical=Component.UNDEFINED, updatemode=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
49-
self._prop_names = ['id', 'marks', 'value', 'className', 'disabled', 'dots', 'included', 'min', 'max', 'step', 'vertical', 'updatemode', 'loading_state']
56+
def __init__(self, id=Component.UNDEFINED, marks=Component.UNDEFINED, value=Component.UNDEFINED, className=Component.UNDEFINED, disabled=Component.UNDEFINED, dots=Component.UNDEFINED, included=Component.UNDEFINED, min=Component.UNDEFINED, max=Component.UNDEFINED, tooltip=Component.UNDEFINED, step=Component.UNDEFINED, vertical=Component.UNDEFINED, updatemode=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
57+
self._prop_names = ['id', 'marks', 'value', 'className', 'disabled', 'dots', 'included', 'min', 'max', 'tooltip', 'step', 'vertical', 'updatemode', 'loading_state']
5058
self._type = 'Slider'
5159
self._namespace = 'dash_core_components'
5260
self._valid_wildcard_attributes = []
53-
self.available_properties = ['id', 'marks', 'value', 'className', 'disabled', 'dots', 'included', 'min', 'max', 'step', 'vertical', 'updatemode', 'loading_state']
61+
self.available_properties = ['id', 'marks', 'value', 'className', 'disabled', 'dots', 'included', 'min', 'max', 'tooltip', 'step', 'vertical', 'updatemode', 'loading_state']
5462
self.available_wildcard_properties = []
5563

5664
_explicit_args = kwargs.pop('_explicit_args')

dash_core_components/Tabs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class Tabs(Component):
1010
children components that will be that tab's content.
1111
1212
Keyword arguments:
13-
- children (list | a list of or a singular dash component, string or number; optional): Array that holds Tab components
13+
- children (list of a list of or a singular dash component, string or numbers | a list of or a singular dash component, string or number; optional): Array that holds Tab components
1414
- id (string; optional): The ID of this component, used to identify dash components
1515
in callbacks. The ID needs to be unique across all of the
1616
components in an app.

0 commit comments

Comments
 (0)