done
This commit is contained in:
@ -0,0 +1,113 @@
|
||||
# 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 Accordion(Component):
|
||||
"""An Accordion component.
|
||||
A self contained Accordion component. Build up the children using the
|
||||
AccordionItem component.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Accordion.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Accordion.
|
||||
|
||||
- active_item (string | list of strings; optional):
|
||||
The item_id of the currently active item. If item_id has not been
|
||||
specified for the active item, this will default to item-i, where
|
||||
i is the index (starting from 0) of the item. If
|
||||
`always_open=True`, then active_item should be a list item_ids of
|
||||
all the currently open AccordionItems.
|
||||
|
||||
- always_open (boolean; default False):
|
||||
If True, multiple items can be expanded at once.
|
||||
|
||||
- start_collapsed (boolean; default False):
|
||||
If True, all items will start collapsed.
|
||||
|
||||
- flush (boolean; optional):
|
||||
If True the Accordion will be rendered edge-to-edge within its
|
||||
parent container.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS class to apply to the Accordion.
|
||||
|
||||
- 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: 'active_item's; optional):
|
||||
Properties to persist. Since only `active_item` is supported, 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. Additional CSS class to
|
||||
apply to the Accordion."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Accordion'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
active_item: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
||||
always_open: typing.Optional[bool] = None,
|
||||
start_collapsed: typing.Optional[bool] = None,
|
||||
flush: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["active_item"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'active_item', 'always_open', 'start_collapsed', 'flush', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'active_item', 'always_open', 'start_collapsed', 'flush', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Accordion, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Accordion, "__init__", _explicitize_args(Accordion.__init__))
|
||||
@ -0,0 +1,78 @@
|
||||
# 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 AccordionItem(Component):
|
||||
"""An AccordionItem component.
|
||||
A component to build up the children of the accordion.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the AccordionItem.
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the AccordionItem.
|
||||
|
||||
- title (a list of or a singular dash component, string or number; optional):
|
||||
Text to display in the header of the AccordionItem.
|
||||
|
||||
- item_id (string; optional):
|
||||
Optional identifier for item used for determining which item is
|
||||
visible if not specified, and AccordionItem is being used inside
|
||||
Accordion component, the item_id will be set to \"item-i\" where i
|
||||
is (zero indexed) position of item in list items passed to
|
||||
Accordion component.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the AccordionItem.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the AccordionItem."""
|
||||
_children_props = ['title']
|
||||
_base_nodes = ['title', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'AccordionItem'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
title: typing.Optional[ComponentType] = None,
|
||||
item_id: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'children', 'title', 'item_id', 'style', 'class_name', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'children', 'title', 'item_id', 'style', 'class_name', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(AccordionItem, self).__init__(children=children, **args)
|
||||
|
||||
setattr(AccordionItem, "__init__", _explicitize_args(AccordionItem.__init__))
|
||||
@ -0,0 +1,118 @@
|
||||
# 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 Alert(Component):
|
||||
"""An Alert component.
|
||||
Alert allows you to create contextual feedback messages on user actions.
|
||||
|
||||
Control the visibility using callbacks with the `is_open` prop, or set it to
|
||||
auto-dismiss with the `duration` prop.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Alert.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Alert.
|
||||
|
||||
- is_open (boolean; default True):
|
||||
Whether the Alert is open (i.e. visible to the user). Default:
|
||||
True.
|
||||
|
||||
- color (string; default 'success'):
|
||||
Alert color, options: primary, secondary, success, info, warning,
|
||||
danger, link or any valid CSS color of your choice (e.g. a hex
|
||||
code, a decimal code or a CSS color name) Default: success.
|
||||
|
||||
- dismissable (boolean; optional):
|
||||
If True, add a close button that allows Alert to be dismissed.
|
||||
|
||||
- duration (number; optional):
|
||||
Duration in milliseconds after which the Alert dismisses itself.
|
||||
|
||||
- fade (boolean; optional):
|
||||
If True, a fade animation will be applied when `is_open` is
|
||||
toggled. If False the Alert will simply appear and disappear.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS class to apply to the Alert.
|
||||
|
||||
- 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: 'is_open's; optional):
|
||||
Properties to persist. Since only `is_open` is supported, 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. Additional CSS class to
|
||||
apply to the Alert."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Alert'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
dismissable: typing.Optional[bool] = None,
|
||||
duration: typing.Optional[NumberType] = None,
|
||||
fade: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["is_open"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_open', 'color', 'dismissable', 'duration', 'fade', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_open', 'color', 'dismissable', 'duration', 'fade', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Alert, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Alert, "__init__", _explicitize_args(Alert.__init__))
|
||||
@ -0,0 +1,118 @@
|
||||
# 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 Badge(Component):
|
||||
"""A Badge component.
|
||||
Badges can be used to add counts or labels to other components.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Badge.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Badge.
|
||||
|
||||
- color (string; default 'secondary'):
|
||||
Badge color, options: primary, secondary, success, info, warning,
|
||||
danger, link or any valid CSS color of your choice (e.g. a hex
|
||||
code, a decimal code or a CSS color name). Default: secondary.
|
||||
|
||||
- text_color (string; optional):
|
||||
Set the color of the text to one of the Bootstrap contextual
|
||||
colors. Options: primary, secondary, success, info, warning,
|
||||
danger, light or dark.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the Badge has been clicked.
|
||||
|
||||
- href (string; optional):
|
||||
A URL to link to when the Badge is clicked.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the Badge will behave like a hyperlink. If
|
||||
False, the Badge will behave like a dcc.Link component, and can be
|
||||
used in conjunction with dcc.Location for navigation within a Dash
|
||||
app.
|
||||
|
||||
- pill (boolean; optional):
|
||||
Make badge \"pill\" shaped (rounded ends, like a pill). Default:
|
||||
False.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Badge.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the Badge. Default: span.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to external
|
||||
links.
|
||||
|
||||
- title (string; optional):
|
||||
Sets the title attribute of the underlying HTML button.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Badge."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Badge'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
color: typing.Optional[str] = None,
|
||||
text_color: typing.Optional[str] = None,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
href: typing.Optional[str] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
pill: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
title: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'color', 'text_color', 'n_clicks', 'href', 'external_link', 'pill', 'style', 'class_name', 'tag', 'target', 'title', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'color', 'text_color', 'n_clicks', 'href', 'external_link', 'pill', 'style', 'class_name', 'tag', 'target', 'title', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Badge, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Badge, "__init__", _explicitize_args(Badge.__init__))
|
||||
@ -0,0 +1,126 @@
|
||||
# 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 Breadcrumb(Component):
|
||||
"""A Breadcrumb component.
|
||||
Use breadcrumbs to create a navigation breadcrumb in your app.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Breadcrumb.
|
||||
|
||||
- items (list of dicts; optional):
|
||||
The details of the items to render inside of this component.
|
||||
|
||||
`items` is a list of dicts with keys:
|
||||
|
||||
- label (string; optional):
|
||||
The label to display inside the breadcrumbs.
|
||||
|
||||
- href (string; optional):
|
||||
URL of the resource to link to.
|
||||
|
||||
- active (boolean; optional):
|
||||
If True, the item will be displayed as active.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the item will behave like a hyperlink. If
|
||||
False, the item will behave like a dcc.Link component, and can
|
||||
be used in conjunction with dcc.Location for navigation within
|
||||
a Dash app.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to
|
||||
external links.
|
||||
|
||||
- title (string; optional):
|
||||
Title attribute for the inner anchor element.
|
||||
|
||||
- item_style (dict; optional):
|
||||
Additional inline CSS styles to apply to each item.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Breadcrumb.
|
||||
|
||||
- item_class_name (string; optional):
|
||||
Additional CSS classes to apply to each item.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Breadcrumb.
|
||||
|
||||
- itemClassName (string; optional):
|
||||
**DEPRECATED** Use `item_class_name` instead. Additional CSS
|
||||
classes to apply to each item.
|
||||
|
||||
- tag (dict; optional):
|
||||
HTML tag to use for the outer breadcrumb component. Default:
|
||||
\"nav\"."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Breadcrumb'
|
||||
Items = TypedDict(
|
||||
"Items",
|
||||
{
|
||||
"label": NotRequired[str],
|
||||
"href": NotRequired[str],
|
||||
"active": NotRequired[bool],
|
||||
"external_link": NotRequired[bool],
|
||||
"target": NotRequired[str],
|
||||
"title": NotRequired[str]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
items: typing.Optional[typing.Sequence["Items"]] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
item_style: typing.Optional[dict] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
item_class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
itemClassName: typing.Optional[str] = None,
|
||||
tag: typing.Optional[dict] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'items', 'style', 'item_style', 'class_name', 'item_class_name', 'key', 'className', 'itemClassName', 'tag']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'items', 'style', 'item_style', 'class_name', 'item_class_name', 'key', 'className', 'itemClassName', 'tag']
|
||||
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(Breadcrumb, self).__init__(**args)
|
||||
|
||||
setattr(Breadcrumb, "__init__", _explicitize_args(Breadcrumb.__init__))
|
||||
@ -0,0 +1,156 @@
|
||||
# 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 Button(Component):
|
||||
"""A Button component.
|
||||
A component for creating Bootstrap buttons with different style options. The
|
||||
Button component can act as a HTML button, link (<a>) or can be used like a
|
||||
dash_core_components style `Link` for navigating between pages of a Dash app.
|
||||
|
||||
Use the `n_clicks` prop to trigger callbacks when the button has been
|
||||
clicked.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Button.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Button.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the Button has been clicked.
|
||||
|
||||
- color (string; optional):
|
||||
Button color, options: primary, secondary, success, info, warning,
|
||||
danger, link. Default: primary.
|
||||
|
||||
- href (string; optional):
|
||||
A URL to link to. If this property is set, the Button will behave
|
||||
like a dcc.Link for relative links, and like an html <a> tag for
|
||||
external links. This can be overridden with the `external_link`
|
||||
property.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the Button will behave like a hyperlink. If
|
||||
False, the Button will behave like a dcc.Link component, and can
|
||||
be used in conjunction with dcc.Location for navigation within a
|
||||
Dash app.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Button.
|
||||
|
||||
- active (boolean; optional):
|
||||
If True, the 'active' class is applied to the Button. Default:
|
||||
False.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, the Button will be disabled. Default: False.
|
||||
|
||||
- size (string; optional):
|
||||
The size of the Button. Options: 'sm', 'md', 'lg'.
|
||||
|
||||
- title (string; optional):
|
||||
The title of the Button.
|
||||
|
||||
- outline (boolean; optional):
|
||||
If True, the outline style is applied to the Button. Default:
|
||||
False.
|
||||
|
||||
- target (string; optional):
|
||||
The target attribute to pass on to the link. Only applies to
|
||||
external links.
|
||||
|
||||
- type (a value equal to: 'button', 'reset', 'submit'; optional):
|
||||
The default behavior of the button. Possible values are:
|
||||
\"button\", \"reset\", \"submit\". If left unspecified the default
|
||||
depends on usage: for buttons associated with a form (e.g. a
|
||||
dbc.Button inside a dbc.Form) the default is \"submit\". Otherwise
|
||||
the default is \"button\".
|
||||
|
||||
- download (string; optional):
|
||||
If the Button is a link, this attribute specifies that the target
|
||||
will be downloaded.
|
||||
|
||||
- name (string; optional):
|
||||
The name of the button, submitted as a pair with the button’s
|
||||
value as part of the form data.
|
||||
|
||||
- value (string; optional):
|
||||
Defines the value associated with the button’s name when it’s
|
||||
submitted with the form data. This value is passed to the server
|
||||
in params when the form is submitted.
|
||||
|
||||
- rel (string; optional):
|
||||
Set the rel attribute when Button is being used as a Link.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Button."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Button'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
href: typing.Optional[str] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
active: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
title: typing.Optional[str] = None,
|
||||
outline: typing.Optional[bool] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
type: typing.Optional[Literal["button", "reset", "submit"]] = None,
|
||||
download: typing.Optional[str] = None,
|
||||
name: typing.Optional[str] = None,
|
||||
value: typing.Optional[str] = None,
|
||||
rel: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'n_clicks', 'color', 'href', 'external_link', 'class_name', 'style', 'active', 'disabled', 'size', 'title', 'outline', 'target', 'type', 'download', 'name', 'value', 'rel', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'n_clicks', 'color', 'href', 'external_link', 'class_name', 'style', 'active', 'disabled', 'size', 'title', 'outline', 'target', 'type', 'download', 'name', 'value', 'rel', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Button, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Button, "__init__", _explicitize_args(Button.__init__))
|
||||
@ -0,0 +1,82 @@
|
||||
# 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 ButtonGroup(Component):
|
||||
"""A ButtonGroup component.
|
||||
A component for creating groups of buttons. Can be used with `Button` or
|
||||
`DropdownMenu`.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this ButtonGroup.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ButtonGroup.
|
||||
|
||||
- size (string; optional):
|
||||
Size of button group, options: 'sm', 'md', 'lg'.
|
||||
|
||||
- vertical (boolean; optional):
|
||||
Group buttons vertically.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ButtonGroup.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the ButtonGroup."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ButtonGroup'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
size: typing.Optional[str] = None,
|
||||
vertical: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'size', 'vertical', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'size', 'vertical', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ButtonGroup, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ButtonGroup, "__init__", _explicitize_args(ButtonGroup.__init__))
|
||||
@ -0,0 +1,95 @@
|
||||
# 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 Card(Component):
|
||||
"""A Card component.
|
||||
Component for creating Bootstrap cards. Use in conjunction with CardBody, CardImg,
|
||||
CardLink, CardHeader and CardFooter. Can also be used in conjunction with
|
||||
CardColumns, CardDeck, CardGroup for different layout options.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Card.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Card.
|
||||
|
||||
- color (string; optional):
|
||||
Card color, options: primary, secondary, success, info, warning,
|
||||
danger, light, dark or any valid CSS color of your choice (e.g. a
|
||||
hex code, a decimal code or a CSS color name). Default is light.
|
||||
|
||||
- body (boolean; optional):
|
||||
Apply the `card-body` class to the card, so that there is no need
|
||||
to also include a CardBody component in the children of this Card.
|
||||
Default: False.
|
||||
|
||||
- outline (boolean; optional):
|
||||
Apply color styling to just the border of the Card.
|
||||
|
||||
- inverse (boolean; optional):
|
||||
Invert text colours for use with a darker background.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Card.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Card."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Card'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
color: typing.Optional[str] = None,
|
||||
body: typing.Optional[bool] = None,
|
||||
outline: typing.Optional[bool] = None,
|
||||
inverse: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'color', 'body', 'outline', 'inverse', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'color', 'body', 'outline', 'inverse', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Card, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Card, "__init__", _explicitize_args(Card.__init__))
|
||||
@ -0,0 +1,77 @@
|
||||
# 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 CardBody(Component):
|
||||
"""A CardBody component.
|
||||
Wrap the content of your `Card` in `CardBody` to apply padding and other styles.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this CardBody.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardBody.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardBody.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the CardBody, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardBody."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardBody'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardBody, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardBody, "__init__", _explicitize_args(CardBody.__init__))
|
||||
@ -0,0 +1,77 @@
|
||||
# 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 CardFooter(Component):
|
||||
"""A CardFooter component.
|
||||
Use the CardFooter component to add a footer to any card.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this component.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the component.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardFooter.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the card footer, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardFooter."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardFooter'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardFooter, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardFooter, "__init__", _explicitize_args(CardFooter.__init__))
|
||||
@ -0,0 +1,78 @@
|
||||
# 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 CardGroup(Component):
|
||||
"""A CardGroup component.
|
||||
Use CardGroup to render cards as a single, attached element of columns with
|
||||
equal width and height.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this CardGroup.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardGroup.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardGroup.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the card group, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardGroup."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardGroup'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardGroup, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardGroup, "__init__", _explicitize_args(CardGroup.__init__))
|
||||
@ -0,0 +1,77 @@
|
||||
# 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 CardHeader(Component):
|
||||
"""A CardHeader component.
|
||||
Use the CardHeader component to add a header to any card.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this CardHeader.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardHeader.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardHeader.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the card header, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardHeader."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardHeader'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardHeader, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardHeader, "__init__", _explicitize_args(CardHeader.__init__))
|
||||
@ -0,0 +1,99 @@
|
||||
# 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 CardImg(Component):
|
||||
"""A CardImg component.
|
||||
Use CardImg to add images to your cards.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the CardImg.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardImg.
|
||||
|
||||
- src (string; optional):
|
||||
The URI of the embeddable content.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardImg.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the CardImg, default: img.
|
||||
|
||||
- top (boolean; optional):
|
||||
If True the card-img-top class will be applied which rounds the
|
||||
top corners of the image to match the corners of the card.
|
||||
|
||||
- bottom (boolean; optional):
|
||||
If True the card-img-bottom class will be applied which rounds the
|
||||
bottom corners of the image to match the corners of the card.
|
||||
|
||||
- alt (string; optional):
|
||||
Alternative text in case an image can't be displayed.
|
||||
|
||||
- title (string; optional):
|
||||
Text to be displayed as a tooltip when hovering.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardImg."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardImg'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
src: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
top: typing.Optional[bool] = None,
|
||||
bottom: typing.Optional[bool] = None,
|
||||
alt: typing.Optional[str] = None,
|
||||
title: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'src', 'style', 'class_name', 'tag', 'top', 'bottom', 'alt', 'title', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'src', 'style', 'class_name', 'tag', 'top', 'bottom', 'alt', 'title', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardImg, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardImg, "__init__", _explicitize_args(CardImg.__init__))
|
||||
@ -0,0 +1,78 @@
|
||||
# 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 CardImgOverlay(Component):
|
||||
"""A CardImgOverlay component.
|
||||
Use CardImgOverlay to turn an image into the background of your card and add text on
|
||||
top of it.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this CardImgOverlay.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardImgOverlay.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardImgOverlay.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the card image overlay, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardImgOverlay."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardImgOverlay'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardImgOverlay, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardImgOverlay, "__init__", _explicitize_args(CardImgOverlay.__init__))
|
||||
@ -0,0 +1,98 @@
|
||||
# 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 CardLink(Component):
|
||||
"""A CardLink component.
|
||||
Use card link to add consistently styled links to your cards. Links can be
|
||||
used like buttons, external links, or internal Dash style links.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the CardLink.
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this CardLink.
|
||||
|
||||
- href (string; optional):
|
||||
URL of the resource to link to.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the CardLink will behave like a hyperlink. If
|
||||
False, the CardLink will behave like a dcc.Link component, and can
|
||||
be used in conjunction with dcc.Location for navigation within a
|
||||
Dash app.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the CardLink has been clicked.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the CardLink.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to external
|
||||
links.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, the link is disabled and can't be clicked on.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the CardLink."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'CardLink'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
href: typing.Optional[str] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'children', 'href', 'external_link', 'n_clicks', 'style', 'class_name', 'target', 'disabled', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'children', 'href', 'external_link', 'n_clicks', 'style', 'class_name', 'target', 'disabled', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(CardLink, self).__init__(children=children, **args)
|
||||
|
||||
setattr(CardLink, "__init__", _explicitize_args(CardLink.__init__))
|
||||
@ -0,0 +1,194 @@
|
||||
# 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 Carousel(Component):
|
||||
"""A Carousel component.
|
||||
Carousel. for creating Bootstrap carousel. This component is a slideshow
|
||||
for cycling through a series of content.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Carousel.
|
||||
|
||||
- items (list of dicts; required):
|
||||
The items to display on the slides in the Carousel.
|
||||
|
||||
`items` is a list of dicts with keys:
|
||||
|
||||
- src (string; optional):
|
||||
The URL of the image.
|
||||
|
||||
- alt (string; optional):
|
||||
The alternate text for an image, if the image cannot be
|
||||
displayed.
|
||||
|
||||
- header (string; optional):
|
||||
The header of the text on the slide. It is displayed in a <h5>
|
||||
element.
|
||||
|
||||
- caption (string; optional):
|
||||
A caption for the item.
|
||||
|
||||
- img_style (dict; optional):
|
||||
Additional inline CSS styles for the image.
|
||||
|
||||
- img_class_name (string; optional):
|
||||
The className for the image. The default is 'd-block w-100'.
|
||||
|
||||
- caption_class_name (string; optional):
|
||||
The class name for the header and caption container.
|
||||
|
||||
- href (string; optional):
|
||||
Optional hyperlink to add to the item. Item will be rendered
|
||||
as a HTML <a> or as a Dash-style link depending on whether the
|
||||
link is deemed to be internal or external. Override this
|
||||
automatic detection with the external_link argument.
|
||||
|
||||
- target (string; optional):
|
||||
Optional target attribute for the link. Only applies if `href`
|
||||
is set, default `_self`.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the item will behave like a hyperlink. If
|
||||
False, the item will behave like a dcc.Link component, and can
|
||||
be used in conjunction with dcc.Location for navigation within
|
||||
a Dash app.
|
||||
|
||||
- key (string; optional):
|
||||
A unique identifier for the slide, 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.
|
||||
|
||||
- imgClassName (string; optional):
|
||||
**DEPRECATED** Use `img_class_name` instead. The className
|
||||
for the image. The default is 'd-block w-100'.
|
||||
|
||||
- captionClassName (string; optional):
|
||||
**DEPRECATED** Use `caption_class_name` instead. The class
|
||||
name for the header and caption container.
|
||||
|
||||
- active_index (number; default 0):
|
||||
The current visible slide number.
|
||||
|
||||
- interval (number; optional):
|
||||
The interval at which the Carousel automatically cycles through
|
||||
the slides. If None, the Carousel will not automatically cycle.
|
||||
|
||||
- controls (boolean; default True):
|
||||
Show the Carousel previous and next arrows for changing the
|
||||
current slide.
|
||||
|
||||
- indicators (boolean; default True):
|
||||
Show a set of slide position indicators.
|
||||
|
||||
- class_name (string; optional):
|
||||
Defines the className of the carousel container. Additional CSS
|
||||
classes to apply to the Carousel.
|
||||
|
||||
- slide (boolean; optional):
|
||||
Enables animation on the Carousel as it transitions between
|
||||
slides.
|
||||
|
||||
- variant (a value equal to: 'dark'; optional):
|
||||
Add `variant=\"dark\"` to the Carousel for darker controls,
|
||||
indicators, and captions.
|
||||
|
||||
- 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: 'active_index'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.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Defines the className of
|
||||
the carousel container. Additional CSS classes to apply to the
|
||||
Carousel."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Carousel'
|
||||
Items = TypedDict(
|
||||
"Items",
|
||||
{
|
||||
"src": NotRequired[str],
|
||||
"alt": NotRequired[str],
|
||||
"header": NotRequired[str],
|
||||
"caption": NotRequired[str],
|
||||
"img_style": NotRequired[dict],
|
||||
"img_class_name": NotRequired[str],
|
||||
"caption_class_name": NotRequired[str],
|
||||
"href": NotRequired[str],
|
||||
"target": NotRequired[str],
|
||||
"external_link": NotRequired[bool],
|
||||
"key": NotRequired[str],
|
||||
"imgClassName": NotRequired[str],
|
||||
"captionClassName": NotRequired[str]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
items: typing.Optional[typing.Sequence["Items"]] = None,
|
||||
active_index: typing.Optional[NumberType] = None,
|
||||
interval: typing.Optional[NumberType] = None,
|
||||
controls: typing.Optional[bool] = None,
|
||||
indicators: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
slide: typing.Optional[bool] = None,
|
||||
variant: typing.Optional[Literal["dark"]] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["active_index"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'items', 'active_index', 'interval', 'controls', 'indicators', 'style', 'class_name', 'slide', 'variant', 'persistence', 'persisted_props', 'persistence_type', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'items', 'active_index', 'interval', 'controls', 'indicators', 'style', 'class_name', 'slide', 'variant', 'persistence', 'persisted_props', 'persistence_type', 'className']
|
||||
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}
|
||||
|
||||
for k in ['items']:
|
||||
if k not in args:
|
||||
raise TypeError(
|
||||
'Required argument `' + k + '` was not specified.')
|
||||
|
||||
super(Carousel, self).__init__(**args)
|
||||
|
||||
setattr(Carousel, "__init__", _explicitize_args(Carousel.__init__))
|
||||
@ -0,0 +1,137 @@
|
||||
# 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 Checkbox(Component):
|
||||
"""A Checkbox component.
|
||||
Render a single checkbox.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Checkbox.
|
||||
|
||||
- value (boolean; default False):
|
||||
The value of the input.
|
||||
|
||||
- disabled (boolean; default False):
|
||||
Disable the Checkbox.
|
||||
|
||||
- label (a list of or a singular dash component, string or number; optional):
|
||||
A label to display alongside the Checkbox.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the container div.
|
||||
|
||||
- input_style (dict; optional):
|
||||
Additional inline CSS styles to apply to the <input> element.
|
||||
|
||||
- input_class_name (string; default ''):
|
||||
Additional CSS classes to apply to the <input> element.
|
||||
|
||||
- label_id (string; optional):
|
||||
The ID of the label.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Additional inline CSS styles to add to the label.
|
||||
|
||||
- label_class_name (string; default ''):
|
||||
Additional CSS classes to apply to the label.
|
||||
|
||||
- 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.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the container div.
|
||||
|
||||
- inputStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_style` instead. Additional inline CSS
|
||||
styles to apply to the <input> element.
|
||||
|
||||
- inputClassName (string; optional):
|
||||
**DEPRECATED** Use `input_class_name` instead. Additional CSS
|
||||
classes to apply to the <input> element.
|
||||
|
||||
- labelStyle (dict; optional):
|
||||
**DEPRECATED** Use `label_style` instead. Additional inline CSS
|
||||
styles to add to the label.
|
||||
|
||||
- labelClassName (string; optional):
|
||||
**DEPRECATED** Use `label_class_name` instead. Additional CSS
|
||||
classes to apply to the label."""
|
||||
_children_props = ['label']
|
||||
_base_nodes = ['label', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Checkbox'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
label: typing.Optional[ComponentType] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
input_style: typing.Optional[dict] = None,
|
||||
input_class_name: typing.Optional[str] = None,
|
||||
label_id: typing.Optional[str] = None,
|
||||
label_style: typing.Optional[dict] = None,
|
||||
label_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,
|
||||
className: typing.Optional[str] = None,
|
||||
inputStyle: typing.Optional[dict] = None,
|
||||
inputClassName: typing.Optional[str] = None,
|
||||
labelStyle: typing.Optional[dict] = None,
|
||||
labelClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
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(Checkbox, self).__init__(**args)
|
||||
|
||||
setattr(Checkbox, "__init__", _explicitize_args(Checkbox.__init__))
|
||||
@ -0,0 +1,235 @@
|
||||
# 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 Checklist(Component):
|
||||
"""A Checklist component.
|
||||
Checklist is a component that encapsulates several checkboxes.
|
||||
The values and labels of the checklist is specified in the `options`
|
||||
property and the checked items are specified with the `value` property.
|
||||
Each checkbox is rendered as an input / label pair. `Checklist` must be
|
||||
given an `id` to work properly.
|
||||
|
||||
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 checkbox's label.
|
||||
|
||||
- value (string | number; required):
|
||||
The value of the checkbox. This value corresponds to the items
|
||||
specified in the `value` property.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, this checkbox 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 (list of string | numbers; optional):
|
||||
The currently selected values.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Checklist.
|
||||
|
||||
- inline (boolean; optional):
|
||||
Arrange Checklist inline.
|
||||
|
||||
- switch (boolean; optional):
|
||||
Set to True to render toggle-like switches instead of checkboxes.
|
||||
|
||||
- class_name (string; optional):
|
||||
The class of the container (div).
|
||||
|
||||
- input_style (dict; optional):
|
||||
The style of the <input> checkbox 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> checkbox element.
|
||||
|
||||
- input_checked_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <input> element when the
|
||||
corresponding checkbox is checked.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Inline style arguments to apply to the <label> element for each
|
||||
item.
|
||||
|
||||
- label_class_name (string; optional):
|
||||
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
|
||||
checked items.
|
||||
|
||||
- label_checked_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <label> element when the
|
||||
corresponding checkbox is checked.
|
||||
|
||||
- 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> checkbox element.
|
||||
|
||||
- inputStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_style` instead. The style of the
|
||||
<input> checkbox element.
|
||||
|
||||
- inputCheckedStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_checked_style` instead. Additional
|
||||
inline style arguments to apply to <input> elements on checked
|
||||
items.
|
||||
|
||||
- inputCheckedClassName (string; optional):
|
||||
**DEPRECATED** Use `input_checked_class_name` instead. Additional
|
||||
CSS classes to apply to the <input> element when the corresponding
|
||||
checkbox is checked.
|
||||
|
||||
- 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 checked
|
||||
items.
|
||||
|
||||
- labelCheckedClassName (string; optional):
|
||||
**DEPRECATED** Use `label_checked_class_name` instead. Additional
|
||||
CSS classes to apply to the <label> element when the corresponding
|
||||
checkbox is checked."""
|
||||
_children_props = ['options[].label']
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Checklist'
|
||||
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.Sequence[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(Checklist, self).__init__(**args)
|
||||
|
||||
setattr(Checklist, "__init__", _explicitize_args(Checklist.__init__))
|
||||
@ -0,0 +1,132 @@
|
||||
# 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 Col(Component):
|
||||
"""A Col component.
|
||||
Col for creating Bootstrap columns to control the layout of your page.
|
||||
|
||||
Use the width argument to specify width, or use the breakpoint arguments
|
||||
(xs, sm, md, lg, xl) to control the width of the columns on different screen
|
||||
sizes to achieve a responsive layout.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Col.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Col.
|
||||
|
||||
- align (a value equal to: 'start', 'center', 'end', 'stretch', 'baseline'; optional):
|
||||
Set vertical alignment of this column's content in the parent row.
|
||||
Options are 'start', 'center', 'end', 'stretch', 'baseline'.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Col.
|
||||
|
||||
- width (optional):
|
||||
Specify the width of the column. Behind the scenes this sets
|
||||
behaviour at the xs breakpoint, and will be overriden if xs is
|
||||
specified. Valid arguments are boolean, an integer in the range
|
||||
1-12 inclusive, or a dictionary with keys 'offset', 'order',
|
||||
'size'. See the documentation for more details.
|
||||
|
||||
- xs (optional):
|
||||
Specify column behaviour on an extra small screen. Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive, or
|
||||
a dictionary with keys 'offset', 'order', 'size'. See the
|
||||
documentation for more details.
|
||||
|
||||
- sm (optional):
|
||||
Specify column behaviour on a small screen. Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- md (optional):
|
||||
Specify column behaviour on a medium screen. Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- lg (optional):
|
||||
Specify column behaviour on a large screen. Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- xl (optional):
|
||||
Specify column behaviour on an extra large screen. Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive, or
|
||||
a dictionary with keys 'offset', 'order', 'size'. See the
|
||||
documentation for more details.
|
||||
|
||||
- xxl (optional):
|
||||
Specify column behaviour on an extra extra large screen. Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive, or
|
||||
a dictionary with keys 'offset', 'order', 'size'. See the
|
||||
documentation for more details.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Col."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Col'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
align: typing.Optional[Literal["start", "center", "end", "stretch", "baseline"]] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
width: typing.Optional[typing.Any] = None,
|
||||
xs: typing.Optional[typing.Any] = None,
|
||||
sm: typing.Optional[typing.Any] = None,
|
||||
md: typing.Optional[typing.Any] = None,
|
||||
lg: typing.Optional[typing.Any] = None,
|
||||
xl: typing.Optional[typing.Any] = None,
|
||||
xxl: typing.Optional[typing.Any] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'align', 'style', 'class_name', 'width', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'align', 'style', 'class_name', 'width', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Col, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Col, "__init__", _explicitize_args(Col.__init__))
|
||||
@ -0,0 +1,92 @@
|
||||
# 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 Collapse(Component):
|
||||
"""A Collapse component.
|
||||
Hide or show content with a vertical collapsing animation. Visibility of the
|
||||
children is controlled by the `is_open` prop which can be targetted by
|
||||
callbacks.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Collapse.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Collapse.
|
||||
|
||||
- is_open (boolean; optional):
|
||||
Whether collapse is currently open.
|
||||
|
||||
- dimension (a value equal to: 'height', 'width'; default 'height'):
|
||||
The dimension used when collapsing e.g. height will collapse
|
||||
vertically, whilst width will collapse horizontally.
|
||||
|
||||
- navbar (boolean; optional):
|
||||
Set to True when using a collapse inside a navbar.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Collapse.
|
||||
|
||||
- tag (string; optional):
|
||||
The HTML tag used for the collapse component.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Collapse."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Collapse'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
dimension: typing.Optional[Literal["height", "width"]] = None,
|
||||
navbar: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_open', 'dimension', 'navbar', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_open', 'dimension', 'navbar', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Collapse, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Collapse, "__init__", _explicitize_args(Collapse.__init__))
|
||||
@ -0,0 +1,88 @@
|
||||
# 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 Container(Component):
|
||||
"""A Container component.
|
||||
Containers provide a means to center and horizontally pad your site’s contents.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Container.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Container.
|
||||
|
||||
- fluid (boolean | string; optional):
|
||||
If True the container-fluid class will be applied, and the
|
||||
Container will expand to fill available space. A non-fluid
|
||||
container resizes responsively to a fixed width at the different
|
||||
breakpoints. You can also set the fluid property to one of the
|
||||
Bootstrap breakpoints: \"sm\", \"md\", \"lg\", \"xl\" or \"xxl\",
|
||||
so that the container fluidly expands to fill the screen until the
|
||||
specified breakpoint, then resize responsively at higher
|
||||
breakpoints.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Container.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to apply the container class to, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Container."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Container'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
fluid: typing.Optional[typing.Union[bool, str]] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'fluid', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'fluid', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Container, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Container, "__init__", _explicitize_args(Container.__init__))
|
||||
@ -0,0 +1,141 @@
|
||||
# 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 DropdownMenu(Component):
|
||||
"""A DropdownMenu component.
|
||||
DropdownMenu creates an overlay useful for grouping together links and other
|
||||
content to organise navigation or other interactive elements.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the DropdownMenu.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the DropdownMenu.
|
||||
|
||||
- label (a list of or a singular dash component, string or number; optional):
|
||||
Label for the DropdownMenu toggle.
|
||||
|
||||
- color (string; optional):
|
||||
Set the color of the DropdownMenu toggle. Available options are:
|
||||
'primary', 'secondary', 'success', 'warning', 'danger', 'info',
|
||||
'link' or any valid CSS color of your choice (e.g. a hex code, a
|
||||
decimal code or a CSS color name). Default: 'primary'.
|
||||
|
||||
- direction (a value equal to: 'down', 'start', 'up', 'end'; optional):
|
||||
Direction in which to expand the DropdownMenu. Options are 'down',
|
||||
'start', 'up' and 'end'. Default: 'down'.
|
||||
|
||||
- size (a value equal to: 'sm', 'md', 'lg'; optional):
|
||||
Size of the DropdownMenu. 'sm' corresponds to small, 'md' to
|
||||
medium and 'lg' to large.
|
||||
|
||||
- disabled (boolean; default False):
|
||||
Disable the dropdown.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the DropdownMenu.
|
||||
|
||||
- align_end (boolean; optional):
|
||||
Align the DropdownMenu along the right side of its parent.
|
||||
Default: False.
|
||||
|
||||
- in_navbar (boolean; optional):
|
||||
Set this to True if the DropdownMenu is inside a navbar. Default:
|
||||
False.
|
||||
|
||||
- nav (boolean; optional):
|
||||
Set this to True if the DropdownMenu is inside a nav for styling
|
||||
consistent with other nav items. Default: False.
|
||||
|
||||
- caret (boolean; default True):
|
||||
Add a caret to the DropdownMenu toggle. Default: True.
|
||||
|
||||
- menu_variant (a value equal to: 'light', 'dark'; default 'light'):
|
||||
Set `menu_variant=\"dark\"` to create a dark-mode drop down
|
||||
instead.
|
||||
|
||||
- group (boolean; optional):
|
||||
Set group to True if the DropdownMenu is inside a ButtonGroup.
|
||||
|
||||
- toggle_style (dict; optional):
|
||||
Additional inline CSS styles to apply to the DropdownMenu toggle.
|
||||
|
||||
- toggle_class_name (string; optional):
|
||||
Additional CSS classes to apply to the DropdownMenu.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the DropdownMenu.
|
||||
|
||||
- toggleClassName (string; optional):
|
||||
**DEPRECATED** Use `toggle_class_name` instead. Additional CSS
|
||||
classes to apply to the DropdownMenu. The classes specified with
|
||||
this prop will be applied to the DropdownMenu toggle."""
|
||||
_children_props = ['label']
|
||||
_base_nodes = ['label', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'DropdownMenu'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
label: typing.Optional[ComponentType] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
direction: typing.Optional[Literal["down", "start", "up", "end"]] = None,
|
||||
size: typing.Optional[Literal["sm", "md", "lg"]] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
align_end: typing.Optional[bool] = None,
|
||||
in_navbar: typing.Optional[bool] = None,
|
||||
nav: typing.Optional[bool] = None,
|
||||
caret: typing.Optional[bool] = None,
|
||||
menu_variant: typing.Optional[Literal["light", "dark"]] = None,
|
||||
group: typing.Optional[bool] = None,
|
||||
toggle_style: typing.Optional[dict] = None,
|
||||
toggle_class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
toggleClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'label', 'color', 'direction', 'size', 'disabled', 'style', 'class_name', 'align_end', 'in_navbar', 'nav', 'caret', 'menu_variant', 'group', 'toggle_style', 'toggle_class_name', 'key', 'className', 'toggleClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'label', 'color', 'direction', 'size', 'disabled', 'style', 'class_name', 'align_end', 'in_navbar', 'nav', 'caret', 'menu_variant', 'group', 'toggle_style', 'toggle_class_name', 'key', 'className', 'toggleClassName']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(DropdownMenu, self).__init__(children=children, **args)
|
||||
|
||||
setattr(DropdownMenu, "__init__", _explicitize_args(DropdownMenu.__init__))
|
||||
@ -0,0 +1,115 @@
|
||||
# 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 DropdownMenuItem(Component):
|
||||
"""A DropdownMenuItem component.
|
||||
Use DropdownMenuItem to build up the content of a DropdownMenu.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this DropdownMenuItem.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the DropdownMenuItem.
|
||||
|
||||
- href (string; optional):
|
||||
A URL to link to, if the DropdownMenuItem is clicked.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the DropdownMenuItem will behave like a
|
||||
hyperlink. If False, the DropdownMenuItem will behave like a
|
||||
dcc.Link component, and can be used in conjunction with
|
||||
dcc.Location for navigation within a Dash app.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the DropdownMenuItem has been clicked.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the DropdownMenuItem.
|
||||
|
||||
- active (boolean; optional):
|
||||
Style this item as 'active'.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
Style this item as 'disabled'.
|
||||
|
||||
- divider (boolean; optional):
|
||||
Set to True if this entry is a divider. Typically, it will have no
|
||||
children.
|
||||
|
||||
- header (boolean; optional):
|
||||
Set to True if this is a header, rather than a conventional menu
|
||||
item.
|
||||
|
||||
- toggle (boolean; default True):
|
||||
Whether to toggle the DropdownMenu on click. Default: True.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to external
|
||||
links.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the DropdownMenuItem."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'DropdownMenuItem'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
href: typing.Optional[str] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
active: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
divider: typing.Optional[bool] = None,
|
||||
header: typing.Optional[bool] = None,
|
||||
toggle: typing.Optional[bool] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'href', 'external_link', 'n_clicks', 'style', 'class_name', 'active', 'disabled', 'divider', 'header', 'toggle', 'target', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'href', 'external_link', 'n_clicks', 'style', 'class_name', 'active', 'disabled', 'divider', 'header', 'toggle', 'target', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(DropdownMenuItem, self).__init__(children=children, **args)
|
||||
|
||||
setattr(DropdownMenuItem, "__init__", _explicitize_args(DropdownMenuItem.__init__))
|
||||
@ -0,0 +1,114 @@
|
||||
# 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 Fade(Component):
|
||||
"""A Fade component.
|
||||
Hide or show content with a fading animation. Visibility of the children is
|
||||
controlled by the `is_open` prop which can be targetted by callbacks.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Fade.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Fade.
|
||||
|
||||
- is_in (boolean; optional):
|
||||
Controls whether the children of the Fade component are currently
|
||||
visible or not.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Fade.
|
||||
|
||||
- timeout (dict; optional):
|
||||
The duration of the transition, in milliseconds. You may specify
|
||||
a single timeout for all transitions like: `timeout=500` or
|
||||
individually like: timeout={'enter': 300, 'exit': 500}.
|
||||
|
||||
`timeout` is a number | dict with keys:
|
||||
|
||||
- enter (number; optional)
|
||||
|
||||
- exit (number; optional)
|
||||
|
||||
- appear (boolean; optional):
|
||||
Show fade-in animation on initial page load. Default: True.
|
||||
|
||||
- enter (boolean; optional):
|
||||
Enable or disable enter transitions. Default: True.
|
||||
|
||||
- exit (boolean; optional):
|
||||
Enable or disable exit transitions. Default: True.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the fade component. Default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Fade."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Fade'
|
||||
Timeout = TypedDict(
|
||||
"Timeout",
|
||||
{
|
||||
"enter": NotRequired[NumberType],
|
||||
"exit": NotRequired[NumberType]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_in: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
timeout: typing.Optional[typing.Union[NumberType, "Timeout"]] = None,
|
||||
appear: typing.Optional[bool] = None,
|
||||
enter: typing.Optional[bool] = None,
|
||||
exit: typing.Optional[bool] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_in', 'style', 'class_name', 'timeout', 'appear', 'enter', 'exit', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_in', 'style', 'class_name', 'timeout', 'appear', 'enter', 'exit', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Fade, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Fade, "__init__", _explicitize_args(Fade.__init__))
|
||||
@ -0,0 +1,94 @@
|
||||
# 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 Form(Component):
|
||||
"""A Form component.
|
||||
The Form component can be used to organise collections of input components
|
||||
and apply consistent styling.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Form.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Form.
|
||||
|
||||
- n_submit (number; default 0):
|
||||
Number of times the form was submitted.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Form.
|
||||
|
||||
- action (string; optional):
|
||||
The URI of a program that processes the information submitted via
|
||||
the form.
|
||||
|
||||
- method (a value equal to: 'GET', 'POST'; optional):
|
||||
Defines which HTTP method to use when submitting the form. Can be
|
||||
GET (default) or POST.
|
||||
|
||||
- prevent_default_on_submit (boolean; default True):
|
||||
The form calls preventDefault on submit events. If you want form
|
||||
data be posted to the endpoint specified by `action` on submit
|
||||
events, set prevent_default_on_submit to False. Defaults to True.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Form."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Form'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
n_submit: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
action: typing.Optional[str] = None,
|
||||
method: typing.Optional[Literal["GET", "POST"]] = None,
|
||||
prevent_default_on_submit: typing.Optional[bool] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'n_submit', 'style', 'class_name', 'action', 'method', 'prevent_default_on_submit', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'n_submit', 'style', 'class_name', 'action', 'method', 'prevent_default_on_submit', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Form, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Form, "__init__", _explicitize_args(Form.__init__))
|
||||
@ -0,0 +1,83 @@
|
||||
# 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 FormFeedback(Component):
|
||||
"""A FormFeedback component.
|
||||
The FormFeedback component can be used to provide feedback on input values in a form.
|
||||
Add the form feedback to your layout and set the `valid` or `invalid` props of the
|
||||
associated input to toggle visibility.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this FormFeedback.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the FormFeedback.
|
||||
|
||||
- type (a value equal to: 'valid', 'invalid'; optional):
|
||||
Either 'valid' or 'invalid'.
|
||||
|
||||
- tooltip (boolean; optional):
|
||||
Use styled tooltips to display validation feedback.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the FormFeedback.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the FormFeedback."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'FormFeedback'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
type: typing.Optional[Literal["valid", "invalid"]] = None,
|
||||
tooltip: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'type', 'tooltip', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'type', 'tooltip', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(FormFeedback, self).__init__(children=children, **args)
|
||||
|
||||
setattr(FormFeedback, "__init__", _explicitize_args(FormFeedback.__init__))
|
||||
@ -0,0 +1,78 @@
|
||||
# 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 FormFloating(Component):
|
||||
"""A FormFloating component.
|
||||
A component for adding float labels to form controls in forms.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this FormFloating.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the FormFloating.
|
||||
|
||||
- html_for (string; optional):
|
||||
Set the `for` attribute of the label to bind it to a particular
|
||||
element.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the FormFloating.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the FormFloating."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'FormFloating'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
html_for: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'html_for', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'html_for', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(FormFloating, self).__init__(children=children, **args)
|
||||
|
||||
setattr(FormFloating, "__init__", _explicitize_args(FormFloating.__init__))
|
||||
@ -0,0 +1,80 @@
|
||||
# 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 FormText(Component):
|
||||
"""A FormText component.
|
||||
Add explanatory text below your input components.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this FormText.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the FormText.
|
||||
|
||||
- color (string; optional):
|
||||
Text color, options: primary, secondary, success, warning, danger,
|
||||
info, muted, light, dark, body, white, black-50, white-50 or any
|
||||
valid CSS color of your choice (e.g. a hex code, a decimal code or
|
||||
a CSS color name).
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the FormText.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the FormText."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'FormText'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
color: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'color', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'color', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(FormText, self).__init__(children=children, **args)
|
||||
|
||||
setattr(FormText, "__init__", _explicitize_args(FormText.__init__))
|
||||
@ -0,0 +1,315 @@
|
||||
# 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 Input(Component):
|
||||
"""An Input component.
|
||||
A basic HTML input control for entering text, numbers, or passwords, with
|
||||
Bootstrap styles automatically applied. This component is much like its
|
||||
counterpart in dash_core_components, but with a few additions such as the
|
||||
`valid` and `invalid` props for providing user feedback.
|
||||
|
||||
Note that checkbox and radio types are supported through
|
||||
the Checklist and RadioItems component. Dates, times, and file uploads
|
||||
are supported through separate components in other libraries.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Input.
|
||||
|
||||
- value (string | number; optional):
|
||||
The value of the Input.
|
||||
|
||||
- n_submit (number; default 0):
|
||||
Number of times the `Enter` key was pressed while the input had
|
||||
focus.
|
||||
|
||||
- n_blur (number; default 0):
|
||||
Number of times the input lost focus.
|
||||
|
||||
- size (string; optional):
|
||||
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
|
||||
'lg' (large). Default is 'md'.
|
||||
|
||||
- valid (boolean; optional):
|
||||
Apply valid style to the Input for feedback purposes. This will
|
||||
cause any FormFeedback in the enclosing div with valid=True to
|
||||
display.
|
||||
|
||||
- invalid (boolean; optional):
|
||||
Apply invalid style to the Input for feedback purposes. This will
|
||||
cause any FormFeedback in the enclosing div with valid=False to
|
||||
display.
|
||||
|
||||
- plaintext (boolean; optional):
|
||||
Set to True for an input styled as plain text with the default
|
||||
form field styling removed and the correct margins and padding
|
||||
preserved. Typically you will want to use this in conjunction with
|
||||
readonly=True.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Input.
|
||||
|
||||
- type (a value equal to: 'text', 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden', 'time'; optional):
|
||||
The type of control to render.
|
||||
|
||||
- step (string | number; default 'any'):
|
||||
Works with the min and max attributes to limit the increments at
|
||||
which a numeric or date-time value can be set. It can be the
|
||||
string any or a positive floating point number. If this attribute
|
||||
is not set to any, the control accepts only values at multiples of
|
||||
the step value greater than the minimum.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
Set to True to disable the Input.
|
||||
|
||||
- placeholder (string | number; optional):
|
||||
A hint to the user of what can be entered in the control. The
|
||||
placeholder text must not contain carriage returns or line-feeds.
|
||||
Note: Do not use the placeholder attribute instead of a <label>
|
||||
element, their purposes are different. The <label> attribute
|
||||
describes the role of the form element (i.e. it indicates what
|
||||
kind of information is expected), and the placeholder attribute is
|
||||
a hint about the format that the content should take. There are
|
||||
cases in which the placeholder attribute is never displayed to the
|
||||
user, so the form must be understandable without it.
|
||||
|
||||
- debounce (boolean | number; default False):
|
||||
If True, changes to the Input will be sent back to the Dash server
|
||||
only when the enter key is pressed or when the component loses
|
||||
focus. If False, the Input will trigger a callback on every
|
||||
change. If debounce is a number, the value will be sent to the
|
||||
server only after the user has stopped typing for that number of
|
||||
milliseconds.
|
||||
|
||||
- html_size (string; optional):
|
||||
The initial size of the control. This value is in pixels unless
|
||||
the value of the type attribute is text or password, in which case
|
||||
it is an integer number of characters. This attribute applies only
|
||||
when the type attribute is set to text, search, tel, url, email,
|
||||
or password, otherwise it is ignored. In addition, the size must
|
||||
be greater than zero. If you do not specify a size, a default
|
||||
value of 20 is used.
|
||||
|
||||
- autocomplete (string; optional):
|
||||
This attribute indicates whether the value of the control can be
|
||||
automatically completed by the browser.
|
||||
|
||||
- autofocus (a value equal to: 'autoFocus', 'autofocus', 'AUTOFOCUS' | boolean; optional):
|
||||
The element should be automatically focused after the page loaded.
|
||||
autoFocus is an HTML boolean attribute - it is enabled by a
|
||||
boolean or 'autoFocus'. Alternative capitalizations `autofocus` &
|
||||
`AUTOFOCUS` are also acccepted.
|
||||
|
||||
- inputmode (a value equal to: 'verbatim', 'latin', 'latin-name', 'latin-prose', 'full-width-latin', 'kana', 'katakana', 'numeric', 'tel', 'email', 'url'; optional):
|
||||
Provides a hint to the browser as to the type of data that might
|
||||
be entered by the user while editing the element or its contents.
|
||||
|
||||
- list (string; optional):
|
||||
Identifies a list of pre-defined options to suggest to the user.
|
||||
The value must be the id of a <datalist> element in the same
|
||||
document. The browser displays only options that are valid values
|
||||
for this input element. This attribute is ignored when the type
|
||||
attribute's value is hidden, checkbox, radio, file, or a button
|
||||
type.
|
||||
|
||||
- max (string | number; optional):
|
||||
The maximum (numeric or date-time) value for this item, which must
|
||||
not be less than its minimum (min attribute) value.
|
||||
|
||||
- maxlength (string | number; optional):
|
||||
If the value of the type attribute is text, email, search,
|
||||
password, tel, or url, this attribute specifies the maximum number
|
||||
of characters (in UTF-16 code units) that the user can enter. For
|
||||
other control types, it is ignored. It can exceed the value of the
|
||||
size attribute. If it is not specified, the user can enter an
|
||||
unlimited number of characters. Specifying a negative number
|
||||
results in the default behavior (i.e. the user can enter an
|
||||
unlimited number of characters). The constraint is evaluated only
|
||||
when the value of the attribute has been changed.
|
||||
|
||||
- min (string | number; optional):
|
||||
The minimum (numeric or date-time) value for this item, which must
|
||||
not be greater than its maximum (max attribute) value.
|
||||
|
||||
- minlength (string | number; optional):
|
||||
If the value of the type attribute is text, email, search,
|
||||
password, tel, or url, this attribute specifies the minimum number
|
||||
of characters (in Unicode code points) that the user can enter.
|
||||
For other control types, it is ignored.
|
||||
|
||||
- required (a value equal to: 'required', 'REQUIRED' | boolean; optional):
|
||||
This attribute specifies that the user must fill in a value before
|
||||
submitting a form. It cannot be used when the type attribute is
|
||||
hidden, image, or a button type (submit, reset, or button). The
|
||||
:optional and :required CSS pseudo-classes will be applied to the
|
||||
field as appropriate. required is an HTML boolean attribute - it
|
||||
is enabled by a boolean or 'required'. Alternative capitalizations
|
||||
`REQUIRED` are also acccepted.
|
||||
|
||||
- readonly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
|
||||
Indicates whether the element can be edited.
|
||||
|
||||
- name (string; optional):
|
||||
The name of the control, which is submitted with the form data.
|
||||
|
||||
- pattern (string; optional):
|
||||
A regular expression that the control's value is checked against.
|
||||
The pattern must match the entire value, not just some subset. Use
|
||||
the title attribute to describe the pattern to help the user. This
|
||||
attribute applies when the value of the type attribute is text,
|
||||
search, tel, url, email, or password, otherwise it is ignored. The
|
||||
regular expression language is the same as JavaScript RegExp
|
||||
algorithm, with the 'u' parameter that makes it treat the pattern
|
||||
as a sequence of unicode code points. The pattern is not
|
||||
surrounded by forward slashes.
|
||||
|
||||
- tabindex (string; optional):
|
||||
Overrides the browser's default tab order and follows the one
|
||||
specified instead.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Input.
|
||||
|
||||
- tabIndex (string; optional):
|
||||
**DEPRECATED** Use `tabindex` instead. Overrides the browser's
|
||||
default tab order and follows the one specified instead.
|
||||
|
||||
- maxLength (string | number; optional):
|
||||
**DEPRECATED** Use `maxlength` instead. If the value of the type
|
||||
attribute is text, email, search, password, tel, or url, this
|
||||
attribute specifies the maximum number of characters (in UTF-16
|
||||
code units) that the user can enter. For other control types, it
|
||||
is ignored. It can exceed the value of the size attribute. If it
|
||||
is not specified, the user can enter an unlimited number of
|
||||
characters. Specifying a negative number results in the default
|
||||
behavior (i.e. the user can enter an unlimited number of
|
||||
characters). The constraint is evaluated only when the value of
|
||||
the attribute has been changed.
|
||||
|
||||
- minLength (string | number; optional):
|
||||
**DEPRECATED** Use `minlength` instead. If the value of the type
|
||||
attribute is text, email, search, password, tel, or url, this
|
||||
attribute specifies the minimum number of characters (in Unicode
|
||||
code points) that the user can enter. For other control types, it
|
||||
is ignored.
|
||||
|
||||
- inputMode (a value equal to: 'verbatim', 'latin', 'latin-name', 'latin-prose', 'full-width-latin', 'kana', 'katakana', 'numeric', 'tel', 'email', 'url'; optional):
|
||||
**DEPRECATED** Use `inputmode` instead. Provides a hint to the
|
||||
browser as to the type of data that might be entered by the user
|
||||
while editing the element or its contents.
|
||||
|
||||
- autoComplete (string; optional):
|
||||
**DEPRECATED** Use `autocomplete` instead. This attribute
|
||||
indicates whether the value of the control can be automatically
|
||||
completed by the browser.
|
||||
|
||||
- autoFocus (a value equal to: 'autoFocus', 'autofocus', 'AUTOFOCUS' | boolean; optional):
|
||||
**DEPRECATED** Use `autofocus` instead. The element should be
|
||||
automatically focused after the page loaded. autoFocus is an HTML
|
||||
boolean attribute - it is enabled by a boolean or 'autoFocus'.
|
||||
Alternative capitalizations `autofocus` & `AUTOFOCUS` are also
|
||||
acccepted."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Input'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
n_submit: typing.Optional[NumberType] = None,
|
||||
n_blur: typing.Optional[NumberType] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
valid: typing.Optional[bool] = None,
|
||||
invalid: typing.Optional[bool] = None,
|
||||
plaintext: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
type: typing.Optional[Literal["text", "number", "password", "email", "range", "search", "tel", "url", "hidden", "time"]] = None,
|
||||
step: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
placeholder: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
debounce: typing.Optional[typing.Union[bool, NumberType]] = None,
|
||||
html_size: typing.Optional[str] = None,
|
||||
autocomplete: typing.Optional[str] = None,
|
||||
autofocus: typing.Optional[typing.Union[Literal["autoFocus", "autofocus", "AUTOFOCUS"], bool]] = None,
|
||||
inputmode: typing.Optional[Literal["verbatim", "latin", "latin-name", "latin-prose", "full-width-latin", "kana", "katakana", "numeric", "tel", "email", "url"]] = None,
|
||||
list: typing.Optional[str] = None,
|
||||
max: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
maxlength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
min: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
minlength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
required: typing.Optional[typing.Union[Literal["required", "REQUIRED"], bool]] = None,
|
||||
readonly: typing.Optional[typing.Union[bool, Literal["readOnly", "readonly", "READONLY"]]] = None,
|
||||
name: typing.Optional[str] = None,
|
||||
pattern: typing.Optional[str] = None,
|
||||
tabindex: 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,
|
||||
tabIndex: typing.Optional[str] = None,
|
||||
maxLength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
minLength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
inputMode: typing.Optional[Literal["verbatim", "latin", "latin-name", "latin-prose", "full-width-latin", "kana", "katakana", "numeric", "tel", "email", "url"]] = None,
|
||||
autoComplete: typing.Optional[str] = None,
|
||||
autoFocus: typing.Optional[typing.Union[Literal["autoFocus", "autofocus", "AUTOFOCUS"], bool]] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'value', 'n_submit', 'n_blur', 'size', 'valid', 'invalid', 'plaintext', 'style', 'class_name', 'type', 'step', 'disabled', 'placeholder', 'debounce', 'html_size', 'autocomplete', 'autofocus', 'inputmode', 'list', 'max', 'maxlength', 'min', 'minlength', 'required', 'readonly', 'name', 'pattern', 'tabindex', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'tabIndex', 'maxLength', 'minLength', 'inputMode', 'autoComplete', 'autoFocus']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'value', 'n_submit', 'n_blur', 'size', 'valid', 'invalid', 'plaintext', 'style', 'class_name', 'type', 'step', 'disabled', 'placeholder', 'debounce', 'html_size', 'autocomplete', 'autofocus', 'inputmode', 'list', 'max', 'maxlength', 'min', 'minlength', 'required', 'readonly', 'name', 'pattern', 'tabindex', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'tabIndex', 'maxLength', 'minLength', 'inputMode', 'autoComplete', 'autoFocus']
|
||||
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(Input, self).__init__(**args)
|
||||
|
||||
setattr(Input, "__init__", _explicitize_args(Input.__init__))
|
||||
@ -0,0 +1,78 @@
|
||||
# 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 InputGroup(Component):
|
||||
"""An InputGroup component.
|
||||
A component for grouping together inputs and buttons, dropdowns or text.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this InputGroup.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the InputGroup.
|
||||
|
||||
- size (string; optional):
|
||||
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
|
||||
'lg' (large). Default is 'md'.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the InputGroup.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the InputGroup."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'InputGroup'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
size: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'size', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'size', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(InputGroup, self).__init__(children=children, **args)
|
||||
|
||||
setattr(InputGroup, "__init__", _explicitize_args(InputGroup.__init__))
|
||||
@ -0,0 +1,73 @@
|
||||
# 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 InputGroupText(Component):
|
||||
"""An InputGroupText component.
|
||||
Use for wrapping text in InputGroups.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this InputGroupText.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the InputGroupText.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the InputGroupText.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the InputGroupText."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'InputGroupText'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(InputGroupText, self).__init__(children=children, **args)
|
||||
|
||||
setattr(InputGroupText, "__init__", _explicitize_args(InputGroupText.__init__))
|
||||
@ -0,0 +1,150 @@
|
||||
# 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 Label(Component):
|
||||
"""A Label component.
|
||||
A component for adding labels to inputs in forms with added sizing controls.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Label.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Label.
|
||||
|
||||
- size (string; optional):
|
||||
Set size of label. Options 'sm', 'md' (default) or 'lg'.
|
||||
|
||||
- html_for (string; optional):
|
||||
Set the `for` attribute of the label to bind it to a particular
|
||||
element.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Label.
|
||||
|
||||
- hidden (boolean; optional):
|
||||
Hide label from UI, but allow it to be discovered by
|
||||
screen-readers.
|
||||
|
||||
- check (boolean; optional):
|
||||
Set to True when using to label a Checkbox or RadioButton.
|
||||
|
||||
- width (optional):
|
||||
Specify width of label for use in grid layouts. Accepts the same
|
||||
values as the Col component.
|
||||
|
||||
- xs (optional):
|
||||
Specify label width on extra small screen Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- sm (optional):
|
||||
Specify label width on a small screen Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- md (optional):
|
||||
Specify label width on a medium screen Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- lg (optional):
|
||||
Specify label width on a large screen Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- xl (optional):
|
||||
Specify label width on an extra large screen Valid arguments are
|
||||
boolean, an integer in the range 1-12 inclusive, or a dictionary
|
||||
with keys 'offset', 'order', 'size'. See the documentation for
|
||||
more details.
|
||||
|
||||
- xxl (optional):
|
||||
Specify label width on an extra extra large screen Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive, or
|
||||
a dictionary with keys 'offset', 'order', 'size'. See the
|
||||
documentation for more details.
|
||||
|
||||
- align (a value equal to: 'start', 'center', 'end'; default 'center'):
|
||||
Set vertical alignment of the label, options: 'start', 'center',
|
||||
'end', default: 'center'.
|
||||
|
||||
- color (string; optional):
|
||||
Text color, options: primary, secondary, success, warning, danger,
|
||||
info, muted, light, dark, body, white, black-50, white-50 or any
|
||||
valid CSS color of your choice (e.g. a hex code, a decimal code or
|
||||
a CSS color name).
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Label."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Label'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
size: typing.Optional[str] = None,
|
||||
html_for: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
hidden: typing.Optional[bool] = None,
|
||||
check: typing.Optional[bool] = None,
|
||||
width: typing.Optional[typing.Any] = None,
|
||||
xs: typing.Optional[typing.Any] = None,
|
||||
sm: typing.Optional[typing.Any] = None,
|
||||
md: typing.Optional[typing.Any] = None,
|
||||
lg: typing.Optional[typing.Any] = None,
|
||||
xl: typing.Optional[typing.Any] = None,
|
||||
xxl: typing.Optional[typing.Any] = None,
|
||||
align: typing.Optional[Literal["start", "center", "end"]] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'size', 'html_for', 'style', 'class_name', 'hidden', 'check', 'width', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'align', 'color', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'size', 'html_for', 'style', 'class_name', 'hidden', 'check', 'width', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'align', 'color', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Label, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Label, "__init__", _explicitize_args(Label.__init__))
|
||||
@ -0,0 +1,98 @@
|
||||
# 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 ListGroup(Component):
|
||||
"""A ListGroup component.
|
||||
Bootstrap list groups are a flexible way to display a series of content. Use
|
||||
in conjunction with `ListGroupItem`, `ListGroupItemHeading` and
|
||||
`ListGroupItemText`.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the ListGroup.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ListGroup.
|
||||
|
||||
- numbered (boolean; default False):
|
||||
Generate numbered list items.
|
||||
|
||||
- horizontal (boolean | string; optional):
|
||||
Set to True for a horizontal ListGroup, or supply one of the
|
||||
breakpoints as a string for a ListGroup that is horizontal at that
|
||||
breakpoint and up. Note that horizontal ListGroups cannot be
|
||||
combined with flush ListGroups, so if flush is True then
|
||||
horizontal has no effect.
|
||||
|
||||
- flush (boolean; optional):
|
||||
When True the `list-group-flush` class is applied which removes
|
||||
some borders and rounded corners from the list group in order that
|
||||
they can be rendered edge-to-edge in the parent container (e.g. a
|
||||
Card).
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ListGroup.
|
||||
|
||||
- tag (string; default 'ul'):
|
||||
HTML tag to use for the list, default: ul.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the ListGroup."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ListGroup'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
numbered: typing.Optional[bool] = None,
|
||||
horizontal: typing.Optional[typing.Union[bool, str]] = None,
|
||||
flush: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'numbered', 'horizontal', 'flush', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'numbered', 'horizontal', 'flush', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ListGroup, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ListGroup, "__init__", _explicitize_args(ListGroup.__init__))
|
||||
@ -0,0 +1,116 @@
|
||||
# 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 ListGroupItem(Component):
|
||||
"""A ListGroupItem component.
|
||||
Create a single item in a `ListGroup`.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this ListGroupItem.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ListGroupItem.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the ListGroupItem has been clicked.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ListGroupItem.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the ListGroupItem, default: li.
|
||||
|
||||
- active (boolean; optional):
|
||||
Set to True to apply the \"active\" style to this item.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, the item will be disabled.
|
||||
|
||||
- color (string; optional):
|
||||
Item color, options: primary, secondary, success, info, warning,
|
||||
danger, or any valid CSS color of your choice (e.g. a hex code, a
|
||||
decimal code or a CSS color name). Default: secondary.
|
||||
|
||||
- action (boolean; optional):
|
||||
Apply list-group-item-action class for hover animation etc.
|
||||
|
||||
- href (string; optional):
|
||||
Pass a URL (relative or absolute) to make the list group item a
|
||||
link.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the ListGroupItem will behave like a
|
||||
hyperlink. If False, the ListGroupItem will behave like a dcc.Link
|
||||
component, and can be used in conjunction with dcc.Location for
|
||||
navigation within a Dash app.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to external
|
||||
links.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the ListGroupItem."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ListGroupItem'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
active: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
action: typing.Optional[bool] = None,
|
||||
href: typing.Optional[str] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'n_clicks', 'style', 'class_name', 'tag', 'active', 'disabled', 'color', 'action', 'href', 'external_link', 'target', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'n_clicks', 'style', 'class_name', 'tag', 'active', 'disabled', 'color', 'action', 'href', 'external_link', 'target', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ListGroupItem, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ListGroupItem, "__init__", _explicitize_args(ListGroupItem.__init__))
|
||||
@ -0,0 +1,198 @@
|
||||
# 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 Modal(Component):
|
||||
"""A Modal component.
|
||||
Create a toggleable dialog using the Modal component. Toggle the visibility with the
|
||||
`is_open` prop.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Modal.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Modal.
|
||||
|
||||
- is_open (boolean; optional):
|
||||
Whether modal is currently open.
|
||||
|
||||
- centered (boolean; optional):
|
||||
If True, vertically center modal on page.
|
||||
|
||||
- scrollable (boolean; optional):
|
||||
It True, scroll the modal body rather than the entire modal when
|
||||
it is too long to all fit on the screen.
|
||||
|
||||
- size (string; optional):
|
||||
Set the size of the modal. Options sm, lg, xl for small, large or
|
||||
extra large sized modals, or leave undefined for default size.
|
||||
|
||||
- backdrop (boolean | a value equal to: 'static'; optional):
|
||||
Includes a modal-backdrop element. Alternatively, specify 'static'
|
||||
for a backdrop which doesn't close the modal on click.
|
||||
|
||||
- fullscreen (boolean | a value equal to: 'sm-down', 'md-down', 'lg-down', 'xl-down', 'xxl-down'; optional):
|
||||
Renders a fullscreen modal. Specifying a breakpoint will render
|
||||
the modal as fullscreen below the breakpoint size.
|
||||
|
||||
- keyboard (boolean; optional):
|
||||
Close the modal when escape key is pressed.
|
||||
|
||||
- fade (boolean; optional):
|
||||
Set to False for a modal that simply appears rather than fades
|
||||
into view.
|
||||
|
||||
- dialog_style (dict; optional):
|
||||
Inline CSS styles to apply to the dialog.
|
||||
|
||||
- content_style (dict; optional):
|
||||
Inline CSS styles to apply to the content.
|
||||
|
||||
- backdrop_style (dict; optional):
|
||||
Inline CSS styles to apply to the backdrop.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Modal.
|
||||
|
||||
- dialog_class_name (string; optional):
|
||||
Additional CSS classes to apply to the modal.
|
||||
|
||||
- backdrop_class_name (string; optional):
|
||||
Additional CSS classes to apply to the modal-backdrop.
|
||||
|
||||
- content_class_name (string; optional):
|
||||
Additional CSS classes to apply to the modal content.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the Modal, default: div.
|
||||
|
||||
- autofocus (boolean; optional):
|
||||
Puts the focus on the modal when initialized.
|
||||
|
||||
- enforceFocus (boolean; optional):
|
||||
When True The modal will prevent focus from leaving the Modal
|
||||
while open.
|
||||
|
||||
- role (string; optional):
|
||||
The ARIA role attribute.
|
||||
|
||||
- labelledby (string; optional):
|
||||
The ARIA labelledby attribute.
|
||||
|
||||
- zindex (number | string; optional):
|
||||
Set the z-index of the modal. Default 1050.
|
||||
|
||||
- dialogStyle (dict; optional):
|
||||
**DEPRECATED** Use `dialog_style` instead. Inline CSS styles to
|
||||
apply to the dialog.
|
||||
|
||||
- contentStyle (dict; optional):
|
||||
**DEPRECATED** Use `content_style` instead. Inline CSS styles to
|
||||
apply to the content.
|
||||
|
||||
- backdropStyle (dict; optional):
|
||||
**DEPRECATED** Use `backdrop_style` instead. Inline CSS styles to
|
||||
apply to the backdrop.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the Modal.
|
||||
|
||||
- backdropClassName (string; optional):
|
||||
**DEPRECATED** Use `backdrop_class_name` instead. Additional CSS
|
||||
classes to apply to the modal-backdrop.
|
||||
|
||||
- contentClassName (string; optional):
|
||||
**DEPRECATED** Use `content_class_name` instead. Additional CSS
|
||||
classes to apply to the modal-content.
|
||||
|
||||
- dialogClassName (string; optional):
|
||||
**DEPRECATED** Use `dialog_class_name` instead. Additional CSS
|
||||
classes to apply to the modal-dialog.
|
||||
|
||||
- autoFocus (boolean; optional):
|
||||
**DEPRECATED** Use `autofocus` instead. Puts the focus on
|
||||
the modal when initialized.
|
||||
|
||||
- labelledBy (string; optional):
|
||||
**DEPRECATED** Use `labelledby` instead. The ARIA labelledby
|
||||
attribute.
|
||||
|
||||
- zIndex (number | string; optional):
|
||||
**DEPRECATED** Use `zindex` instead. Set the z-index of the
|
||||
modal. Default 1050."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Modal'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
centered: typing.Optional[bool] = None,
|
||||
scrollable: typing.Optional[bool] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
backdrop: typing.Optional[typing.Union[bool, Literal["static"]]] = None,
|
||||
fullscreen: typing.Optional[typing.Union[bool, Literal["sm-down", "md-down", "lg-down", "xl-down", "xxl-down"]]] = None,
|
||||
keyboard: typing.Optional[bool] = None,
|
||||
fade: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
dialog_style: typing.Optional[dict] = None,
|
||||
content_style: typing.Optional[dict] = None,
|
||||
backdrop_style: typing.Optional[dict] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
dialog_class_name: typing.Optional[str] = None,
|
||||
backdrop_class_name: typing.Optional[str] = None,
|
||||
content_class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
autofocus: typing.Optional[bool] = None,
|
||||
enforceFocus: typing.Optional[bool] = None,
|
||||
role: typing.Optional[str] = None,
|
||||
labelledby: typing.Optional[str] = None,
|
||||
zindex: typing.Optional[typing.Union[NumberType, str]] = None,
|
||||
dialogStyle: typing.Optional[dict] = None,
|
||||
contentStyle: typing.Optional[dict] = None,
|
||||
backdropStyle: typing.Optional[dict] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
backdropClassName: typing.Optional[str] = None,
|
||||
contentClassName: typing.Optional[str] = None,
|
||||
dialogClassName: typing.Optional[str] = None,
|
||||
autoFocus: typing.Optional[bool] = None,
|
||||
labelledBy: typing.Optional[str] = None,
|
||||
zIndex: typing.Optional[typing.Union[NumberType, str]] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_open', 'centered', 'scrollable', 'size', 'backdrop', 'fullscreen', 'keyboard', 'fade', 'style', 'dialog_style', 'content_style', 'backdrop_style', 'class_name', 'dialog_class_name', 'backdrop_class_name', 'content_class_name', 'tag', 'autofocus', 'enforceFocus', 'role', 'labelledby', 'zindex', 'dialogStyle', 'contentStyle', 'backdropStyle', 'className', 'backdropClassName', 'contentClassName', 'dialogClassName', 'autoFocus', 'labelledBy', 'zIndex']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_open', 'centered', 'scrollable', 'size', 'backdrop', 'fullscreen', 'keyboard', 'fade', 'style', 'dialog_style', 'content_style', 'backdrop_style', 'class_name', 'dialog_class_name', 'backdrop_class_name', 'content_class_name', 'tag', 'autofocus', 'enforceFocus', 'role', 'labelledby', 'zindex', 'dialogStyle', 'contentStyle', 'backdropStyle', 'className', 'backdropClassName', 'contentClassName', 'dialogClassName', 'autoFocus', 'labelledBy', 'zIndex']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Modal, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Modal, "__init__", _explicitize_args(Modal.__init__))
|
||||
@ -0,0 +1,71 @@
|
||||
# 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 ModalBody(Component):
|
||||
"""A ModalBody component.
|
||||
Use this component to add consistent padding to the body (main content) of your
|
||||
Modals.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this component.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the component.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ModalBody.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the ModalBody, default: div.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the ModalBody."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ModalBody'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ModalBody, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ModalBody, "__init__", _explicitize_args(ModalBody.__init__))
|
||||
@ -0,0 +1,70 @@
|
||||
# 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 ModalFooter(Component):
|
||||
"""A ModalFooter component.
|
||||
Add a footer to any Modal.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the ModalFooter.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ModalFooter.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ModalFooter.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the ModalFooter, default: div.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the ModalFooter."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ModalFooter'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ModalFooter, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ModalFooter, "__init__", _explicitize_args(ModalFooter.__init__))
|
||||
@ -0,0 +1,75 @@
|
||||
# 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 ModalHeader(Component):
|
||||
"""A ModalHeader component.
|
||||
Add a header to any Modal.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this ModalHeader.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ModalHeader.
|
||||
|
||||
- close_button (boolean; default True):
|
||||
Add a close button to the header that can be used to close the
|
||||
modal.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ModalHeader.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the ModalHeader, default: div.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the ModalHeader."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ModalHeader'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
close_button: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'close_button', 'style', 'class_name', 'tag', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'close_button', 'style', 'class_name', 'tag', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ModalHeader, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ModalHeader, "__init__", _explicitize_args(ModalHeader.__init__))
|
||||
@ -0,0 +1,70 @@
|
||||
# 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 ModalTitle(Component):
|
||||
"""A ModalTitle component.
|
||||
Add a title to any Modal. Should be used as a child of the ModalHeader.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this ModalTitle.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the ModalTitle.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the ModalTitle.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the ModalTitle, default: div.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the ModalTitle."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'ModalTitle'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(ModalTitle, self).__init__(children=children, **args)
|
||||
|
||||
setattr(ModalTitle, "__init__", _explicitize_args(ModalTitle.__init__))
|
||||
@ -0,0 +1,114 @@
|
||||
# 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 Nav(Component):
|
||||
"""A Nav component.
|
||||
Nav can be used to group together a collection of navigation links.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Nav.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Nav.
|
||||
|
||||
- pills (boolean; optional):
|
||||
Apply pill styling to nav items. Active items will be indicated by
|
||||
a pill.
|
||||
|
||||
- vertical (boolean | string; optional):
|
||||
Stack NavItems vertically. Set to True for a vertical Nav on all
|
||||
screen sizes, or pass one of the Bootstrap breakpoints ('xs',
|
||||
'sm', 'md', 'lg', 'xl') for a Nav which is vertical at that
|
||||
breakpoint and above, and horizontal on smaller screens.
|
||||
|
||||
- horizontal (a value equal to: 'start', 'center', 'end', 'between', 'around'; optional):
|
||||
Specify the horizontal alignment of the NavItems. Options are
|
||||
'start', 'center', or 'end'.
|
||||
|
||||
- fill (boolean; optional):
|
||||
Expand the nav items to fill available horizontal space.
|
||||
|
||||
- justified (boolean; optional):
|
||||
Expand the nav items to fill available horizontal space, making
|
||||
sure every nav item has the same width.
|
||||
|
||||
- card (boolean; optional):
|
||||
Set to True when using Nav with pills styling inside a CardHeader.
|
||||
|
||||
- navbar (boolean; optional):
|
||||
Set to True if using Nav in Navbar component. This applies the
|
||||
`navbar-nav` class to the Nav which uses more lightweight styles
|
||||
to match the parent Navbar better.
|
||||
|
||||
- navbar_scroll (boolean; optional):
|
||||
Enable vertical scrolling within the toggleable contents of a
|
||||
collapsed Navbar.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Nav.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Nav."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Nav'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
pills: typing.Optional[bool] = None,
|
||||
vertical: typing.Optional[typing.Union[bool, str]] = None,
|
||||
horizontal: typing.Optional[Literal["start", "center", "end", "between", "around"]] = None,
|
||||
fill: typing.Optional[bool] = None,
|
||||
justified: typing.Optional[bool] = None,
|
||||
card: typing.Optional[bool] = None,
|
||||
navbar: typing.Optional[bool] = None,
|
||||
navbar_scroll: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'pills', 'vertical', 'horizontal', 'fill', 'justified', 'card', 'navbar', 'navbar_scroll', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'pills', 'vertical', 'horizontal', 'fill', 'justified', 'card', 'navbar', 'navbar_scroll', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Nav, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Nav, "__init__", _explicitize_args(Nav.__init__))
|
||||
@ -0,0 +1,73 @@
|
||||
# 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 NavItem(Component):
|
||||
"""A NavItem component.
|
||||
Create a single item in a Nav.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this NavItem.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the NavItem.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the NavItem.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the NavItem."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'NavItem'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(NavItem, self).__init__(children=children, **args)
|
||||
|
||||
setattr(NavItem, "__init__", _explicitize_args(NavItem.__init__))
|
||||
@ -0,0 +1,110 @@
|
||||
# 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 NavLink(Component):
|
||||
"""A NavLink component.
|
||||
Add a link to a `Nav`. Can be used as a child of `NavItem` or of `Nav` directly.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the NavLink.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the NavLink.
|
||||
|
||||
- href (string; optional):
|
||||
The URL of the linked resource.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the NavLink has been clicked.
|
||||
|
||||
- active (boolean | a value equal to: 'partial', 'exact'; default False):
|
||||
Apply 'active' style to this component. Set to \"exact\" to
|
||||
automatically toggle active status when the current pathname
|
||||
matches href, or to \"partial\" to automatically toggle on a
|
||||
partial match. Assumes that href is a relative url such as /link
|
||||
rather than an absolute such as https://example.com/link For
|
||||
example - dbc.NavLink(..., href=\"/my-page\", active=\"exact\")
|
||||
will be active on \"/my-page\" but not \"/my-page/other\" or
|
||||
\"/random\" - dbc.NavLink(..., href=\"/my-page\",
|
||||
active=\"partial\") will be active on \"/my-page\" and
|
||||
\"/my-page/other\" but not \"/random\".
|
||||
|
||||
- disabled (boolean; default False):
|
||||
Disable the link.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the NavLink will behave like a hyperlink. If
|
||||
False, the NavLink will behave like a dcc.Link component, and can
|
||||
be used in conjunction with dcc.Location for navigation within a
|
||||
Dash app.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the NavLink.
|
||||
|
||||
- target (string; optional):
|
||||
Target attribute to pass on to the link. Only applies to external
|
||||
links.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the NavLink."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'NavLink'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
href: typing.Optional[str] = None,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
active: typing.Optional[typing.Union[bool, Literal["partial", "exact"]]] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
target: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'href', 'n_clicks', 'active', 'disabled', 'external_link', 'style', 'class_name', 'target', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'href', 'n_clicks', 'active', 'disabled', 'external_link', 'style', 'class_name', 'target', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(NavLink, self).__init__(children=children, **args)
|
||||
|
||||
setattr(NavLink, "__init__", _explicitize_args(NavLink.__init__))
|
||||
@ -0,0 +1,114 @@
|
||||
# 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 Navbar(Component):
|
||||
"""A Navbar component.
|
||||
The Navbar component can be used to make fully customisable navbars.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this component.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the component.
|
||||
|
||||
- dark (boolean; default True):
|
||||
Applies the `navbar-dark` class to the Navbar, causing text in the
|
||||
children of the Navbar to use light colors for contrast /
|
||||
visibility.
|
||||
|
||||
- fixed (string; optional):
|
||||
Fix the navbar's position at the top or bottom of the page,
|
||||
options: top, bottom.
|
||||
|
||||
- sticky (a value equal to: 'top'; optional):
|
||||
Position the navbar at the top of the viewport, but only after
|
||||
scrolling past it. A convenience prop for the sticky-top
|
||||
positioning class. Not supported in <= IE11 and other older
|
||||
browsers With `sticky`, the navbar remains in the viewport when
|
||||
you scroll. By contrast, with `fixed`, the navbar will remain at
|
||||
the top or bottom of the page. sticky='top'.
|
||||
|
||||
- color (string; default 'primary'):
|
||||
Sets the color of the Navbar. Main options are primary, light and
|
||||
dark, default primary. You can also choose one of the other
|
||||
contextual classes provided by Bootstrap (secondary, success,
|
||||
warning, danger, info, white) or any valid CSS color of your
|
||||
choice (e.g. a hex code, a decimal code or a CSS color name).
|
||||
|
||||
- expand (boolean | string; default 'md'):
|
||||
Specify screen size at which to expand the menu bar, e.g. sm, md,
|
||||
lg etc.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Navbar.
|
||||
|
||||
- role (string; optional):
|
||||
The ARIA role attribute.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the Navbar, default 'nav'.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Navbar."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Navbar'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
dark: typing.Optional[bool] = None,
|
||||
fixed: typing.Optional[str] = None,
|
||||
sticky: typing.Optional[Literal["top"]] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
expand: typing.Optional[typing.Union[bool, str]] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
role: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'dark', 'fixed', 'sticky', 'color', 'expand', 'style', 'class_name', 'role', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'dark', 'fixed', 'sticky', 'color', 'expand', 'style', 'class_name', 'role', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Navbar, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Navbar, "__init__", _explicitize_args(Navbar.__init__))
|
||||
@ -0,0 +1,84 @@
|
||||
# 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 NavbarBrand(Component):
|
||||
"""A NavbarBrand component.
|
||||
Call out attention to a brand name or site title within a Navbar.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this NavbarBrand.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the NavbarBrand.
|
||||
|
||||
- external_link (boolean; optional):
|
||||
If True, clicking on the NavbarBrand will behave like a hyperlink.
|
||||
If False, the NavbarBrand will behave like a dcc.Link component,
|
||||
and can be used in conjunction with dcc.Location for navigation
|
||||
within a Dash app.
|
||||
|
||||
- href (string; optional):
|
||||
URL of the linked resource.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the NavbarBrand.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the NavbarBrand."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'NavbarBrand'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
external_link: typing.Optional[bool] = None,
|
||||
href: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'external_link', 'href', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'external_link', 'href', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(NavbarBrand, self).__init__(children=children, **args)
|
||||
|
||||
setattr(NavbarBrand, "__init__", _explicitize_args(NavbarBrand.__init__))
|
||||
@ -0,0 +1,137 @@
|
||||
# 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 NavbarSimple(Component):
|
||||
"""A NavbarSimple component.
|
||||
A self-contained navbar ready for use. If you need more customisability try
|
||||
`Navbar` instead.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this NavbarSimple.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the NavbarSimple.
|
||||
|
||||
- color (string; default 'primary'):
|
||||
Sets the color of the NavbarSimple. Main options are primary,
|
||||
light and dark, default light. You can also choose one of the
|
||||
other contextual classes provided by Bootstrap (secondary,
|
||||
success, warning, danger, info, white) or any valid CSS color of
|
||||
your choice (e.g. a hex code, a decimal code or a CSS color name).
|
||||
|
||||
- dark (boolean; default True):
|
||||
Applies the `navbar-dark` class to the NavbarSimple, causing text
|
||||
in the children of the Navbar to use light colors for contrast /
|
||||
visibility.
|
||||
|
||||
- fluid (boolean; default False):
|
||||
The contents of the Navbar are wrapped in a container, use
|
||||
fluid=True to make this container fluid, so that in particular,
|
||||
the contents of the navbar fill the available horizontal space.
|
||||
|
||||
- links_left (boolean; default False):
|
||||
Align the navlinks in the navbar to the left. Default: False.
|
||||
|
||||
- brand (a list of or a singular dash component, string or number; optional):
|
||||
Brand (text or dash components) that will be rendered on the top
|
||||
left of the Navbar.
|
||||
|
||||
- brand_href (string; optional):
|
||||
A URL to link to when the brand is clicked.
|
||||
|
||||
- brand_external_link (boolean; optional):
|
||||
If True, clicking on the brand link will behave like a hyperlink.
|
||||
If False, the brand link will behave like a dcc.Link component,
|
||||
and can be used in conjunction with dcc.Location for navigation
|
||||
within a Dash app.
|
||||
|
||||
- fixed (string; optional):
|
||||
Fix the navbar's position at the top or bottom of the page,
|
||||
options: top, bottom.
|
||||
|
||||
- sticky (string; optional):
|
||||
Stick the navbar to the top or the bottom of the viewport,
|
||||
options: top, bottom With `sticky`, the navbar remains in the
|
||||
viewport when you scroll. By contrast, with `fixed`, the navbar
|
||||
will remain at the top or bottom of the page.
|
||||
|
||||
- expand (boolean | string; default 'md'):
|
||||
Specify breakpoint at which to expand the menu bar. Options are:
|
||||
'xs', 'sm', 'md', 'lg', or 'xl'. Below this breakpoint the navbar
|
||||
will collapse and navitems will be placed in a togglable collapse
|
||||
element.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the NavbarSimple.
|
||||
|
||||
- brand_style (dict; optional):
|
||||
CSS style options for brand.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the NavbarSimple."""
|
||||
_children_props = ['brand']
|
||||
_base_nodes = ['brand', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'NavbarSimple'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
color: typing.Optional[str] = None,
|
||||
dark: typing.Optional[bool] = None,
|
||||
fluid: typing.Optional[bool] = None,
|
||||
links_left: typing.Optional[bool] = None,
|
||||
brand: typing.Optional[ComponentType] = None,
|
||||
brand_href: typing.Optional[str] = None,
|
||||
brand_external_link: typing.Optional[bool] = None,
|
||||
fixed: typing.Optional[str] = None,
|
||||
sticky: typing.Optional[str] = None,
|
||||
expand: typing.Optional[typing.Union[bool, str]] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
brand_style: typing.Optional[dict] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'color', 'dark', 'fluid', 'links_left', 'brand', 'brand_href', 'brand_external_link', 'fixed', 'sticky', 'expand', 'style', 'class_name', 'brand_style', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'color', 'dark', 'fluid', 'links_left', 'brand', 'brand_href', 'brand_external_link', 'fixed', 'sticky', 'expand', 'style', 'class_name', 'brand_style', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(NavbarSimple, self).__init__(children=children, **args)
|
||||
|
||||
setattr(NavbarSimple, "__init__", _explicitize_args(NavbarSimple.__init__))
|
||||
@ -0,0 +1,82 @@
|
||||
# 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 NavbarToggler(Component):
|
||||
"""A NavbarToggler component.
|
||||
Use this component to create a navbar toggle to show navlinks when the Navbar
|
||||
collapses on smaller screens.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this component.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the component.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the NavbarToggler has been clicked.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the NavbarToggler.
|
||||
|
||||
- type (string; optional):
|
||||
Toggle type, default: button.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the NavbarToggler."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'NavbarToggler'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
type: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'n_clicks', 'style', 'class_name', 'type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'n_clicks', 'style', 'class_name', 'type', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(NavbarToggler, self).__init__(children=children, **args)
|
||||
|
||||
setattr(NavbarToggler, "__init__", _explicitize_args(NavbarToggler.__init__))
|
||||
@ -0,0 +1,124 @@
|
||||
# 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 Offcanvas(Component):
|
||||
"""An Offcanvas component.
|
||||
Create a toggleable hidden sidebar using the Offcanvas component.
|
||||
Toggle the visibility with the `is_open` prop.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Offcanvas.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Offcanvas.
|
||||
|
||||
- is_open (boolean; default False):
|
||||
Whether offcanvas is currently open.
|
||||
|
||||
- title (a list of or a singular dash component, string or number; optional):
|
||||
The header title.
|
||||
|
||||
- placement (a value equal to: 'start', 'end', 'top', 'bottom'; optional):
|
||||
Which side of the viewport the offcanvas will appear from.
|
||||
|
||||
- backdrop (boolean | a value equal to: 'static'; default True):
|
||||
Includes an offcanvas-backdrop element. Alternatively, specify
|
||||
'static' for a backdrop which doesn't close the modal on click.
|
||||
|
||||
- close_button (boolean; default True):
|
||||
Specify whether the Offcanvas should contain a close button in the
|
||||
header.
|
||||
|
||||
- keyboard (boolean; optional):
|
||||
If True, the offcanvas will close when the escape key is pressed.
|
||||
|
||||
- scrollable (boolean; optional):
|
||||
Allow body scrolling while offcanvas is open.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Offcanvas.
|
||||
|
||||
- backdrop_class_name (string; optional):
|
||||
CSS class to apply to the backdrop.
|
||||
|
||||
- autofocus (boolean; optional):
|
||||
Puts the focus on the offcanvas when initialized.
|
||||
|
||||
- labelledby (string; optional):
|
||||
The ARIA labelledby attribute.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the Offcanvas.
|
||||
|
||||
- backdropClassName (string; optional):
|
||||
**DEPRECATED** Use `backdrop_class_name` instead. CSS class to
|
||||
apply to the backdrop.
|
||||
|
||||
- autoFocus (boolean; optional):
|
||||
**DEPRECATED** Use `autofocus` instead. Puts the focus on
|
||||
the modal when initialized.
|
||||
|
||||
- labelledBy (string; optional):
|
||||
**DEPRECATED** Use `labelledby` instead. The ARIA labelledby
|
||||
attribute."""
|
||||
_children_props = ['title']
|
||||
_base_nodes = ['title', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Offcanvas'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
title: typing.Optional[ComponentType] = None,
|
||||
placement: typing.Optional[Literal["start", "end", "top", "bottom"]] = None,
|
||||
backdrop: typing.Optional[typing.Union[bool, Literal["static"]]] = None,
|
||||
close_button: typing.Optional[bool] = None,
|
||||
keyboard: typing.Optional[bool] = None,
|
||||
scrollable: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
backdrop_class_name: typing.Optional[str] = None,
|
||||
autofocus: typing.Optional[bool] = None,
|
||||
labelledby: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
backdropClassName: typing.Optional[str] = None,
|
||||
autoFocus: typing.Optional[bool] = None,
|
||||
labelledBy: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_open', 'title', 'placement', 'backdrop', 'close_button', 'keyboard', 'scrollable', 'style', 'class_name', 'backdrop_class_name', 'autofocus', 'labelledby', 'className', 'backdropClassName', 'autoFocus', 'labelledBy']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_open', 'title', 'placement', 'backdrop', 'close_button', 'keyboard', 'scrollable', 'style', 'class_name', 'backdrop_class_name', 'autofocus', 'labelledby', 'className', 'backdropClassName', 'autoFocus', 'labelledBy']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Offcanvas, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Offcanvas, "__init__", _explicitize_args(Offcanvas.__init__))
|
||||
@ -0,0 +1,106 @@
|
||||
# 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 Pagination(Component):
|
||||
"""A Pagination component.
|
||||
The container for presentational components for building a pagination UI.
|
||||
Individual pages should be added as children using the `PaginationItem`
|
||||
component.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Pagination.
|
||||
|
||||
- active_page (number; default 1):
|
||||
The currently active page.
|
||||
|
||||
- min_value (number; default 1):
|
||||
Minimum (leftmost) value to appear in the pagination.
|
||||
|
||||
- max_value (number; required):
|
||||
Maximum (rightmost) value to appear in the pagination. Must be
|
||||
defined. If the `min_value` and `step` together cannot reach this
|
||||
value, then the next stepped value is used as the maximum.
|
||||
|
||||
- step (number; default 1):
|
||||
Page increment step.
|
||||
|
||||
- size (a value equal to: 'sm', 'lg'; optional):
|
||||
Set the size of all page items in the Pagination.
|
||||
|
||||
- fully_expanded (boolean; default True):
|
||||
When True, this will display all numbers between `min_value` and
|
||||
`max_value`.
|
||||
|
||||
- previous_next (boolean; default False):
|
||||
When True, this will display a previous and next icon before and
|
||||
after the individual page numbers.
|
||||
|
||||
- first_last (boolean; default False):
|
||||
When True, this will display a first and last icon at the
|
||||
beginning and end of the Pagination.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Pagination.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the Pagination."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Pagination'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
active_page: typing.Optional[NumberType] = None,
|
||||
min_value: typing.Optional[NumberType] = None,
|
||||
max_value: typing.Optional[NumberType] = None,
|
||||
step: typing.Optional[NumberType] = None,
|
||||
size: typing.Optional[Literal["sm", "lg"]] = None,
|
||||
fully_expanded: typing.Optional[bool] = None,
|
||||
previous_next: typing.Optional[bool] = None,
|
||||
first_last: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'active_page', 'min_value', 'max_value', 'step', 'size', 'fully_expanded', 'previous_next', 'first_last', 'style', 'class_name', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'active_page', 'min_value', 'max_value', 'step', 'size', 'fully_expanded', 'previous_next', 'first_last', 'style', 'class_name', 'className']
|
||||
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}
|
||||
|
||||
for k in ['max_value']:
|
||||
if k not in args:
|
||||
raise TypeError(
|
||||
'Required argument `' + k + '` was not specified.')
|
||||
|
||||
super(Pagination, self).__init__(**args)
|
||||
|
||||
setattr(Pagination, "__init__", _explicitize_args(Pagination.__init__))
|
||||
@ -0,0 +1,155 @@
|
||||
# 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 Placeholder(Component):
|
||||
"""A Placeholder component.
|
||||
Use loading Placeholders for your components or pages to indicate
|
||||
something may still be loading.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Placeholder.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Placeholder.
|
||||
|
||||
- animation (a value equal to: 'glow', 'wave'; optional):
|
||||
Changes the animation of the Placeholder.
|
||||
|
||||
- color (string; optional):
|
||||
Background color, options: primary, secondary, success, info,
|
||||
warning, danger, light, dark.
|
||||
|
||||
- size (a value equal to: 'xs', 'sm', 'lg'; optional):
|
||||
Placeholder size variations. Only valid when `button=False`.
|
||||
|
||||
- button (boolean; default False):
|
||||
Show as a button shape.
|
||||
|
||||
- delay_hide (number; default 0):
|
||||
When using the placeholder as a loading placeholder, add a time
|
||||
delay (in ms) to the placeholder being removed to prevent
|
||||
flickering.
|
||||
|
||||
- delay_show (number; default 0):
|
||||
When using the placeholder as a loading placeholder, add a time
|
||||
delay (in ms) to the placeholder being shown after the lcomponent
|
||||
starts loading.
|
||||
|
||||
- show_initially (boolean; default True):
|
||||
Whether the Placeholder should show on app start-up before the
|
||||
loading state has been determined. Default True.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Placeholder.
|
||||
|
||||
- xs (number; optional):
|
||||
Specify placeholder behaviour on an extra small screen. Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive. See
|
||||
the documentation for more details.
|
||||
|
||||
- sm (number; optional):
|
||||
Specify placeholder behaviour on a small screen. Valid arguments
|
||||
are boolean, an integer in the range 1-12 inclusive. See the
|
||||
documentation for more details.
|
||||
|
||||
- md (number; optional):
|
||||
Specify placeholder behaviour on a medium screen. Valid arguments
|
||||
are boolean, an integer in the range 1-12 inclusive. See the
|
||||
documentation for more details.
|
||||
|
||||
- lg (number; optional):
|
||||
Specify placeholder behaviour on a large screen. Valid arguments
|
||||
are boolean, an integer in the range 1-12 inclusive. See the
|
||||
documentation for more details.
|
||||
|
||||
- xl (number; optional):
|
||||
Specify placeholder behaviour on an extra large screen. Valid
|
||||
arguments are boolean, an integer in the range 1-12 inclusive. See
|
||||
the documentation for more details.
|
||||
|
||||
- xxl (number; optional):
|
||||
Specify placeholder behaviour on an extra extra large screen.
|
||||
Valid arguments are boolean, an integer in the range 1-12
|
||||
inclusive. See the documentation for more details.
|
||||
|
||||
- target_components (dict with strings as keys and values of type string | list of strings; optional):
|
||||
Specify component and prop to trigger showing the placeholder.
|
||||
Example: `{\"output-container\": \"children\", \"grid\":
|
||||
[\"rowData\", \"columnDefs]}`.
|
||||
|
||||
- display (a value equal to: 'auto', 'show', 'hide'; default 'auto'):
|
||||
Setting display to \"show\" or \"hide\" will override the
|
||||
loading state coming from dash-renderer.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Placeholder."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Placeholder'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
animation: typing.Optional[Literal["glow", "wave"]] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
size: typing.Optional[Literal["xs", "sm", "lg"]] = None,
|
||||
button: typing.Optional[bool] = None,
|
||||
delay_hide: typing.Optional[NumberType] = None,
|
||||
delay_show: typing.Optional[NumberType] = None,
|
||||
show_initially: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
xs: typing.Optional[NumberType] = None,
|
||||
sm: typing.Optional[NumberType] = None,
|
||||
md: typing.Optional[NumberType] = None,
|
||||
lg: typing.Optional[NumberType] = None,
|
||||
xl: typing.Optional[NumberType] = None,
|
||||
xxl: typing.Optional[NumberType] = None,
|
||||
target_components: typing.Optional[typing.Dict[typing.Union[str, float, int], typing.Union[str, typing.Sequence[str]]]] = None,
|
||||
display: typing.Optional[Literal["auto", "show", "hide"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'animation', 'color', 'size', 'button', 'delay_hide', 'delay_show', 'show_initially', 'style', 'class_name', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'target_components', 'display', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'animation', 'color', 'size', 'button', 'delay_hide', 'delay_show', 'show_initially', 'style', 'class_name', 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'target_components', 'display', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Placeholder, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Placeholder, "__init__", _explicitize_args(Placeholder.__init__))
|
||||
@ -0,0 +1,171 @@
|
||||
# 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 Popover(Component):
|
||||
"""A Popover component.
|
||||
Popover creates a toggleable overlay that can be used to provide additional
|
||||
information or content to users without having to load a new page or open a new
|
||||
window.
|
||||
|
||||
Use the `PopoverHeader` and `PopoverBody` components to control the layout of the
|
||||
children.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Popover.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Popover.
|
||||
|
||||
- target (string | dict; optional):
|
||||
ID of the component to attach the Popover to.
|
||||
|
||||
- is_open (boolean; optional):
|
||||
Whether the Popover is open or not.
|
||||
|
||||
- trigger (string; optional):
|
||||
Space separated list of triggers (e.g. \"click hover focus
|
||||
legacy\"). These specify ways in which the target Popover can
|
||||
toggle the Popover. If not specified you must toggle the Popover
|
||||
yourself using callbacks. Options are: - \"click\": toggles the
|
||||
Popover when the target is clicked. - \"hover\": toggles the
|
||||
Popover when the target is hovered over with the cursor. -
|
||||
\"focus\": toggles the Popover when the target receives focus -
|
||||
\"legacy\": toggles the Popover when the target is clicked, but
|
||||
will also dismiss the Popover when the user clicks outside of the
|
||||
Popover.
|
||||
|
||||
- placement (a value equal to: 'auto', 'auto-start', 'auto-end', 'top', 'top-start', 'top-end', 'right', 'right-start', 'right-end', 'bottom', 'bottom-start', 'bottom-end', 'left', 'left-start', 'left-end'; default 'right'):
|
||||
Specify Popover placement.
|
||||
|
||||
- hide_arrow (boolean; optional):
|
||||
Hide Popover arrow.
|
||||
|
||||
- delay (dict; default {show: 0, hide: 50}):
|
||||
Optionally override show/hide delays.
|
||||
|
||||
`delay` is a dict with keys:
|
||||
|
||||
- show (number; optional)
|
||||
|
||||
- hide (number; optional) | number
|
||||
|
||||
- offset (string | number; optional):
|
||||
Offset of the Popover relative to its target. The offset can be
|
||||
passed as a comma separated pair of values e.g. \"0,8\", where the
|
||||
first number, skidding, displaces the Popover along the reference
|
||||
element. The second number, distance, displaces the Popover away
|
||||
from, or toward, the reference element in the direction of its
|
||||
placement. A positive number displaces it further away, while a
|
||||
negative number lets it overlap the reference. See
|
||||
https://popper.js.org/docs/v2/modifiers/offset/ for more info.
|
||||
Alternatively, you can provide just a single 'distance' number
|
||||
e.g. 8 to displace it horizontally.
|
||||
|
||||
- flip (boolean; default True):
|
||||
Whether to flip the direction of the Popover if too close to the
|
||||
container edge, default True.
|
||||
|
||||
- body (boolean; optional):
|
||||
When body is `True`, the Popover will render all children in a
|
||||
`PopoverBody` automatically.
|
||||
|
||||
- autohide (boolean; default False):
|
||||
Optionally hide Popover when hovering over content - default
|
||||
False.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Popover.
|
||||
|
||||
- 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: 'is_open's; optional):
|
||||
Properties whose user interactions will persist after refreshing
|
||||
the Popover 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 Popover, 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. Additional CSS classes
|
||||
to apply to the Popover."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Popover'
|
||||
Delay = TypedDict(
|
||||
"Delay",
|
||||
{
|
||||
"show": NotRequired[NumberType],
|
||||
"hide": NotRequired[NumberType]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
target: typing.Optional[typing.Union[str, dict]] = None,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
trigger: typing.Optional[str] = None,
|
||||
placement: typing.Optional[Literal["auto", "auto-start", "auto-end", "top", "top-start", "top-end", "right", "right-start", "right-end", "bottom", "bottom-start", "bottom-end", "left", "left-start", "left-end"]] = None,
|
||||
hide_arrow: typing.Optional[bool] = None,
|
||||
delay: typing.Optional[typing.Union["Delay", NumberType]] = None,
|
||||
offset: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
flip: typing.Optional[bool] = None,
|
||||
body: typing.Optional[bool] = None,
|
||||
autohide: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["is_open"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'target', 'is_open', 'trigger', 'placement', 'hide_arrow', 'delay', 'offset', 'flip', 'body', 'autohide', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'target', 'is_open', 'trigger', 'placement', 'hide_arrow', 'delay', 'offset', 'flip', 'body', 'autohide', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Popover, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Popover, "__init__", _explicitize_args(Popover.__init__))
|
||||
@ -0,0 +1,77 @@
|
||||
# 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 PopoverBody(Component):
|
||||
"""A PopoverBody component.
|
||||
Component for wrapping the body (i.e. main content) of a `Popover`.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this PopoverBody.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the PopoverBody.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the PopoverBody.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the PopoverBody, default: div.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the PopoverBody."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'PopoverBody'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(PopoverBody, self).__init__(children=children, **args)
|
||||
|
||||
setattr(PopoverBody, "__init__", _explicitize_args(PopoverBody.__init__))
|
||||
@ -0,0 +1,77 @@
|
||||
# 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 PopoverHeader(Component):
|
||||
"""A PopoverHeader component.
|
||||
Creates a header for use inside the `Popover` component.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this PopoverHeader.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the PopoverHeader.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the PopoverHeader.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the PopoverHeader, default: h3.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the PopoverHeader."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'PopoverHeader'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'tag', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(PopoverHeader, self).__init__(children=children, **args)
|
||||
|
||||
setattr(PopoverHeader, "__init__", _explicitize_args(PopoverHeader.__init__))
|
||||
@ -0,0 +1,113 @@
|
||||
# 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 Progress(Component):
|
||||
"""A Progress component.
|
||||
Component for displaying progress bars, with support for stacked bars, animated
|
||||
backgrounds, and text labels.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Progress. Use this to nest progress bars.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Progress.
|
||||
|
||||
- value (string | number; optional):
|
||||
Specify progress, value from min to max inclusive.
|
||||
|
||||
- label (string; optional):
|
||||
Adds a label to the progress bar.
|
||||
|
||||
- min (number; optional):
|
||||
Lower limit for value, default: 0.
|
||||
|
||||
- max (number; optional):
|
||||
Upper limit for value, default: 100.
|
||||
|
||||
- color (string; optional):
|
||||
Set color of the progress bar, options: primary, secondary,
|
||||
success, warning, danger, info or any valid CSS color of your
|
||||
choice (e.g. a hex code, a decimal code or a CSS color name).
|
||||
|
||||
- bar (boolean; optional):
|
||||
Set to True when nesting Progress inside another Progress
|
||||
component to create a multi-progress bar.
|
||||
|
||||
- hide_label (boolean; default False):
|
||||
Set to True to hide the label.
|
||||
|
||||
- animated (boolean; optional):
|
||||
Animate the bar, must have striped set to True to work.
|
||||
|
||||
- striped (boolean; optional):
|
||||
Use striped progress bar.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Progress.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Progress."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Progress'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
label: typing.Optional[str] = None,
|
||||
min: typing.Optional[NumberType] = None,
|
||||
max: typing.Optional[NumberType] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
bar: typing.Optional[bool] = None,
|
||||
hide_label: typing.Optional[bool] = None,
|
||||
animated: typing.Optional[bool] = None,
|
||||
striped: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'value', 'label', 'min', 'max', 'color', 'bar', 'hide_label', 'animated', 'striped', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'value', 'label', 'min', 'max', 'color', 'bar', 'hide_label', 'animated', 'striped', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Progress, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Progress, "__init__", _explicitize_args(Progress.__init__))
|
||||
@ -0,0 +1,137 @@
|
||||
# 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 RadioButton(Component):
|
||||
"""A RadioButton component.
|
||||
Render a single radio button.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the RadioButton.
|
||||
|
||||
- value (boolean; default False):
|
||||
The value of the input.
|
||||
|
||||
- disabled (boolean; default False):
|
||||
Disable the RadioButton.
|
||||
|
||||
- class_name (string; optional):
|
||||
CSS classes to apply to the container (div).
|
||||
|
||||
- input_style (dict; optional):
|
||||
Inline CSS styles to apply to the <input> element.
|
||||
|
||||
- input_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <input> element.
|
||||
|
||||
- label (a list of or a singular dash component, string or number; optional):
|
||||
The label of the <input> element.
|
||||
|
||||
- label_id (string; optional):
|
||||
The id of the label.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Additional inline CSS styles to add to the label.
|
||||
|
||||
- label_class_name (string; optional):
|
||||
Additional CSS classes to apply to the label.
|
||||
|
||||
- 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.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the container div.
|
||||
|
||||
- inputStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_style` instead. Additional inline CSS
|
||||
styles to apply to the <input> element.
|
||||
|
||||
- inputClassName (string; optional):
|
||||
**DEPRECATED** Use `input_class_name` instead. Additional CSS
|
||||
classes to apply to the <input> element.
|
||||
|
||||
- labelStyle (dict; optional):
|
||||
**DEPRECATED** Use `label_style` instead. Additional inline CSS
|
||||
styles to add to the label.
|
||||
|
||||
- labelClassName (string; optional):
|
||||
**DEPRECATED** Use `label_class_name` instead. Additional CSS
|
||||
classes to apply to the label."""
|
||||
_children_props = ['label']
|
||||
_base_nodes = ['label', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'RadioButton'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
input_style: typing.Optional[dict] = None,
|
||||
input_class_name: typing.Optional[str] = None,
|
||||
label: typing.Optional[ComponentType] = None,
|
||||
label_id: typing.Optional[str] = None,
|
||||
label_style: typing.Optional[dict] = None,
|
||||
label_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,
|
||||
className: typing.Optional[str] = None,
|
||||
inputStyle: typing.Optional[dict] = None,
|
||||
inputClassName: typing.Optional[str] = None,
|
||||
labelStyle: typing.Optional[dict] = None,
|
||||
labelClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'value', 'disabled', 'class_name', 'style', 'input_style', 'input_class_name', 'label', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'value', 'disabled', 'class_name', 'style', 'input_style', 'input_class_name', 'label', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
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(RadioButton, self).__init__(**args)
|
||||
|
||||
setattr(RadioButton, "__init__", _explicitize_args(RadioButton.__init__))
|
||||
@ -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__))
|
||||
@ -0,0 +1,85 @@
|
||||
# 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 Row(Component):
|
||||
"""A Row component.
|
||||
Row is one of the core layout components in Bootstrap. Build up your layout as a
|
||||
series of rows of columns. Row has arguments for controlling the vertical and
|
||||
horizontal alignment of its children, as well as the spacing between columns.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Row.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Row.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Row.
|
||||
|
||||
- align (a value equal to: 'start', 'center', 'end', 'stretch', 'baseline'; optional):
|
||||
Set vertical alignment of columns in this row. Options are
|
||||
'start', 'center', 'end', 'stretch' and 'baseline'.
|
||||
|
||||
- justify (a value equal to: 'start', 'center', 'end', 'around', 'between', 'evenly'; optional):
|
||||
Set horizontal spacing and alignment of columns in this row.
|
||||
Options are 'start', 'center', 'end', 'around' and 'between'.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Row."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Row'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
align: typing.Optional[Literal["start", "center", "end", "stretch", "baseline"]] = None,
|
||||
justify: typing.Optional[Literal["start", "center", "end", "around", "between", "evenly"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'align', 'justify', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'align', 'justify', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Row, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Row, "__init__", _explicitize_args(Row.__init__))
|
||||
@ -0,0 +1,180 @@
|
||||
# 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 Select(Component):
|
||||
"""A Select component.
|
||||
Create a HTML select element with Bootstrap styles. Specify options as a list of
|
||||
dictionaries with keys label, value and disabled.
|
||||
|
||||
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), \"title\":
|
||||
[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 (string | number; required):
|
||||
The options's label.
|
||||
|
||||
- value (string; required):
|
||||
The value of the option. This value corresponds to the items
|
||||
specified in the `value` property.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
If True, this checkbox is disabled and can't be clicked on.
|
||||
|
||||
- title (string; 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 (string | number; default ''):
|
||||
The value of the currently selected option.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Select.
|
||||
|
||||
- placeholder (string; default ''):
|
||||
Placeholder text to display before a selection is made.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
Set to True to disable the Select.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Select.
|
||||
|
||||
- required (a value equal to: 'required', 'REQUIRED' | boolean; optional):
|
||||
This attribute specifies that the user must fill in a value before
|
||||
submitting a form. It cannot be used when the type attribute is
|
||||
hidden, image, or a button type (submit, reset, or button). The
|
||||
:optional and :required CSS pseudo-classes will be applied to the
|
||||
field as appropriate. required is an HTML boolean attribute - it
|
||||
is enabled by a boolean or 'required'. Alternative capitalizations
|
||||
`REQUIRED` are also acccepted.
|
||||
|
||||
- valid (boolean; optional):
|
||||
Apply valid style to the Input for feedback purposes. This will
|
||||
cause any FormFeedback in the enclosing div with valid=True to
|
||||
display.
|
||||
|
||||
- invalid (boolean; optional):
|
||||
Apply invalid style to the Input for feedback purposes. This will
|
||||
cause any FormFeedback in the enclosing div with valid=False to
|
||||
display.
|
||||
|
||||
- size (string; optional):
|
||||
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
|
||||
'lg' (large). Default is 'md'.
|
||||
|
||||
- html_size (string; optional):
|
||||
This represents the number of rows in the select that should be
|
||||
visible at one time. It will result in the Select being rendered
|
||||
as a scrolling list box rather than a dropdown.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Select."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Select'
|
||||
Options = TypedDict(
|
||||
"Options",
|
||||
{
|
||||
"label": typing.Union[str, NumberType],
|
||||
"value": str,
|
||||
"disabled": NotRequired[bool],
|
||||
"title": 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,
|
||||
*,
|
||||
placeholder: typing.Optional[str] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
required: typing.Optional[typing.Union[Literal["required", "REQUIRED"], bool]] = None,
|
||||
valid: typing.Optional[bool] = None,
|
||||
invalid: typing.Optional[bool] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
html_size: 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,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['options', 'value', 'id', 'placeholder', 'disabled', 'style', 'class_name', 'required', 'valid', 'invalid', 'size', 'html_size', 'name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['options', 'value', 'id', 'placeholder', 'disabled', 'style', 'class_name', 'required', 'valid', 'invalid', 'size', 'html_size', 'name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
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(Select, self).__init__(**args)
|
||||
|
||||
setattr(Select, "__init__", _explicitize_args(Select.__init__))
|
||||
@ -0,0 +1,136 @@
|
||||
# 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 Spinner(Component):
|
||||
"""A Spinner component.
|
||||
Render Bootstrap style loading spinners using only CSS.
|
||||
|
||||
This component can be used standalone to render a loading spinner, or it can
|
||||
be used like `dash_core_components.Loading` by giving it children. In the
|
||||
latter case the chosen spinner will display while the children are loading.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Spinner.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Spinner.
|
||||
|
||||
- color (string; optional):
|
||||
Sets the color of the Spinner. Main options are Bootstrap
|
||||
contextual colors: primary, secondary, success, info, warning,
|
||||
danger, light, dark, body, muted, white-50, black-50. You can also
|
||||
specify any valid CSS color of your choice (e.g. a hex code, a
|
||||
decimal code or a CSS color name) If not specified will default
|
||||
to text colour.
|
||||
|
||||
- type (string; default 'border'):
|
||||
The type of spinner. Options 'border' and 'grow'. Default
|
||||
'border'.
|
||||
|
||||
- size (string; optional):
|
||||
The spinner size. Options are 'sm', and 'md'.
|
||||
|
||||
- fullscreen (boolean; optional):
|
||||
Boolean that determines if the loading spinner will be displayed
|
||||
full-screen or not.
|
||||
|
||||
- delay_hide (number; default 0):
|
||||
When using the Spinner as a loading spinner, add a time delay (in
|
||||
ms) to the spinner being removed to prevent flickering.
|
||||
|
||||
- delay_show (number; default 0):
|
||||
When using the Spinner as a loading spinner, add a time delay (in
|
||||
ms) to the spinner being shown after the component starts loading.
|
||||
|
||||
- show_initially (boolean; default True):
|
||||
Whether the Spinner should show on app start-up before the loading
|
||||
state has been determined. Default True.
|
||||
|
||||
- spinner_style (dict; optional):
|
||||
Inline CSS styles to apply to the Spinner.
|
||||
|
||||
- spinner_class_name (string; optional):
|
||||
CSS class names to apply to the Spinner.
|
||||
|
||||
- fullscreen_style (dict; optional):
|
||||
Defines CSS styles for the container when fullscreen=True.
|
||||
|
||||
- fullscreen_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Spinner when
|
||||
fullscreen=True.
|
||||
|
||||
- display (a value equal to: 'auto', 'show', 'hide'; optional):
|
||||
Setting display to \"show\" or \"hide\" will override the
|
||||
loading state coming from dash-renderer.
|
||||
|
||||
- target_components (dict with strings as keys and values of type string | list of strings; optional):
|
||||
Specify component and prop to trigger showing the loading spinner
|
||||
example: `{\"output-container\": \"children\", \"grid\":
|
||||
[\"rowData\", \"columnDefs]}`.
|
||||
|
||||
- fullscreenClassName (string; optional):
|
||||
**DEPRECATED** Use `fullscreen_class_name` instead. Additional
|
||||
CSS classes to apply to the Spinner when fullscreen=True.
|
||||
|
||||
- spinnerClassName (string; optional):
|
||||
**DEPRECATED** Use `spinner_class_name` instead. CSS class names
|
||||
to apply to the spinner."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Spinner'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
color: typing.Optional[str] = None,
|
||||
type: typing.Optional[str] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
fullscreen: typing.Optional[bool] = None,
|
||||
delay_hide: typing.Optional[NumberType] = None,
|
||||
delay_show: typing.Optional[NumberType] = None,
|
||||
show_initially: typing.Optional[bool] = None,
|
||||
spinner_style: typing.Optional[dict] = None,
|
||||
spinner_class_name: typing.Optional[str] = None,
|
||||
fullscreen_style: typing.Optional[dict] = None,
|
||||
fullscreen_class_name: typing.Optional[str] = None,
|
||||
display: typing.Optional[Literal["auto", "show", "hide"]] = None,
|
||||
target_components: typing.Optional[typing.Dict[typing.Union[str, float, int], typing.Union[str, typing.Sequence[str]]]] = None,
|
||||
fullscreenClassName: typing.Optional[str] = None,
|
||||
spinnerClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'color', 'type', 'size', 'fullscreen', 'delay_hide', 'delay_show', 'show_initially', 'spinner_style', 'spinner_class_name', 'fullscreen_style', 'fullscreen_class_name', 'display', 'target_components', 'fullscreenClassName', 'spinnerClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'color', 'type', 'size', 'fullscreen', 'delay_hide', 'delay_show', 'show_initially', 'spinner_style', 'spinner_class_name', 'fullscreen_style', 'fullscreen_class_name', 'display', 'target_components', 'fullscreenClassName', 'spinnerClassName']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Spinner, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Spinner, "__init__", _explicitize_args(Spinner.__init__))
|
||||
@ -0,0 +1,82 @@
|
||||
# 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 Stack(Component):
|
||||
"""A Stack component.
|
||||
Stacks are shorthand helpers that build on top of existing flexbox
|
||||
utilities to make component layout faster and easier than ever.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Stack.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Stack.
|
||||
|
||||
- direction (a value equal to: 'vertical', 'horizontal'; optional):
|
||||
Which direction to stack the objects in.
|
||||
|
||||
- gap (number; optional):
|
||||
Set the spacing between each item (0 - 5).
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Stack.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Stack."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Stack'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
direction: typing.Optional[Literal["vertical", "horizontal"]] = None,
|
||||
gap: typing.Optional[NumberType] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'direction', 'gap', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'direction', 'gap', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Stack, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Stack, "__init__", _explicitize_args(Stack.__init__))
|
||||
@ -0,0 +1,137 @@
|
||||
# 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 Switch(Component):
|
||||
"""A Switch component.
|
||||
Render a single toggle-like switch.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Switch.
|
||||
|
||||
- value (boolean; default False):
|
||||
The value of the switch.
|
||||
|
||||
- disabled (boolean; default False):
|
||||
Disable the Switch.
|
||||
|
||||
- label (a list of or a singular dash component, string or number; optional):
|
||||
The label of the <input> element.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the container div.
|
||||
|
||||
- input_style (dict; optional):
|
||||
Additional inline CSS styles to apply to the <input> element.
|
||||
|
||||
- input_class_name (string; optional):
|
||||
Additional CSS classes to apply to the <input> element.
|
||||
|
||||
- label_id (string; optional):
|
||||
The ID of the label.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Additional inline CSS styles to add to the label.
|
||||
|
||||
- label_class_name (string; optional):
|
||||
Additional CSS classes to apply to the label.
|
||||
|
||||
- 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.
|
||||
|
||||
- className (string; optional):
|
||||
**DEPRECATED** Use `class_name` instead. Additional CSS classes
|
||||
to apply to the container div.
|
||||
|
||||
- inputStyle (dict; optional):
|
||||
**DEPRECATED** Use `input_style` instead. Additional inline CSS
|
||||
styles to apply to the <input> element.
|
||||
|
||||
- inputClassName (string; optional):
|
||||
**DEPRECATED** Use `input_class_name` instead. Additional CSS
|
||||
classes to apply to the <input> element.
|
||||
|
||||
- labelStyle (dict; optional):
|
||||
**DEPRECATED** Use `label_style` instead. Additional inline CSS
|
||||
styles to add to the label.
|
||||
|
||||
- labelClassName (string; optional):
|
||||
**DEPRECATED** Use `label_class_name` instead. Additional CSS
|
||||
classes to apply to the label."""
|
||||
_children_props = ['label']
|
||||
_base_nodes = ['label', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Switch'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[bool] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
label: typing.Optional[ComponentType] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
input_style: typing.Optional[dict] = None,
|
||||
input_class_name: typing.Optional[str] = None,
|
||||
label_id: typing.Optional[str] = None,
|
||||
label_style: typing.Optional[dict] = None,
|
||||
label_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,
|
||||
className: typing.Optional[str] = None,
|
||||
inputStyle: typing.Optional[dict] = None,
|
||||
inputClassName: typing.Optional[str] = None,
|
||||
labelStyle: typing.Optional[dict] = None,
|
||||
labelClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
|
||||
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(Switch, self).__init__(**args)
|
||||
|
||||
setattr(Switch, "__init__", _explicitize_args(Switch.__init__))
|
||||
@ -0,0 +1,154 @@
|
||||
# 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 Tab(Component):
|
||||
"""A Tab component.
|
||||
Create a single tab. Should be used as a component of Tabs.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Tab.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Tab.
|
||||
|
||||
- label (string; optional):
|
||||
The tab's label, displayed in the tab itself.
|
||||
|
||||
- tab_id (string; optional):
|
||||
Optional identifier for tab used for determining which tab is
|
||||
visible if not specified, and Tab is being used inside Tabs
|
||||
component, the tabId will be set to \"tab-i\" where i is (zero
|
||||
indexed) position of tab in list tabs pased to Tabs component.
|
||||
|
||||
- disabled (boolean; optional):
|
||||
Determines if Tab is disabled or not - defaults to False.
|
||||
|
||||
- tab_style (dict; optional):
|
||||
Defines CSS styles which will override styles previously set. The
|
||||
styles set here apply to the NavItem in the tab.
|
||||
|
||||
- active_tab_style (dict; optional):
|
||||
Defines CSS styles which will override styles previously set. The
|
||||
styles set here apply to the NavItem in the tab when it is active.
|
||||
|
||||
- label_style (dict; optional):
|
||||
Defines CSS styles which will override styles previously set. The
|
||||
styles set here apply to the NavLink in the tab.
|
||||
|
||||
- active_label_style (dict; optional):
|
||||
Defines CSS styles which will override styles previously set. The
|
||||
styles set here apply to the NavLink in the tab when it is active.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs.
|
||||
|
||||
- tab_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs. The classes specified
|
||||
with this prop will be applied to the NavItem in the tab.
|
||||
|
||||
- active_tab_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs. The classes specified
|
||||
with this prop will be applied to the NavItem in the tab when it
|
||||
is active.
|
||||
|
||||
- label_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs. The classes specified
|
||||
with this prop will be applied to the NavLink in the tab.
|
||||
|
||||
- active_label_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs. The classes specified
|
||||
with this prop will be applied to the NavLink in the tab when it
|
||||
is active.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Tabs.
|
||||
|
||||
- tabClassName (string; optional):
|
||||
**DEPRECATED** Use `tab_class_name` instead. Additional CSS
|
||||
classes to apply to the Tabs. The classes specified with this prop
|
||||
will be applied to the NavItem in the tab.
|
||||
|
||||
- activeTabClassName (string; optional):
|
||||
**DEPRECATED** Use `active_tab_class_name` instead. Additional
|
||||
CSS classes to apply to the Tabs. The classes specified with this
|
||||
prop will be applied to the NavItem in the tab when it is active.
|
||||
|
||||
- labelClassName (string; optional):
|
||||
**DEPRECATED** Use `label_class_name` instead. Additional CSS
|
||||
classes to apply to the Tabs. The classes specified with this prop
|
||||
will be applied to the NavLink in the tab.
|
||||
|
||||
- activeLabelClassName (string; optional):
|
||||
**DEPRECATED** Use `active_label_class_name` instead. Additional
|
||||
CSS classes to apply to the Tabs. The classes specified with this
|
||||
prop will be applied to the NavLink in the tab when it is active."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Tab'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
label: typing.Optional[str] = None,
|
||||
tab_id: typing.Optional[str] = None,
|
||||
disabled: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
tab_style: typing.Optional[dict] = None,
|
||||
active_tab_style: typing.Optional[dict] = None,
|
||||
label_style: typing.Optional[dict] = None,
|
||||
active_label_style: typing.Optional[dict] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
tab_class_name: typing.Optional[str] = None,
|
||||
active_tab_class_name: typing.Optional[str] = None,
|
||||
label_class_name: typing.Optional[str] = None,
|
||||
active_label_class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
tabClassName: typing.Optional[str] = None,
|
||||
activeTabClassName: typing.Optional[str] = None,
|
||||
labelClassName: typing.Optional[str] = None,
|
||||
activeLabelClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'label', 'tab_id', 'disabled', 'style', 'tab_style', 'active_tab_style', 'label_style', 'active_label_style', 'class_name', 'tab_class_name', 'active_tab_class_name', 'label_class_name', 'active_label_class_name', 'key', 'className', 'tabClassName', 'activeTabClassName', 'labelClassName', 'activeLabelClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'label', 'tab_id', 'disabled', 'style', 'tab_style', 'active_tab_style', 'label_style', 'active_label_style', 'class_name', 'tab_class_name', 'active_tab_class_name', 'label_class_name', 'active_label_class_name', 'key', 'className', 'tabClassName', 'activeTabClassName', 'labelClassName', 'activeLabelClassName']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Tab, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Tab, "__init__", _explicitize_args(Tab.__init__))
|
||||
@ -0,0 +1,109 @@
|
||||
# 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 Table(Component):
|
||||
"""A Table component.
|
||||
A component for applying Bootstrap styles to HTML tables. Use this as a drop-in
|
||||
replacement for `html.Table`, or generate a table from a Pandas DataFrame using
|
||||
`dbc.Table.from_dataframe`.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Table.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Table.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Table.
|
||||
|
||||
- size (string; optional):
|
||||
Specify table size, options: 'sm', 'md', 'lg'.
|
||||
|
||||
- bordered (boolean; optional):
|
||||
Apply the `table-bordered` class which adds borders on all sides
|
||||
of the table and cells.
|
||||
|
||||
- borderless (boolean; optional):
|
||||
Apply the `table-borderless` class which removes all borders from
|
||||
the table and cells.
|
||||
|
||||
- striped (boolean; optional):
|
||||
Apply the `table-striped` class which applies 'zebra striping' to
|
||||
rows in the table body.
|
||||
|
||||
- color (string; optional):
|
||||
Table color, options: primary, secondary, success, info, warning,
|
||||
danger, dark, light. Default: secondary.
|
||||
|
||||
- hover (boolean; optional):
|
||||
Apply the `table-hover` class which enables a hover state on table
|
||||
rows within the table body.
|
||||
|
||||
- responsive (boolean | string; optional):
|
||||
Set to True or one of the breakpoints 'sm', 'md', 'lg', 'xl' to
|
||||
make table scroll horizontally at lower breakpoints.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Table."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Table'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
bordered: typing.Optional[bool] = None,
|
||||
borderless: typing.Optional[bool] = None,
|
||||
striped: typing.Optional[bool] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
hover: typing.Optional[bool] = None,
|
||||
responsive: typing.Optional[typing.Union[bool, str]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'style', 'class_name', 'size', 'bordered', 'borderless', 'striped', 'color', 'hover', 'responsive', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'style', 'class_name', 'size', 'bordered', 'borderless', 'striped', 'color', 'hover', 'responsive', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Table, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Table, "__init__", _explicitize_args(Table.__init__))
|
||||
@ -0,0 +1,100 @@
|
||||
# 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 Tabs(Component):
|
||||
"""A Tabs component.
|
||||
Create Bootstrap styled tabs. Use the `active_tab` property to set, or get the
|
||||
currently active tab in a callback.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Tabs component. Each child should be a Tab
|
||||
component.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Tabs.
|
||||
|
||||
- active_tab (string; optional):
|
||||
The tab_id of the currently active tab. If tab_id has not been
|
||||
specified for the active tab, this will default to tab-i, where i
|
||||
is the index (starting from 0) of the tab.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tabs.
|
||||
|
||||
- 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: 'active_tab's; optional):
|
||||
Properties whose user interactions will persist after refreshing
|
||||
the component or the page. Since only `active_tab` 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. Additional CSS classes
|
||||
to apply to the Tabs."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Tabs'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
active_tab: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["active_tab"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'active_tab', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'active_tab', 'style', 'class_name', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Tabs, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Tabs, "__init__", _explicitize_args(Tabs.__init__))
|
||||
@ -0,0 +1,282 @@
|
||||
# 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 Textarea(Component):
|
||||
"""A Textarea component.
|
||||
A basic HTML textarea for entering multiline text based on the corresponding
|
||||
component in dash-core-components
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Textarea.
|
||||
|
||||
- value (string; default ''):
|
||||
The value of the textarea.
|
||||
|
||||
- n_blur (number; default 0):
|
||||
Number of times the input lost focus.
|
||||
|
||||
- n_submit (number; default 0):
|
||||
Number of times the `Enter` key was pressed while the textarea had
|
||||
focus. Only updates if submit_on_enter is True.
|
||||
|
||||
- n_clicks (number; default 0):
|
||||
The number of times the TextArea has been clicked.
|
||||
|
||||
- valid (boolean; optional):
|
||||
Apply valid style to the Textarea for feedback purposes. This will
|
||||
cause any FormFeedback in the enclosing div with valid=True to
|
||||
display.
|
||||
|
||||
- invalid (boolean; optional):
|
||||
Apply invalid style to the Textarea for feedback purposes. This
|
||||
will cause any FormFeedback in the enclosing div with valid=False
|
||||
to display.
|
||||
|
||||
- placeholder (string; optional):
|
||||
Provides a hint to the user of what can be entered in the field.
|
||||
|
||||
- size (string; optional):
|
||||
Set the size of the Textarea, valid options are 'sm', 'md', or
|
||||
'lg'.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Textarea.
|
||||
|
||||
- accesskey (string; optional):
|
||||
Defines a keyboard shortcut to activate or add focus to the
|
||||
element.
|
||||
|
||||
- autofocus (string; optional):
|
||||
The element should be automatically focused after the page loaded.
|
||||
|
||||
- contenteditable (string | number; optional):
|
||||
Indicates whether the element's content is editable.
|
||||
|
||||
- contextmenu (string; optional):
|
||||
Defines the ID of a <menu> element which will serve as the
|
||||
element's context menu.
|
||||
|
||||
- cols (string | number; optional):
|
||||
Defines the number of columns in a textarea.
|
||||
|
||||
- dir (string; optional):
|
||||
Defines the text direction. Allowed values are ltr (Left-To-Right)
|
||||
or rtl (Right-To-Left).
|
||||
|
||||
- disabled (string | boolean; optional):
|
||||
Indicates whether the user can interact with the element.
|
||||
|
||||
- draggable (a value equal to: 'true', 'false' | boolean; optional):
|
||||
Defines whether the element can be dragged.
|
||||
|
||||
- form (string; optional):
|
||||
Indicates the form that is the owner of the element.
|
||||
|
||||
- hidden (string; optional):
|
||||
Prevents rendering of given element, while keeping child elements,
|
||||
e.g. script elements, active.
|
||||
|
||||
- lang (string; optional):
|
||||
Defines the language used in the element.
|
||||
|
||||
- maxlength (string | number; optional):
|
||||
Defines the maximum number of characters allowed in the element.
|
||||
|
||||
- minlength (string | number; optional):
|
||||
Defines the minimum number of characters allowed in the element.
|
||||
|
||||
- name (string; optional):
|
||||
Name of the element. For example used by the server to identify
|
||||
the fields in form submits.
|
||||
|
||||
- readonly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
|
||||
Indicates whether the element can be edited.
|
||||
|
||||
- required (a value equal to: 'required', 'REQUIRED' | boolean; optional):
|
||||
This attribute specifies that the user must fill in a value before
|
||||
submitting a form. It cannot be used when the type attribute is
|
||||
hidden, image, or a button type (submit, reset, or button). The
|
||||
:optional and :required CSS pseudo-classes will be applied to the
|
||||
field as appropriate. required is an HTML boolean attribute - it
|
||||
is enabled by a boolean or 'required'. Alternative capitalizations
|
||||
`REQUIRED` are also acccepted.
|
||||
|
||||
- rows (string | number; optional):
|
||||
Defines the number of rows in a text area.
|
||||
|
||||
- spellcheck (a value equal to: 'true', 'false' | boolean; optional):
|
||||
Indicates whether spell checking is allowed for the element.
|
||||
|
||||
- tabindex (string | number; optional):
|
||||
Overrides the browser's default tab order and follows the one
|
||||
specified instead.
|
||||
|
||||
- title (string; optional):
|
||||
Text to be displayed in a tooltip when hovering over the element.
|
||||
|
||||
- wrap (string; optional):
|
||||
Indicates whether the text should be wrapped.
|
||||
|
||||
- submit_on_enter (boolean; default True):
|
||||
Whether or not the form should increment the n_submit prop when
|
||||
enter key is pressed. If True, use shift + enter to create a
|
||||
newline. Default: True.
|
||||
|
||||
- debounce (boolean | number; default False):
|
||||
If True, changes to input will be sent back to the Dash server
|
||||
only on enter or when losing focus. If it's False, it will sent
|
||||
the value back on every change. If debounce is a number, the value
|
||||
will be sent to the server only after the user has stopped typing
|
||||
for that number of milliseconds.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Textarea.
|
||||
|
||||
- accessKey (string; optional):
|
||||
**DEPRECATED** Use `accesskey` instead. Defines a keyboard
|
||||
shortcut to activate or add focus to the element.
|
||||
|
||||
- autoFocus (string; optional):
|
||||
**DEPRECATED** Use `autofocus` instead. The element should be
|
||||
automatically focused after the page loaded.
|
||||
|
||||
- contentEditable (string | number; optional):
|
||||
**DEPRECATED** Use `contenteditable` instead. Indicates whether
|
||||
the element's content is editable.
|
||||
|
||||
- contextMenu (string; optional):
|
||||
**DEPRECATED** Use `contextmenu` instead. Defines the ID of a
|
||||
<menu> element which will serve as the element's context menu.
|
||||
|
||||
- maxLength (string | number; optional):
|
||||
**DEPRECATED** Use `maxlength` instead. Defines the maximum
|
||||
number of characters allowed in the element.
|
||||
|
||||
- minLength (string | number; optional):
|
||||
**DEPRECATED** Use `minlength` instead. Defines the minimum
|
||||
number of characters allowed in the element.
|
||||
|
||||
- readOnly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
|
||||
**DEPRECATED** Use `readonly` instead. Indicates whether the
|
||||
element can be edited.
|
||||
|
||||
- spellCheck (a value equal to: 'true', 'false' | boolean; optional):
|
||||
**DEPRECATED** Use `spellcheck` instead. Indicates whether spell
|
||||
checking is allowed for the element.
|
||||
|
||||
- tabIndex (string | number; optional):
|
||||
**DEPRECATED** Use `tabindex` instead. Overrides the browser's
|
||||
default tab order and follows the one specified instead."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Textarea'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
value: typing.Optional[str] = None,
|
||||
n_blur: typing.Optional[NumberType] = None,
|
||||
n_submit: typing.Optional[NumberType] = None,
|
||||
n_clicks: typing.Optional[NumberType] = None,
|
||||
valid: typing.Optional[bool] = None,
|
||||
invalid: typing.Optional[bool] = None,
|
||||
placeholder: typing.Optional[str] = None,
|
||||
size: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
accesskey: typing.Optional[str] = None,
|
||||
autofocus: typing.Optional[str] = None,
|
||||
contenteditable: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
contextmenu: typing.Optional[str] = None,
|
||||
cols: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
dir: typing.Optional[str] = None,
|
||||
disabled: typing.Optional[typing.Union[str, bool]] = None,
|
||||
draggable: typing.Optional[typing.Union[Literal["true", "false"], bool]] = None,
|
||||
form: typing.Optional[str] = None,
|
||||
hidden: typing.Optional[str] = None,
|
||||
lang: typing.Optional[str] = None,
|
||||
maxlength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
minlength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
name: typing.Optional[str] = None,
|
||||
readonly: typing.Optional[typing.Union[bool, Literal["readOnly", "readonly", "READONLY"]]] = None,
|
||||
required: typing.Optional[typing.Union[Literal["required", "REQUIRED"], bool]] = None,
|
||||
rows: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
spellcheck: typing.Optional[typing.Union[Literal["true", "false"], bool]] = None,
|
||||
tabindex: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
title: typing.Optional[str] = None,
|
||||
wrap: typing.Optional[str] = None,
|
||||
submit_on_enter: typing.Optional[bool] = None,
|
||||
debounce: typing.Optional[typing.Union[bool, NumberType]] = 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,
|
||||
accessKey: typing.Optional[str] = None,
|
||||
autoFocus: typing.Optional[str] = None,
|
||||
contentEditable: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
contextMenu: typing.Optional[str] = None,
|
||||
maxLength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
minLength: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
readOnly: typing.Optional[typing.Union[bool, Literal["readOnly", "readonly", "READONLY"]]] = None,
|
||||
spellCheck: typing.Optional[typing.Union[Literal["true", "false"], bool]] = None,
|
||||
tabIndex: typing.Optional[typing.Union[str, NumberType]] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['id', 'value', 'n_blur', 'n_submit', 'n_clicks', 'valid', 'invalid', 'placeholder', 'size', 'style', 'class_name', 'accesskey', 'autofocus', 'contenteditable', 'contextmenu', 'cols', 'dir', 'disabled', 'draggable', 'form', 'hidden', 'lang', 'maxlength', 'minlength', 'name', 'readonly', 'required', 'rows', 'spellcheck', 'tabindex', 'title', 'wrap', 'submit_on_enter', 'debounce', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'accessKey', 'autoFocus', 'contentEditable', 'contextMenu', 'maxLength', 'minLength', 'readOnly', 'spellCheck', 'tabIndex']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['id', 'value', 'n_blur', 'n_submit', 'n_clicks', 'valid', 'invalid', 'placeholder', 'size', 'style', 'class_name', 'accesskey', 'autofocus', 'contenteditable', 'contextmenu', 'cols', 'dir', 'disabled', 'draggable', 'form', 'hidden', 'lang', 'maxlength', 'minlength', 'name', 'readonly', 'required', 'rows', 'spellcheck', 'tabindex', 'title', 'wrap', 'submit_on_enter', 'debounce', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'accessKey', 'autoFocus', 'contentEditable', 'contextMenu', 'maxLength', 'minLength', 'readOnly', 'spellCheck', 'tabIndex']
|
||||
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(Textarea, self).__init__(**args)
|
||||
|
||||
setattr(Textarea, "__init__", _explicitize_args(Textarea.__init__))
|
||||
@ -0,0 +1,159 @@
|
||||
# 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 Toast(Component):
|
||||
"""A Toast component.
|
||||
Toasts can be used to push messages and notifactions to users. Control visibility of
|
||||
the toast with the `is_open` prop, or use `duration` to set a timer for
|
||||
auto-dismissal.
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of the Toast.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Toast.
|
||||
|
||||
- is_open (boolean; default True):
|
||||
Whether Toast is currently open.
|
||||
|
||||
- dismissable (boolean; default False):
|
||||
Set to True to add a dismiss button to the header which will close
|
||||
the toast on click.
|
||||
|
||||
- duration (number; optional):
|
||||
Duration in milliseconds after which the Alert dismisses itself.
|
||||
|
||||
- n_dismiss (number; default 0):
|
||||
An integer that represents the number of times that the dismiss
|
||||
button has been clicked on.
|
||||
|
||||
- header (a list of or a singular dash component, string or number; optional):
|
||||
Text to populate the header with.
|
||||
|
||||
- icon (string; optional):
|
||||
Add a contextually coloured icon to the header of the toast.
|
||||
Options are: \"primary\", \"secondary\", \"success\", \"warning\",
|
||||
\"danger\", \"info\", \"light\" or \"dark\".
|
||||
|
||||
- color (string; optional):
|
||||
Toast color, options: primary, secondary, success, info, warning,
|
||||
danger, light, dark. Default: secondary.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Toast.
|
||||
|
||||
- header_style (dict; optional):
|
||||
Additional inline CSS styles to apply to the Toast header.
|
||||
|
||||
- header_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Toast header.
|
||||
|
||||
- body_style (dict; optional):
|
||||
Additional CSS classes to apply to the Toast body.
|
||||
|
||||
- body_class_name (string; optional):
|
||||
Additional CSS classes to apply to the Toast body.
|
||||
|
||||
- tag (string; optional):
|
||||
HTML tag to use for the Toast, default: div.
|
||||
|
||||
- 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: 'is_open'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. Additional CSS classes
|
||||
to apply to the Toast.
|
||||
|
||||
- headerClassName (string; optional):
|
||||
**DEPRECATED** Use `header_class_name` instead. Additional CSS
|
||||
classes to apply to the Toast. The classes specified with this
|
||||
prop will be applied to the header of the toast.
|
||||
|
||||
- bodyClassName (string; optional):
|
||||
**DEPRECATED** Use `body_class_name` instead. Additional CSS
|
||||
classes to apply to the Toast. The classes specified with this
|
||||
prop will be applied to the body of the toast."""
|
||||
_children_props = ['header']
|
||||
_base_nodes = ['header', 'children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Toast'
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
dismissable: typing.Optional[bool] = None,
|
||||
duration: typing.Optional[NumberType] = None,
|
||||
n_dismiss: typing.Optional[NumberType] = None,
|
||||
header: typing.Optional[ComponentType] = None,
|
||||
icon: typing.Optional[str] = None,
|
||||
color: typing.Optional[str] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
header_style: typing.Optional[dict] = None,
|
||||
header_class_name: typing.Optional[str] = None,
|
||||
body_style: typing.Optional[dict] = None,
|
||||
body_class_name: typing.Optional[str] = None,
|
||||
tag: typing.Optional[str] = None,
|
||||
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
|
||||
persisted_props: typing.Optional[typing.Sequence[Literal["is_open"]]] = None,
|
||||
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
headerClassName: typing.Optional[str] = None,
|
||||
bodyClassName: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'is_open', 'dismissable', 'duration', 'n_dismiss', 'header', 'icon', 'color', 'style', 'class_name', 'header_style', 'header_class_name', 'body_style', 'body_class_name', 'tag', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'headerClassName', 'bodyClassName']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'is_open', 'dismissable', 'duration', 'n_dismiss', 'header', 'icon', 'color', 'style', 'class_name', 'header_style', 'header_class_name', 'body_style', 'body_class_name', 'tag', 'persistence', 'persisted_props', 'persistence_type', 'key', 'className', 'headerClassName', 'bodyClassName']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Toast, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Toast, "__init__", _explicitize_args(Toast.__init__))
|
||||
@ -0,0 +1,133 @@
|
||||
# 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 Tooltip(Component):
|
||||
"""A Tooltip component.
|
||||
A component for adding tooltips to any element, no callbacks required!
|
||||
|
||||
Simply add the Tooltip to you layout, and give it a target (id of a
|
||||
component to which the tooltip should be attached)
|
||||
|
||||
Keyword arguments:
|
||||
|
||||
- children (a list of or a singular dash component, string or number; optional):
|
||||
The children of this Tooltip.
|
||||
|
||||
- id (string; optional):
|
||||
The ID of the Tooltip.
|
||||
|
||||
- target (string | dict; optional):
|
||||
The id of the element to attach the tooltip to.
|
||||
|
||||
- is_open (boolean; optional):
|
||||
Whether the Tooltip is open or not.
|
||||
|
||||
- trigger (string; default 'hover focus'):
|
||||
Space separated list of triggers (e.g. \"click hover focus
|
||||
legacy\"). These specify ways in which the target component can
|
||||
toggle the tooltip. If omitted you must toggle the tooltip
|
||||
yourself using callbacks. Options are: - \"click\": toggles the
|
||||
popover when the target is clicked. - \"hover\": toggles the
|
||||
popover when the target is hovered over with the cursor. -
|
||||
\"focus\": toggles the popover when the target receives focus -
|
||||
\"legacy\": toggles the popover when the target is clicked, but
|
||||
will also dismiss the popover when the user clicks outside of the
|
||||
popover. Default is \"hover focus\".
|
||||
|
||||
- placement (a value equal to: 'auto', 'auto-start', 'auto-end', 'top', 'top-start', 'top-end', 'right', 'right-start', 'right-end', 'bottom', 'bottom-start', 'bottom-end', 'left', 'left-start', 'left-end'; default 'auto'):
|
||||
How to place the tooltip.
|
||||
|
||||
- delay (dict; default {show: 0, hide: 50}):
|
||||
Control the delay of hide and show events.
|
||||
|
||||
`delay` is a dict with keys:
|
||||
|
||||
- show (number; optional)
|
||||
|
||||
- hide (number; optional)
|
||||
|
||||
- flip (boolean; default True):
|
||||
Whether to flip the direction of the popover if too close to the
|
||||
container edge, default True.
|
||||
|
||||
- autohide (boolean; default True):
|
||||
Optionally hide tooltip when hovering over tooltip content -
|
||||
default True.
|
||||
|
||||
- fade (boolean; default True):
|
||||
If True, a fade animation will be applied when `is_open` is
|
||||
toggled. If False the Alert will simply appear and disappear.
|
||||
|
||||
- class_name (string; optional):
|
||||
Additional CSS classes to apply to the Tooltip.
|
||||
|
||||
- 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. Additional CSS classes
|
||||
to apply to the Tooltip."""
|
||||
_children_props = []
|
||||
_base_nodes = ['children']
|
||||
_namespace = 'dash_bootstrap_components'
|
||||
_type = 'Tooltip'
|
||||
Delay = TypedDict(
|
||||
"Delay",
|
||||
{
|
||||
"show": NotRequired[NumberType],
|
||||
"hide": NotRequired[NumberType]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
children: typing.Optional[ComponentType] = None,
|
||||
id: typing.Optional[typing.Union[str, dict]] = None,
|
||||
*,
|
||||
target: typing.Optional[typing.Union[str, dict]] = None,
|
||||
is_open: typing.Optional[bool] = None,
|
||||
trigger: typing.Optional[str] = None,
|
||||
placement: typing.Optional[Literal["auto", "auto-start", "auto-end", "top", "top-start", "top-end", "right", "right-start", "right-end", "bottom", "bottom-start", "bottom-end", "left", "left-start", "left-end"]] = None,
|
||||
delay: typing.Optional["Delay"] = None,
|
||||
flip: typing.Optional[bool] = None,
|
||||
autohide: typing.Optional[bool] = None,
|
||||
fade: typing.Optional[bool] = None,
|
||||
style: typing.Optional[typing.Any] = None,
|
||||
class_name: typing.Optional[str] = None,
|
||||
key: typing.Optional[str] = None,
|
||||
className: typing.Optional[str] = None,
|
||||
**kwargs
|
||||
):
|
||||
self._prop_names = ['children', 'id', 'target', 'is_open', 'trigger', 'placement', 'delay', 'flip', 'autohide', 'fade', 'style', 'class_name', 'key', 'className']
|
||||
self._valid_wildcard_attributes = []
|
||||
self.available_properties = ['children', 'id', 'target', 'is_open', 'trigger', 'placement', 'delay', 'flip', 'autohide', 'fade', 'style', 'class_name', 'key', 'className']
|
||||
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 if k != 'children'}
|
||||
|
||||
super(Tooltip, self).__init__(children=children, **args)
|
||||
|
||||
setattr(Tooltip, "__init__", _explicitize_args(Tooltip.__init__))
|
||||
@ -0,0 +1,135 @@
|
||||
from .Accordion import Accordion
|
||||
from .AccordionItem import AccordionItem
|
||||
from .Alert import Alert
|
||||
from .Badge import Badge
|
||||
from .Breadcrumb import Breadcrumb
|
||||
from .Button import Button
|
||||
from .ButtonGroup import ButtonGroup
|
||||
from .Card import Card
|
||||
from .CardBody import CardBody
|
||||
from .CardFooter import CardFooter
|
||||
from .CardGroup import CardGroup
|
||||
from .CardHeader import CardHeader
|
||||
from .CardImg import CardImg
|
||||
from .CardImgOverlay import CardImgOverlay
|
||||
from .CardLink import CardLink
|
||||
from .Carousel import Carousel
|
||||
from .Collapse import Collapse
|
||||
from .DropdownMenu import DropdownMenu
|
||||
from .DropdownMenuItem import DropdownMenuItem
|
||||
from .Fade import Fade
|
||||
from .Form import Form
|
||||
from .FormFeedback import FormFeedback
|
||||
from .FormFloating import FormFloating
|
||||
from .FormText import FormText
|
||||
from .Label import Label
|
||||
from .Checkbox import Checkbox
|
||||
from .Checklist import Checklist
|
||||
from .Input import Input
|
||||
from .InputGroup import InputGroup
|
||||
from .InputGroupText import InputGroupText
|
||||
from .RadioButton import RadioButton
|
||||
from .RadioItems import RadioItems
|
||||
from .Select import Select
|
||||
from .Switch import Switch
|
||||
from .Textarea import Textarea
|
||||
from .Col import Col
|
||||
from .Container import Container
|
||||
from .Row import Row
|
||||
from .Stack import Stack
|
||||
from .ListGroup import ListGroup
|
||||
from .ListGroupItem import ListGroupItem
|
||||
from .Modal import Modal
|
||||
from .ModalBody import ModalBody
|
||||
from .ModalFooter import ModalFooter
|
||||
from .ModalHeader import ModalHeader
|
||||
from .ModalTitle import ModalTitle
|
||||
from .Nav import Nav
|
||||
from .NavItem import NavItem
|
||||
from .NavLink import NavLink
|
||||
from .Navbar import Navbar
|
||||
from .NavbarBrand import NavbarBrand
|
||||
from .NavbarSimple import NavbarSimple
|
||||
from .NavbarToggler import NavbarToggler
|
||||
from .Offcanvas import Offcanvas
|
||||
from .Pagination import Pagination
|
||||
from .Placeholder import Placeholder
|
||||
from .Popover import Popover
|
||||
from .PopoverBody import PopoverBody
|
||||
from .PopoverHeader import PopoverHeader
|
||||
from .Progress import Progress
|
||||
from .Spinner import Spinner
|
||||
from .Table import Table
|
||||
from .Tab import Tab
|
||||
from .Tabs import Tabs
|
||||
from .Toast import Toast
|
||||
from .Tooltip import Tooltip
|
||||
|
||||
__all__ = [
|
||||
"Accordion",
|
||||
"AccordionItem",
|
||||
"Alert",
|
||||
"Badge",
|
||||
"Breadcrumb",
|
||||
"Button",
|
||||
"ButtonGroup",
|
||||
"Card",
|
||||
"CardBody",
|
||||
"CardFooter",
|
||||
"CardGroup",
|
||||
"CardHeader",
|
||||
"CardImg",
|
||||
"CardImgOverlay",
|
||||
"CardLink",
|
||||
"Carousel",
|
||||
"Collapse",
|
||||
"DropdownMenu",
|
||||
"DropdownMenuItem",
|
||||
"Fade",
|
||||
"Form",
|
||||
"FormFeedback",
|
||||
"FormFloating",
|
||||
"FormText",
|
||||
"Label",
|
||||
"Checkbox",
|
||||
"Checklist",
|
||||
"Input",
|
||||
"InputGroup",
|
||||
"InputGroupText",
|
||||
"RadioButton",
|
||||
"RadioItems",
|
||||
"Select",
|
||||
"Switch",
|
||||
"Textarea",
|
||||
"Col",
|
||||
"Container",
|
||||
"Row",
|
||||
"Stack",
|
||||
"ListGroup",
|
||||
"ListGroupItem",
|
||||
"Modal",
|
||||
"ModalBody",
|
||||
"ModalFooter",
|
||||
"ModalHeader",
|
||||
"ModalTitle",
|
||||
"Nav",
|
||||
"NavItem",
|
||||
"NavLink",
|
||||
"Navbar",
|
||||
"NavbarBrand",
|
||||
"NavbarSimple",
|
||||
"NavbarToggler",
|
||||
"Offcanvas",
|
||||
"Pagination",
|
||||
"Placeholder",
|
||||
"Popover",
|
||||
"PopoverBody",
|
||||
"PopoverHeader",
|
||||
"Progress",
|
||||
"Spinner",
|
||||
"Table",
|
||||
"Tab",
|
||||
"Tabs",
|
||||
"Toast",
|
||||
"Tooltip"
|
||||
]
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user