done
This commit is contained in:
@ -0,0 +1,236 @@
|
||||
# AUTO GENERATED FILE - DO NOT EDIT
|
||||
|
||||
import typing # noqa: F401
|
||||
from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
|
||||
from dash.development.base_component import Component, _explicitize_args
|
||||
|
||||
ComponentType = typing.Union[
|
||||
str,
|
||||
int,
|
||||
float,
|
||||
Component,
|
||||
None,
|
||||
typing.Sequence[typing.Union[str, int, float, Component, None]],
|
||||
]
|
||||
|
||||
NumberType = typing.Union[
|
||||
typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
|
||||
]
|
||||
|
||||
|
||||
class RadioItems(Component):
|
||||
"""A RadioItems component.
|
||||
RadioItems is a component that encapsulates several radio item inputs.
|
||||
The values and labels of the RadioItems is specified in the `options`
|
||||
property and the seleced item is specified with the `value` property.
|
||||
Each radio item is rendered as an input and associated label which are
|
||||
siblings of each other.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- options (list of dicts; optional):
|
||||
The options to display as items in the component. This can be an
|
||||
array or a dictionary as follows: \n1. Array of options where the
|
||||
label and the value are the same thing - [string|number] \n2. An
|
||||
array of options ``` { \"label\": [string|number], \"value\":
|
||||
[string|number], \"disabled\": [bool] (Optional),
|
||||
\"input_id\": [string] (Optional), \"label_id\": [string]
|
||||
(Optional) } ``` \n3. Simpler `options` representation in
|
||||
dictionary format. The order is not guaranteed. All values and
|
||||
labels will be treated as strings. ``` {\"value1\": \"label1\",
|
||||
\"value2\": \"label2\", ... } ``` which is equal to ``` [
|
||||
{\"label\": \"label1\", \"value\": \"value1\"}, {\"label\":
|
||||
\"label2\", \"value\": \"value2\"}, ] ```.
|
||||
|
||||
`options` is a list of string | numbers | dict | list of dicts
|
||||
with keys:
|
||||
|
||||
- label (a list of or a singular dash component, string or number; required):
|
||||
The radio item's label.
|
||||
|
||||
- value (string | number; required):
|
||||
The value of the radio item. This value corresponds to the
|
||||
items specified in the `value` property.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, this radio item is disabled and can't be clicked on.
|
||||
|
||||
- input_id (string; optional):
|
||||
id for this option's input, can be used to attach tooltips or
|
||||
apply CSS styles.
|
||||
|
||||
- label_id (string; optional):
|
||||
id for this option's label, can be used to attach tooltips or
|
||||
apply CSS styles.
|
||||
|
||||
- value (string | number; optional):
|
||||
The currently selected value.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the RadioItems.
|
||||
|
||||
- inline (boolean; optional):
|
||||
Arrange RadioItems inline.
|
||||
|
||||
- switch (boolean; optional):
|
||||
Set to True to render toggle-like switches instead of radios.
|
||||
|
||||
- class_name (string; optional):
|
||||
The class of the container (div).
|
||||
|
||||
- input_style (dict; optional):
|
||||
The style of the <input> radio element.
|
||||
|
||||
- input_checked_style (dict; optional):
|
||||
Additional inline style arguments to apply to <input> elements on
|
||||
checked items.
|
||||
|
||||
- input_class_name (string; optional):
|
||||
The class of the <input> radio element.
|
||||
|
||||
- input_checked_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <input> element when the
|
||||
corresponding radio is checked.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Inline style arguments to apply to the <label> element for each
|
||||
item.
|
||||
|
||||
- label_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <label> element for each
|
||||
item.
|
||||
|
||||
- label_checked_style (dict; optional):
|
||||
Additional inline style arguments to apply to <label> elements on
|
||||
the selected item.
|
||||
|
||||
- label_checked_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <label> element when the
|
||||
corresponding radio is selected.
|
||||
|
||||
- name (string; optional):
|
||||
The name of the control, which is submitted with the form data.
|
||||
|
||||
- persistence (boolean | string | number; optional):
|
||||
Used to allow user interactions to be persisted when the page is
|
||||
refreshed. See https://dash.plotly.com/persistence for more
|
||||
details.
|
||||
|
||||
- persisted_props (list of a value equal to: 'value's; optional):
|
||||
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'; optional):
|
||||
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.
|
||||
|
||||
- key (string; optional):
|
||||
A unique identifier for the component, used to improve performance
|
||||
by React.js while rendering components See
|
||||
https://react.dev/learn/rendering-lists#why-does-react-need-keys
|
||||
for more info.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. The class of the
|
||||
container (div).
|
||||
|
||||
- inputClassName (string; optional):
|
||||
**DEPRECATED** Use `input_class_name` instead. The class of the
|
||||
<input> element.
|
||||
|
||||
- inputStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_style` instead. The style of the
|
||||
<input> element.
|
||||
|
||||
- inputCheckedStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_checked_style` instead. Additional
|
||||
inline style arguments to apply to <input> elements on the
|
||||
selected item.
|
||||
|
||||
- inputCheckedClassName (string; optional):
|
||||
**DEPRECATED** Use `input_checked_class_name` instead. Additional
|
||||
CSS classes to apply to the <input> element when the corresponding
|
||||
radio button is selected.
|
||||
|
||||
- labelStyle (dict; optional):
|
||||
**DEPRECATED** Use `label_style` instead. Inline style arguments
|
||||
to apply to the <label> element for each item.
|
||||
|
||||
- labelClassName (string; optional):
|
||||
**DEPRECATED** Use `label_class_name` instead. CSS classes to
|
||||
apply to the <label> element for each item.
|
||||
|
||||
- labelCheckedStyle (dict; optional):
|
||||
**DEPRECATED** Use `label_checked_style` instead. Additional
|
||||
inline style arguments to apply to <label> elements on the
|
||||
selected item.
|
||||
|
||||
- labelCheckedClassName (string; optional):
|
||||
**DEPRECATED** Use `label_checked_class_name` instead. Additional
|
||||
CSS classes to apply to the <label> element when the corresponding
|
||||
radio button is selected."""
|
||||
_children_props = ['options[].label']
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'RadioItems'
|
||||
Options = TypedDict(
|
||||
"Options",
|
||||
{
|
||||
"label": ComponentType,
|
||||
"value": typing.Union[str, NumberType],
|
||||
"disabled": NotRequired[bool],
|
||||
"input_id": NotRequired[str],
|
||||
"label_id": NotRequired[str]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
options: typing.Optional[typing.Union[typing.Sequence[typing.Union[str, NumberType]], dict, typing.Sequence["Options"]]] = None,
|
||||
value: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
inline: typing.Optional[bool] = None,
|
||||
switch: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
input_style: typing.Optional[dict] = None,
|
||||
input_checked_style: typing.Optional[dict] = None,
|
||||
input_class_name: typing.Optional[str] = None,
|
||||
input_checked_class_name: typing.Optional[str] = None,
|
||||
label_style: typing.Optional[dict] = None,
|
||||
label_class_name: typing.Optional[str] = None,
|
||||
label_checked_style: typing.Optional[dict] = None,
|
||||
label_checked_class_name: typing.Optional[str] = None,
|
||||
name: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["value"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
inputClassName: typing.Optional[str] = None,
|
||||
inputStyle: typing.Optional[dict] = None,
|
||||
inputCheckedStyle: typing.Optional[dict] = None,
|
||||
inputCheckedClassName: typing.Optional[str] = None,
|
||||
labelStyle: typing.Optional[dict] = None,
|
||||
labelClassName: typing.Optional[str] = None,
|
||||
labelCheckedStyle: typing.Optional[dict] = None,
|
||||
labelCheckedClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['options', 'value', 'id', 'inline', 'switch', 'style', 'class_name', 'input_style', 'input_checked_style', 'input_class_name', 'input_checked_class_name', 'label_style', 'label_class_name', 'label_checked_style', 'label_checked_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'inputClassName', 'inputStyle', 'inputCheckedStyle', 'inputCheckedClassName', 'labelStyle', 'labelClassName', 'labelCheckedStyle', 'labelCheckedClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['options', 'value', 'id', 'inline', 'switch', 'style', 'class_name', 'input_style', 'input_checked_style', 'input_class_name', 'input_checked_class_name', 'label_style', 'label_class_name', 'label_checked_style', 'label_checked_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'inputClassName', 'inputStyle', 'inputCheckedStyle', 'inputCheckedClassName', 'labelStyle', 'labelClassName', 'labelCheckedStyle', 'labelCheckedClassName']
|
||||
self.available_wildcard_properties = []
|
||||
_explicit_args = kwargs.pop('_explicit_args')
|
||||
_locals = locals()
|
||||
_locals.update(kwargs) # For wildcard attrs and excess named props
|
||||
args = {k: _locals[k] for k in _explicit_args}
|
||||
|
||||
super(RadioItems, self).__init__(**args)
|
||||
|
||||
setattr(RadioItems, "__init__", _explicitize_args(RadioItems.__init__))
|
||||
Reference in New Issue
Block a user