index
int64 0
731k
| package
stringlengths 2
98
⌀ | name
stringlengths 1
76
| docstring
stringlengths 0
281k
⌀ | code
stringlengths 4
1.07M
⌀ | signature
stringlengths 2
42.8k
⌀ |
|---|---|---|---|---|---|
60,543 |
dash_bootstrap_components._components.Breadcrumb
|
Breadcrumb
|
A Breadcrumb component.
Use breadcrumbs to create a navigation breadcrumb in your app.
Keyword arguments:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- itemClassName (string; optional):
**DEPRECATED** - use item_class_name instead. Class name ot apply
to each item.
- item_class_name (string; optional):
Class name to apply to each item.
- item_style (dict; optional):
Defines inline CSS styles that will be added to each item in the
breadcrumbs.
- items (list of dicts; optional):
The details of the items to render inside of this component.
`items` is a list of dicts with keys:
- active (boolean; optional):
Apply 'active' style to this component.
- external_link (boolean; optional):
If True, the browser will treat this as an external link,
forcing a page refresh at the new location. If False, this
just changes the location without triggering a page refresh.
Use this if you are observing dcc.Location, for instance.
Defaults to True for absolute URLs and False otherwise.
- href (string; optional):
URL of the resource to link to.
- label (string; optional):
Label to display inside the breadcrumbs.
- target (string; optional):
Target attribute to pass on to the link. Only applies to
external links.
- title (string; optional):
title attribute for the inner a element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (dict; optional):
HTML tag to use for the outer breadcrumb component. Default:
"nav".
|
class Breadcrumb(Component):
"""A Breadcrumb component.
Use breadcrumbs to create a navigation breadcrumb in your app.
Keyword arguments:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- itemClassName (string; optional):
**DEPRECATED** - use item_class_name instead. Class name ot apply
to each item.
- item_class_name (string; optional):
Class name to apply to each item.
- item_style (dict; optional):
Defines inline CSS styles that will be added to each item in the
breadcrumbs.
- items (list of dicts; optional):
The details of the items to render inside of this component.
`items` is a list of dicts with keys:
- active (boolean; optional):
Apply 'active' style to this component.
- external_link (boolean; optional):
If True, the browser will treat this as an external link,
forcing a page refresh at the new location. If False, this
just changes the location without triggering a page refresh.
Use this if you are observing dcc.Location, for instance.
Defaults to True for absolute URLs and False otherwise.
- href (string; optional):
URL of the resource to link to.
- label (string; optional):
Label to display inside the breadcrumbs.
- target (string; optional):
Target attribute to pass on to the link. Only applies to
external links.
- title (string; optional):
title attribute for the inner a element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, items=Component.UNDEFINED, style=Component.UNDEFINED, item_style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, item_class_name=Component.UNDEFINED, itemClassName=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'itemClassName', 'item_class_name', 'item_style', 'items', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'itemClassName', 'item_class_name', 'item_style', 'items', 'key', 'loading_state', 'style', '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)
|
(id=undefined, items=undefined, style=undefined, item_style=undefined, class_name=undefined, className=undefined, item_class_name=undefined, itemClassName=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,558 |
dash_bootstrap_components._components.Button
|
Button
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active (boolean; optional):
Whether button is in active state. Default: False.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Button color, options: primary, secondary, success, info, warning,
danger, link. Default: primary.
- disabled (boolean; optional):
Disable button (make unclickable). Default: False.
- download (string; optional):
Indicates that the hyperlink is to be used for downloading a
resource.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Pass a URL (relative or absolute) to make the menu entry a link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
Use of *_timestamp props has been deprecated in Dash in favour of
dash.callback_context. See "How do I determine which Input has
changed?" in the Dash FAQs https://dash.plot.ly/faqs. An integer
that represents the time (in ms since 1970) at which n_clicks
changed. This can be used to tell which button was changed most
recently.
- name (string; optional):
The name of the button, submitted as a pair with the button’s
value as part of the form data.
- outline (boolean; optional):
Set outline button style, which removes background images and
colors for a lightweight style.
- rel (string; optional):
Set the rel attribute when Button is being used as a Link.
- size (string; optional):
Button size, options: 'lg', 'md', 'sm'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to link if using Button as an external
link.
- title (string; optional):
Sets the title attribute of the underlying HTML button.
- 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".
- 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.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active (boolean; optional):
Whether button is in active state. Default: False.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Button color, options: primary, secondary, success, info, warning,
danger, link. Default: primary.
- disabled (boolean; optional):
Disable button (make unclickable). Default: False.
- download (string; optional):
Indicates that the hyperlink is to be used for downloading a
resource.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Pass a URL (relative or absolute) to make the menu entry a link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
Use of *_timestamp props has been deprecated in Dash in favour of
dash.callback_context. See \"How do I determine which Input has
changed?\" in the Dash FAQs https://dash.plot.ly/faqs. An integer
that represents the time (in ms since 1970) at which n_clicks
changed. This can be used to tell which button was changed most
recently.
- name (string; optional):
The name of the button, submitted as a pair with the button’s
value as part of the form data.
- outline (boolean; optional):
Set outline button style, which removes background images and
colors for a lightweight style.
- rel (string; optional):
Set the rel attribute when Button is being used as a Link.
- size (string; optional):
Button size, options: 'lg', 'md', 'sm'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to link if using Button as an external
link.
- title (string; optional):
Sets the title attribute of the underlying HTML button.
- 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\".
- 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Button'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, href=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, active=Component.UNDEFINED, color=Component.UNDEFINED, disabled=Component.UNDEFINED, size=Component.UNDEFINED, title=Component.UNDEFINED, outline=Component.UNDEFINED, loading_state=Component.UNDEFINED, target=Component.UNDEFINED, type=Component.UNDEFINED, download=Component.UNDEFINED, name=Component.UNDEFINED, value=Component.UNDEFINED, rel=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'active', 'className', 'class_name', 'color', 'disabled', 'download', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'name', 'outline', 'rel', 'size', 'style', 'target', 'title', 'type', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'active', 'className', 'class_name', 'color', 'disabled', 'download', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'name', 'outline', 'rel', 'size', 'style', 'target', 'title', 'type', 'value']
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)
|
(children=None, id=undefined, class_name=undefined, className=undefined, style=undefined, key=undefined, href=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, active=undefined, color=undefined, disabled=undefined, size=undefined, title=undefined, outline=undefined, loading_state=undefined, target=undefined, type=undefined, download=undefined, name=undefined, value=undefined, rel=undefined, **kwargs)
|
60,573 |
dash_bootstrap_components._components.ButtonGroup
|
ButtonGroup
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- size (string; optional):
Size of button group, options: 'sm', 'md', 'lg'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- vertical (boolean; optional):
Group buttons vertically.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- size (string; optional):
Size of button group, options: 'sm', 'md', 'lg'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- vertical (boolean; optional):
Group buttons vertically."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ButtonGroup'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, vertical=Component.UNDEFINED, size=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'size', 'style', 'vertical']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'size', 'style', 'vertical']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, vertical=undefined, size=undefined, loading_state=undefined, **kwargs)
|
60,588 |
dash_bootstrap_components._components.Card
|
Card
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- inverse (boolean; optional):
Invert text colours for use with a darker background.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- outline (boolean; optional):
Apply color styling to just the border of the card.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- inverse (boolean; optional):
Invert text colours for use with a darker background.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- outline (boolean; optional):
Apply color styling to just the border of the card.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Card'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, color=Component.UNDEFINED, body=Component.UNDEFINED, outline=Component.UNDEFINED, inverse=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'body', 'className', 'class_name', 'color', 'inverse', 'key', 'loading_state', 'outline', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'body', 'className', 'class_name', 'color', 'inverse', 'key', 'loading_state', 'outline', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, color=undefined, body=undefined, outline=undefined, inverse=undefined, loading_state=undefined, **kwargs)
|
60,603 |
dash_bootstrap_components._components.CardBody
|
CardBody
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card body, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card body, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardBody'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(CardBody, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,618 |
dash_bootstrap_components._components.CardFooter
|
CardFooter
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card footer, default: div.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card footer, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardFooter'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(CardFooter, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,633 |
dash_bootstrap_components._components.CardGroup
|
CardGroup
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card group, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card group, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardGroup'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(CardGroup, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,648 |
dash_bootstrap_components._components.CardHeader
|
CardHeader
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card header, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card header, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardHeader'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(CardHeader, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,663 |
dash_bootstrap_components._components.CardImg
|
CardImg
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- alt (string; optional):
Alternative text in case an image can't be displayed.
- bottom (boolean; optional):
Set to True if image is at bottom of card. This will apply the
card-img-bottom class which rounds the bottom corners to match the
corners of the card.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- src (string; optional):
The URI of the embeddable content.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card body, default: div.
- title (string; optional):
Text to be displayed as a tooltip when hovering.
- top (boolean; optional):
Set to True if image is at top of card. This will apply the
card-img-top class which rounds the top corners to match the
corners of the card.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- alt (string; optional):
Alternative text in case an image can't be displayed.
- bottom (boolean; optional):
Set to True if image is at bottom of card. This will apply the
card-img-bottom class which rounds the bottom corners to match the
corners of the card.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- src (string; optional):
The URI of the embeddable content.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card body, default: div.
- title (string; optional):
Text to be displayed as a tooltip when hovering.
- top (boolean; optional):
Set to True if image is at top of card. This will apply the
card-img-top class which rounds the top corners to match the
corners of the card."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardImg'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, top=Component.UNDEFINED, bottom=Component.UNDEFINED, src=Component.UNDEFINED, alt=Component.UNDEFINED, title=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'alt', 'bottom', 'className', 'class_name', 'key', 'loading_state', 'src', 'style', 'tag', 'title', 'top']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'alt', 'bottom', 'className', 'class_name', 'key', 'loading_state', 'src', 'style', 'tag', 'title', 'top']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, top=undefined, bottom=undefined, src=undefined, alt=undefined, title=undefined, loading_state=undefined, **kwargs)
|
60,678 |
dash_bootstrap_components._components.CardImgOverlay
|
CardImgOverlay
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card image overlay, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the card image overlay, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardImgOverlay'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(CardImgOverlay, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,693 |
dash_bootstrap_components._components.CardLink
|
CardLink
|
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:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
URL of the resource to link to.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
|
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:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
URL of the resource to link to.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'CardLink'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, href=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, loading_state=Component.UNDEFINED, target=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, href=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, loading_state=undefined, target=undefined, **kwargs)
|
60,708 |
dash_bootstrap_components._components.Carousel
|
Carousel
|
A Carousel component.
Component 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 component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_index (number; default 0):
The current visible slide number.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. efines the className of
the carousel container. Often used with CSS to style elements with
common properties.
- class_name (string; optional):
Defines the className of the carousel container. Often used with
CSS to style elements with common properties.
- 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.
- interval (number; optional):
the interval at which the carousel automatically cycles (default:
5000) If set to None, carousel will not Autoplay (i.e. will not
automatically cycle).
- items (list of dicts; required):
The items to display on the slides in the carousel.
`items` is a list of dicts with keys:
- alt (string; optional):
The alternate text for an image, if the image cannot be
displayed.
- caption (string; optional):
The caption of the item. The text is displayed in a <p>
element.
- captionClassName (string; optional):
**DEPRECATED** Use `caption_class_name` instead. The class
name for the header and caption container.
- caption_class_name (string; optional):
The class name for the header and caption container.
- external_link (boolean; optional):
If True, the browser will treat this as an external link,
forcing a page refresh at the new location. If False, this
just changes the location without triggering a page refresh.
Use this if you are observing dcc.Location, for instance.
Defaults to True for absolute URLs and False otherwise.
- header (string; optional):
The header of the text on the slide. It is displayed in a <h5>
element.
- 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.
- imgClassName (string; optional):
**DEPRECATED** Use `img_class_name` instead. The className
for the image. The default is 'd-block w-100'.
- img_class_name (string; optional):
The className for the image. The default is 'd-block w-100'.
- img_style (dict; optional):
The style for the image.
- key (string; optional):
A unique identifier for the slide, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- src (string; optional):
The URL of the image.
- target (string; optional):
Optional target attribute for the link. Only applies if `href`
is set, default `_self`.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_index's; default ['active_index']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- ride (a value equal to: 'carousel'; optional):
Autoplays the carousel after the user manually cycles the first
item. If "carousel", autoplays the carousel on load.
- slide (boolean; optional):
controls whether the slide animation on the Carousel works or not.
- style (dict; optional):
Defines CSS styles of the carousel container. Will override styles
previously set.
- variant (a value equal to: 'dark'; optional):
Add `variant="dark"` to the Carousel for darker controls,
indicators, and captions.
|
class Carousel(Component):
"""A Carousel component.
Component 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 component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_index (number; default 0):
The current visible slide number.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. efines the className of
the carousel container. Often used with CSS to style elements with
common properties.
- class_name (string; optional):
Defines the className of the carousel container. Often used with
CSS to style elements with common properties.
- 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.
- interval (number; optional):
the interval at which the carousel automatically cycles (default:
5000) If set to None, carousel will not Autoplay (i.e. will not
automatically cycle).
- items (list of dicts; required):
The items to display on the slides in the carousel.
`items` is a list of dicts with keys:
- alt (string; optional):
The alternate text for an image, if the image cannot be
displayed.
- caption (string; optional):
The caption of the item. The text is displayed in a <p>
element.
- captionClassName (string; optional):
**DEPRECATED** Use `caption_class_name` instead. The class
name for the header and caption container.
- caption_class_name (string; optional):
The class name for the header and caption container.
- external_link (boolean; optional):
If True, the browser will treat this as an external link,
forcing a page refresh at the new location. If False, this
just changes the location without triggering a page refresh.
Use this if you are observing dcc.Location, for instance.
Defaults to True for absolute URLs and False otherwise.
- header (string; optional):
The header of the text on the slide. It is displayed in a <h5>
element.
- 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.
- imgClassName (string; optional):
**DEPRECATED** Use `img_class_name` instead. The className
for the image. The default is 'd-block w-100'.
- img_class_name (string; optional):
The className for the image. The default is 'd-block w-100'.
- img_style (dict; optional):
The style for the image.
- key (string; optional):
A unique identifier for the slide, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- src (string; optional):
The URL of the image.
- target (string; optional):
Optional target attribute for the link. Only applies if `href`
is set, default `_self`.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_index's; default ['active_index']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- ride (a value equal to: 'carousel'; optional):
Autoplays the carousel after the user manually cycles the first
item. If \"carousel\", autoplays the carousel on load.
- slide (boolean; optional):
controls whether the slide animation on the Carousel works or not.
- style (dict; optional):
Defines CSS styles of the carousel container. Will override styles
previously set.
- variant (a value equal to: 'dark'; optional):
Add `variant=\"dark\"` to the Carousel for darker controls,
indicators, and captions."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Carousel'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, items=Component.REQUIRED, active_index=Component.UNDEFINED, controls=Component.UNDEFINED, indicators=Component.UNDEFINED, ride=Component.UNDEFINED, slide=Component.UNDEFINED, variant=Component.UNDEFINED, interval=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'active_index', 'className', 'class_name', 'controls', 'indicators', 'interval', 'items', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'ride', 'slide', 'style', 'variant']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'active_index', 'className', 'class_name', 'controls', 'indicators', 'interval', 'items', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'ride', 'slide', 'style', 'variant']
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)
|
(id=undefined, style=undefined, class_name=undefined, className=undefined, items=required, active_index=undefined, controls=undefined, indicators=undefined, ride=undefined, slide=undefined, variant=undefined, interval=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
60,723 |
dash_bootstrap_components._components.Checkbox
|
Checkbox
|
A Checkbox 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the Checkbox.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input.
|
class Checkbox(Component):
"""A Checkbox 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the Checkbox.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input."""
_children_props = ['label']
_base_nodes = ['label', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'Checkbox'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, input_style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, input_class_name=Component.UNDEFINED, inputClassName=Component.UNDEFINED, label=Component.UNDEFINED, label_id=Component.UNDEFINED, label_style=Component.UNDEFINED, labelStyle=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, name=Component.UNDEFINED, disabled=Component.UNDEFINED, value=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
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)
|
(id=undefined, class_name=undefined, className=undefined, style=undefined, input_style=undefined, inputStyle=undefined, input_class_name=undefined, inputClassName=undefined, label=undefined, label_id=undefined, label_style=undefined, labelStyle=undefined, label_class_name=undefined, labelClassName=undefined, name=undefined, disabled=undefined, value=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
60,738 |
dash_bootstrap_components._components.Checklist
|
Checklist
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- inline (boolean; optional):
Arrange Checklist inline.
- 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.
- inputCheckedStyle (dict; optional):
**DEPRECATED** Use `input_checked_style` instead. Additional
inline style arguments to apply to <input> elements on checked
items.
- inputClassName (string; default ''):
**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.
- input_checked_class_name (string; optional):
Additional CSS classes to apply to the <input> element when the
corresponding checkbox is checked.
- input_checked_style (dict; optional):
Additional inline style arguments to apply to <input> elements on
checked items.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- labelCheckedStyle (dict; optional):
**DEPRECATED** Use `label_checked_style` instead. Additional
inline style arguments to apply to <label> elements on checked
items.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_checked_class_name (string; optional):
Additional CSS classes to apply to the <label> element when the
corresponding checkbox is checked.
- label_checked_style (dict; optional):
Additional inline style arguments to apply to <label> elements on
checked items.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- options (list of dicts; optional):
The options to display as items in the component. This can be an
array or a dictionary as follows:
1. Array of options where the
label and the value are the same thing - [string|number]
2. An
array of options ``` { "label": [string|number], "value":
[string|number], "disabled": [bool] (Optional),
"input_id": [string] (Optional), "label_id": [string]
(Optional) } ```
3. 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:
- 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 (a list of or a singular dash component, string or number; required):
The checkbox's label.
- label_id (string; optional):
id for this option's label, can be used to attach tooltips or
apply CSS styles.
- value (string | number; required):
The value of the checkbox. This value corresponds to the items
specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- switch (boolean; optional):
Set to True to render toggle-like switches instead of checkboxes.
- value (list of string | numbers; optional):
The currently selected value.
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- inline (boolean; optional):
Arrange Checklist inline.
- 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.
- inputCheckedStyle (dict; optional):
**DEPRECATED** Use `input_checked_style` instead. Additional
inline style arguments to apply to <input> elements on checked
items.
- inputClassName (string; default ''):
**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.
- input_checked_class_name (string; optional):
Additional CSS classes to apply to the <input> element when the
corresponding checkbox is checked.
- input_checked_style (dict; optional):
Additional inline style arguments to apply to <input> elements on
checked items.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- labelCheckedStyle (dict; optional):
**DEPRECATED** Use `label_checked_style` instead. Additional
inline style arguments to apply to <label> elements on checked
items.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_checked_class_name (string; optional):
Additional CSS classes to apply to the <label> element when the
corresponding checkbox is checked.
- label_checked_style (dict; optional):
Additional inline style arguments to apply to <label> elements on
checked items.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- 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:
- 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 (a list of or a singular dash component, string or number; required):
The checkbox's label.
- label_id (string; optional):
id for this option's label, can be used to attach tooltips or
apply CSS styles.
- value (string | number; required):
The value of the checkbox. This value corresponds to the items
specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- switch (boolean; optional):
Set to True to render toggle-like switches instead of checkboxes.
- value (list of string | numbers; optional):
The currently selected value."""
_children_props = ['options[].label']
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Checklist'
@_explicitize_args
def __init__(self, options=Component.UNDEFINED, value=Component.UNDEFINED, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, input_style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, input_checked_style=Component.UNDEFINED, inputCheckedStyle=Component.UNDEFINED, input_class_name=Component.UNDEFINED, inputClassName=Component.UNDEFINED, input_checked_class_name=Component.UNDEFINED, inputCheckedClassName=Component.UNDEFINED, label_style=Component.UNDEFINED, labelStyle=Component.UNDEFINED, label_checked_style=Component.UNDEFINED, labelCheckedStyle=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, label_checked_class_name=Component.UNDEFINED, labelCheckedClassName=Component.UNDEFINED, inline=Component.UNDEFINED, switch=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, name=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'inline', 'inputCheckedClassName', 'inputCheckedStyle', 'inputClassName', 'inputStyle', 'input_checked_class_name', 'input_checked_style', 'input_class_name', 'input_style', 'key', 'labelCheckedClassName', 'labelCheckedStyle', 'labelClassName', 'labelStyle', 'label_checked_class_name', 'label_checked_style', 'label_class_name', 'label_style', 'loading_state', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'style', 'switch', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'inline', 'inputCheckedClassName', 'inputCheckedStyle', 'inputClassName', 'inputStyle', 'input_checked_class_name', 'input_checked_style', 'input_class_name', 'input_style', 'key', 'labelCheckedClassName', 'labelCheckedStyle', 'labelClassName', 'labelStyle', 'label_checked_class_name', 'label_checked_style', 'label_class_name', 'label_style', 'loading_state', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'style', 'switch', 'value']
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)
|
(options=undefined, value=undefined, id=undefined, class_name=undefined, className=undefined, style=undefined, key=undefined, input_style=undefined, inputStyle=undefined, input_checked_style=undefined, inputCheckedStyle=undefined, input_class_name=undefined, inputClassName=undefined, input_checked_class_name=undefined, inputCheckedClassName=undefined, label_style=undefined, labelStyle=undefined, label_checked_style=undefined, labelCheckedStyle=undefined, label_class_name=undefined, labelClassName=undefined, label_checked_class_name=undefined, labelCheckedClassName=undefined, inline=undefined, switch=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, name=undefined, **kwargs)
|
60,753 |
dash_bootstrap_components._components.Col
|
Col
|
A Col component.
Component 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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- 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.
- 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.
- 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.
|
class Col(Component):
"""A Col component.
Component 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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- 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.
- 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.
- 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Col'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, width=Component.UNDEFINED, xs=Component.UNDEFINED, sm=Component.UNDEFINED, md=Component.UNDEFINED, lg=Component.UNDEFINED, xl=Component.UNDEFINED, xxl=Component.UNDEFINED, align=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'align', 'className', 'class_name', 'key', 'lg', 'loading_state', 'md', 'sm', 'style', 'width', 'xl', 'xs', 'xxl']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'align', 'className', 'class_name', 'key', 'lg', 'loading_state', 'md', 'sm', 'style', 'width', 'xl', 'xs', 'xxl']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, width=undefined, xs=undefined, sm=undefined, md=undefined, lg=undefined, xl=undefined, xxl=undefined, align=undefined, loading_state=undefined, **kwargs)
|
60,768 |
dash_bootstrap_components._components.Collapse
|
Collapse
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- is_open (boolean; optional):
Whether collapse is currently open.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- navbar (boolean; optional):
Set to True when using a collapse inside a navbar.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- is_open (boolean; optional):
Whether collapse is currently open.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- navbar (boolean; optional):
Set to True when using a collapse inside a navbar.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Collapse'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, is_open=Component.UNDEFINED, navbar=Component.UNDEFINED, loading_state=Component.UNDEFINED, dimension=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'dimension', 'is_open', 'key', 'loading_state', 'navbar', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'dimension', 'is_open', 'key', 'loading_state', 'navbar', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, is_open=undefined, navbar=undefined, loading_state=undefined, dimension=undefined, **kwargs)
|
60,783 |
dash_bootstrap_components._components.Container
|
Container
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to apply the container class to, default: div.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to apply the container class to, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Container'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, fluid=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'fluid', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'fluid', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(Container, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, fluid=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,798 |
dash_bootstrap_components._components.DropdownMenu
|
DropdownMenu
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- addon_type (boolean | a value equal to: 'prepend', 'append'; optional):
Set this to 'prepend' or 'append' if the DropdownMenu is being
used in an input group.
- align_end (boolean; optional):
Align the DropdownMenu along the right side of its parent.
Default: False.
- caret (boolean; default True):
Add a caret to the DropdownMenu toggle. Default: True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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', 'end', 'up', 'left', 'right', 'end'; optional):
Direction in which to expand the DropdownMenu. Default: 'down'.
`left` and `right` have been deprecated, and `start` and `end`
should be used instead.
- disabled (boolean; default False):
Disable the dropdown.
- group (boolean; optional):
Set group to True if the DropdownMenu is inside a ButtonGroup.
- in_navbar (boolean; optional):
Set this to True if the DropdownMenu is inside a navbar. Default:
False.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (a list of or a singular dash component, string or number; optional):
Label for the DropdownMenu toggle.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- menu_variant (a value equal to: 'light', 'dark'; default 'light'):
Set `menu_variant="dark"` to create a dark-mode drop down
instead.
- nav (boolean; optional):
Set this to True if the DropdownMenu is inside a nav for styling
consistent with other nav items. Default: False.
- right (boolean; optional):
**DEPRECATED** Use `align_end` instead. Align the DropdownMenu
along the right side of its parent. Default: False.
- size (a value equal to: 'sm', 'md', 'lg'; optional):
Size of the DropdownMenu. 'sm' corresponds to small, 'md' to
medium and 'lg' to large.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- toggleClassName (string; optional):
**DEPRECATED** Use `toggle_class_name` instead. Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the DropdownMenu
toggle.
- toggle_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the
DropdownMenu toggle.
- toggle_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the DropdownMenu toggle.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- addon_type (boolean | a value equal to: 'prepend', 'append'; optional):
Set this to 'prepend' or 'append' if the DropdownMenu is being
used in an input group.
- align_end (boolean; optional):
Align the DropdownMenu along the right side of its parent.
Default: False.
- caret (boolean; default True):
Add a caret to the DropdownMenu toggle. Default: True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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', 'end', 'up', 'left', 'right', 'end'; optional):
Direction in which to expand the DropdownMenu. Default: 'down'.
`left` and `right` have been deprecated, and `start` and `end`
should be used instead.
- disabled (boolean; default False):
Disable the dropdown.
- group (boolean; optional):
Set group to True if the DropdownMenu is inside a ButtonGroup.
- in_navbar (boolean; optional):
Set this to True if the DropdownMenu is inside a navbar. Default:
False.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (a list of or a singular dash component, string or number; optional):
Label for the DropdownMenu toggle.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- menu_variant (a value equal to: 'light', 'dark'; default 'light'):
Set `menu_variant=\"dark\"` to create a dark-mode drop down
instead.
- nav (boolean; optional):
Set this to True if the DropdownMenu is inside a nav for styling
consistent with other nav items. Default: False.
- right (boolean; optional):
**DEPRECATED** Use `align_end` instead. Align the DropdownMenu
along the right side of its parent. Default: False.
- size (a value equal to: 'sm', 'md', 'lg'; optional):
Size of the DropdownMenu. 'sm' corresponds to small, 'md' to
medium and 'lg' to large.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- toggleClassName (string; optional):
**DEPRECATED** Use `toggle_class_name` instead. Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the DropdownMenu
toggle.
- toggle_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the
DropdownMenu toggle.
- toggle_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the DropdownMenu toggle."""
_children_props = ['label']
_base_nodes = ['label', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'DropdownMenu'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, label=Component.UNDEFINED, direction=Component.UNDEFINED, align_end=Component.UNDEFINED, right=Component.UNDEFINED, in_navbar=Component.UNDEFINED, addon_type=Component.UNDEFINED, disabled=Component.UNDEFINED, nav=Component.UNDEFINED, caret=Component.UNDEFINED, color=Component.UNDEFINED, menu_variant=Component.UNDEFINED, toggle_style=Component.UNDEFINED, toggle_class_name=Component.UNDEFINED, toggleClassName=Component.UNDEFINED, size=Component.UNDEFINED, loading_state=Component.UNDEFINED, group=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'addon_type', 'align_end', 'caret', 'className', 'class_name', 'color', 'direction', 'disabled', 'group', 'in_navbar', 'key', 'label', 'loading_state', 'menu_variant', 'nav', 'right', 'size', 'style', 'toggleClassName', 'toggle_class_name', 'toggle_style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'addon_type', 'align_end', 'caret', 'className', 'class_name', 'color', 'direction', 'disabled', 'group', 'in_navbar', 'key', 'label', 'loading_state', 'menu_variant', 'nav', 'right', 'size', 'style', 'toggleClassName', 'toggle_class_name', 'toggle_style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, label=undefined, direction=undefined, align_end=undefined, right=undefined, in_navbar=undefined, addon_type=undefined, disabled=undefined, nav=undefined, caret=undefined, color=undefined, menu_variant=undefined, toggle_style=undefined, toggle_class_name=undefined, toggleClassName=undefined, size=undefined, loading_state=undefined, group=undefined, **kwargs)
|
60,813 |
dash_bootstrap_components._components.DropdownMenuItem
|
DropdownMenuItem
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active (boolean; optional):
Style this item as 'active'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- header (boolean; optional):
Set to True if this is a header, rather than a conventional menu
item.
- href (string; optional):
Pass a URL (relative or absolute) to make the menu entry a link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
- toggle (boolean; default True):
Whether to toggle the DropdownMenu on click. Default: True.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active (boolean; optional):
Style this item as 'active'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- header (boolean; optional):
Set to True if this is a header, rather than a conventional menu
item.
- href (string; optional):
Pass a URL (relative or absolute) to make the menu entry a link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
- toggle (boolean; default True):
Whether to toggle the DropdownMenu on click. Default: True."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'DropdownMenuItem'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, active=Component.UNDEFINED, disabled=Component.UNDEFINED, divider=Component.UNDEFINED, header=Component.UNDEFINED, href=Component.UNDEFINED, toggle=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, loading_state=Component.UNDEFINED, target=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'active', 'className', 'class_name', 'disabled', 'divider', 'external_link', 'header', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target', 'toggle']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'active', 'className', 'class_name', 'disabled', 'divider', 'external_link', 'header', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target', 'toggle']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, active=undefined, disabled=undefined, divider=undefined, header=undefined, href=undefined, toggle=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, loading_state=undefined, target=undefined, **kwargs)
|
60,828 |
dash_bootstrap_components._components.Fade
|
Fade
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- appear (boolean; optional):
Show fade-in animation on initial page load. Default: True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- enter (boolean; optional):
Enable or disable enter transitions. Default: True.
- exit (boolean; optional):
Enable or disable exit transitions. Default: True.
- is_in (boolean; optional):
Controls whether the children of the Fade component are currently
visible or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the fade component. Default: div.
- 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)
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- appear (boolean; optional):
Show fade-in animation on initial page load. Default: True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- enter (boolean; optional):
Enable or disable enter transitions. Default: True.
- exit (boolean; optional):
Enable or disable exit transitions. Default: True.
- is_in (boolean; optional):
Controls whether the children of the Fade component are currently
visible or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the fade component. Default: div.
- 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)"""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Fade'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, is_in=Component.UNDEFINED, timeout=Component.UNDEFINED, appear=Component.UNDEFINED, enter=Component.UNDEFINED, exit=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'appear', 'className', 'class_name', 'enter', 'exit', 'is_in', 'key', 'loading_state', 'style', 'tag', 'timeout']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'appear', 'className', 'class_name', 'enter', 'exit', 'is_in', 'key', 'loading_state', 'style', 'tag', 'timeout']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, is_in=undefined, timeout=undefined, appear=undefined, enter=undefined, exit=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
60,843 |
dash_bootstrap_components._components.Form
|
Form
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- action (string; optional):
The URI of a program that processes the information submitted via
the form.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- method (a value equal to: 'GET', 'POST'; optional):
Defines which HTTP method to use when submitting the form. Can be
GET (default) or POST.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the input had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- prevent_default_on_submit (boolean; default True):
The form calls preventDefault on submit events. If you want form
data to be posted to the endpoint specified by `action` on submit
events, set prevent_default_on_submit to False. Defaults to True.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- action (string; optional):
The URI of a program that processes the information submitted via
the form.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- method (a value equal to: 'GET', 'POST'; optional):
Defines which HTTP method to use when submitting the form. Can be
GET (default) or POST.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the input had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- prevent_default_on_submit (boolean; default True):
The form calls preventDefault on submit events. If you want form
data to be posted to the endpoint specified by `action` on submit
events, set prevent_default_on_submit to False. Defaults to True.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Form'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, action=Component.UNDEFINED, method=Component.UNDEFINED, n_submit=Component.UNDEFINED, n_submit_timestamp=Component.UNDEFINED, prevent_default_on_submit=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'action', 'className', 'class_name', 'key', 'loading_state', 'method', 'n_submit', 'n_submit_timestamp', 'prevent_default_on_submit', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'action', 'className', 'class_name', 'key', 'loading_state', 'method', 'n_submit', 'n_submit_timestamp', 'prevent_default_on_submit', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, action=undefined, method=undefined, n_submit=undefined, n_submit_timestamp=undefined, prevent_default_on_submit=undefined, loading_state=undefined, **kwargs)
|
60,858 |
dash_bootstrap_components._components.FormFeedback
|
FormFeedback
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tooltip (boolean; optional):
Use styled tooltips to display validation feedback.
- type (string; optional):
Either 'valid' or 'invalid'.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tooltip (boolean; optional):
Use styled tooltips to display validation feedback.
- type (string; optional):
Either 'valid' or 'invalid'."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'FormFeedback'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, type=Component.UNDEFINED, tooltip=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tooltip', 'type']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tooltip', 'type']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, type=undefined, tooltip=undefined, loading_state=undefined, **kwargs)
|
60,873 |
dash_bootstrap_components._components.FormFloating
|
FormFloating
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- html_for (string; optional):
Set the `for` attribute of the label to bind it to a particular
element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- html_for (string; optional):
Set the `for` attribute of the label to bind it to a particular
element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'FormFloating'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, html_for=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'html_for', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'html_for', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, html_for=undefined, loading_state=undefined, **kwargs)
|
60,888 |
dash_bootstrap_components._components.FormText
|
FormText
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'FormText'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, color=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'color', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'color', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, color=undefined, loading_state=undefined, **kwargs)
|
60,903 |
dash_bootstrap_components._components.Input
|
Input
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- debounce (boolean; default False):
If True, changes to input will be sent back to the Dash server
only when the enter key is pressed or when the component loses
focus. If it's False, it will sent the value back on every
change.
- disabled (boolean; optional):
Set to True to disable the Input.
- 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.
- 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.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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):
**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.
- 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):
**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.
- 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.
- n_blur (number; default 0):
Number of times the input lost focus.
- n_blur_timestamp (number; default -1):
Last time the input lost focus.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the input had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- 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.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- 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.
- 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.
- 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.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tabIndex (string; optional):
**DEPRECATED** Use `tabindex` instead. Overrides the browser's
default tab order and follows the one specified instead.
- tabindex (string; optional):
Overrides the browser's default tab order and follows the one
specified instead.
- type (a value equal to: "text", 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden'; optional):
The type of control to render.
- 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.
- value (string | number; optional):
The value of the Input.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- debounce (boolean; default False):
If True, changes to input will be sent back to the Dash server
only when the enter key is pressed or when the component loses
focus. If it's False, it will sent the value back on every
change.
- disabled (boolean; optional):
Set to True to disable the Input.
- 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.
- 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.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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):
**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.
- 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):
**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.
- 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.
- n_blur (number; default 0):
Number of times the input lost focus.
- n_blur_timestamp (number; default -1):
Last time the input lost focus.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the input had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- 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.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- 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.
- 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.
- 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.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tabIndex (string; optional):
**DEPRECATED** Use `tabindex` instead. Overrides the browser's
default tab order and follows the one specified instead.
- tabindex (string; optional):
Overrides the browser's default tab order and follows the one
specified instead.
- type (a value equal to: "text", 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden'; optional):
The type of control to render.
- 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.
- value (string | number; optional):
The value of the Input."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Input'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, type=Component.UNDEFINED, value=Component.UNDEFINED, disabled=Component.UNDEFINED, autocomplete=Component.UNDEFINED, autoComplete=Component.UNDEFINED, autofocus=Component.UNDEFINED, autoFocus=Component.UNDEFINED, inputmode=Component.UNDEFINED, inputMode=Component.UNDEFINED, list=Component.UNDEFINED, max=Component.UNDEFINED, maxlength=Component.UNDEFINED, maxLength=Component.UNDEFINED, min=Component.UNDEFINED, minlength=Component.UNDEFINED, minLength=Component.UNDEFINED, step=Component.UNDEFINED, html_size=Component.UNDEFINED, size=Component.UNDEFINED, valid=Component.UNDEFINED, invalid=Component.UNDEFINED, required=Component.UNDEFINED, plaintext=Component.UNDEFINED, readonly=Component.UNDEFINED, placeholder=Component.UNDEFINED, name=Component.UNDEFINED, pattern=Component.UNDEFINED, n_submit=Component.UNDEFINED, n_submit_timestamp=Component.UNDEFINED, n_blur=Component.UNDEFINED, n_blur_timestamp=Component.UNDEFINED, debounce=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, tabindex=Component.UNDEFINED, tabIndex=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'autoComplete', 'autoFocus', 'autocomplete', 'autofocus', 'className', 'class_name', 'debounce', 'disabled', 'html_size', 'inputMode', 'inputmode', 'invalid', 'key', 'list', 'loading_state', 'max', 'maxLength', 'maxlength', 'min', 'minLength', 'minlength', 'n_blur', 'n_blur_timestamp', 'n_submit', 'n_submit_timestamp', 'name', 'pattern', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'plaintext', 'readonly', 'required', 'size', 'step', 'style', 'tabIndex', 'tabindex', 'type', 'valid', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'autoComplete', 'autoFocus', 'autocomplete', 'autofocus', 'className', 'class_name', 'debounce', 'disabled', 'html_size', 'inputMode', 'inputmode', 'invalid', 'key', 'list', 'loading_state', 'max', 'maxLength', 'maxlength', 'min', 'minLength', 'minlength', 'n_blur', 'n_blur_timestamp', 'n_submit', 'n_submit_timestamp', 'name', 'pattern', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'plaintext', 'readonly', 'required', 'size', 'step', 'style', 'tabIndex', 'tabindex', 'type', 'valid', 'value']
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)
|
(id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, type=undefined, value=undefined, disabled=undefined, autocomplete=undefined, autoComplete=undefined, autofocus=undefined, autoFocus=undefined, inputmode=undefined, inputMode=undefined, list=undefined, max=undefined, maxlength=undefined, maxLength=undefined, min=undefined, minlength=undefined, minLength=undefined, step=undefined, html_size=undefined, size=undefined, valid=undefined, invalid=undefined, required=undefined, plaintext=undefined, readonly=undefined, placeholder=undefined, name=undefined, pattern=undefined, n_submit=undefined, n_submit_timestamp=undefined, n_blur=undefined, n_blur_timestamp=undefined, debounce=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, tabindex=undefined, tabIndex=undefined, **kwargs)
|
60,918 |
dash_bootstrap_components._components.InputGroup
|
InputGroup
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'InputGroup'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, size=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'size', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'size', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, size=undefined, loading_state=undefined, **kwargs)
|
60,933 |
dash_bootstrap_components._components.InputGroupText
|
InputGroupText
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'InputGroupText'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, key=undefined, class_name=undefined, className=undefined, loading_state=undefined, **kwargs)
|
60,948 |
dash_bootstrap_components._components.Label
|
Label
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- align (a value equal to: 'start', 'center', 'end'; default 'center'):
Set vertical alignment of the label, options: 'start', 'center',
'end', default: 'center'.
- check (boolean; optional):
Set to True when using to label a Checkbox or RadioButton.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- hidden (boolean; optional):
Hide label from UI, but allow it to be discovered by
screen-readers.
- html_for (string; optional):
Set the `for` attribute of the label to bind it to a particular
element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- size (string; optional):
Set size of label. Options 'sm', 'md' (default) or 'lg'.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- width (optional):
Specify width of label for use in grid layouts. Accepts the same
values as the Col component.
- 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.
- 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.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- align (a value equal to: 'start', 'center', 'end'; default 'center'):
Set vertical alignment of the label, options: 'start', 'center',
'end', default: 'center'.
- check (boolean; optional):
Set to True when using to label a Checkbox or RadioButton.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- hidden (boolean; optional):
Hide label from UI, but allow it to be discovered by
screen-readers.
- html_for (string; optional):
Set the `for` attribute of the label to bind it to a particular
element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- size (string; optional):
Set size of label. Options 'sm', 'md' (default) or 'lg'.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- width (optional):
Specify width of label for use in grid layouts. Accepts the same
values as the Col component.
- 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.
- 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Label'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, hidden=Component.UNDEFINED, size=Component.UNDEFINED, html_for=Component.UNDEFINED, check=Component.UNDEFINED, width=Component.UNDEFINED, xs=Component.UNDEFINED, sm=Component.UNDEFINED, md=Component.UNDEFINED, lg=Component.UNDEFINED, xl=Component.UNDEFINED, align=Component.UNDEFINED, color=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'align', 'check', 'className', 'class_name', 'color', 'hidden', 'html_for', 'key', 'lg', 'loading_state', 'md', 'size', 'sm', 'style', 'width', 'xl', 'xs']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'align', 'check', 'className', 'class_name', 'color', 'hidden', 'html_for', 'key', 'lg', 'loading_state', 'md', 'size', 'sm', 'style', 'width', 'xl', 'xs']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, hidden=undefined, size=undefined, html_for=undefined, check=undefined, width=undefined, xs=undefined, sm=undefined, md=undefined, lg=undefined, xl=undefined, align=undefined, color=undefined, loading_state=undefined, **kwargs)
|
60,963 |
dash_bootstrap_components._components.ListGroup
|
ListGroup
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- numbered (boolean; default False):
Generate numbered list items.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; default 'ul'):
HTML tag to use for the list, default: ul.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- numbered (boolean; default False):
Generate numbered list items.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; default 'ul'):
HTML tag to use for the list, default: ul."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ListGroup'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, flush=Component.UNDEFINED, loading_state=Component.UNDEFINED, horizontal=Component.UNDEFINED, numbered=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'flush', 'horizontal', 'key', 'loading_state', 'numbered', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'flush', 'horizontal', 'key', 'loading_state', 'numbered', 'style', '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 if k != 'children'}
super(ListGroup, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, flush=undefined, loading_state=undefined, horizontal=undefined, numbered=undefined, **kwargs)
|
60,978 |
dash_bootstrap_components._components.ListGroupItem
|
ListGroupItem
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- action (boolean; optional):
Apply list-group-item-action class for hover animation etc.
- active (boolean; optional):
Apply active style to item.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- disabled (boolean; optional):
Apply disabled style to item.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Pass a URL (relative or absolute) to make the list group item a
link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the listgroupitem, default: li.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- action (boolean; optional):
Apply list-group-item-action class for hover animation etc.
- active (boolean; optional):
Apply active style to item.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- disabled (boolean; optional):
Apply disabled style to item.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Pass a URL (relative or absolute) to make the list group item a
link.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the listgroupitem, default: li.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ListGroupItem'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, active=Component.UNDEFINED, disabled=Component.UNDEFINED, color=Component.UNDEFINED, action=Component.UNDEFINED, href=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, loading_state=Component.UNDEFINED, target=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'action', 'active', 'className', 'class_name', 'color', 'disabled', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'tag', 'target']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'action', 'active', 'className', 'class_name', 'color', 'disabled', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'tag', 'target']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, active=undefined, disabled=undefined, color=undefined, action=undefined, href=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, loading_state=undefined, target=undefined, **kwargs)
|
60,993 |
dash_bootstrap_components._components.Modal
|
Modal
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autoFocus (boolean; optional):
**DEPRECATED** Use `autofocus` instead Puts the focus on
the modal when initialized.
- autofocus (boolean; optional):
Puts the focus on the modal when initialized.
- 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.
- backdropClassName (string; optional):
**DEPRECATED** Use `backdrop_class_name` instead CSS class to
apply to the backdrop.
- backdrop_class_name (string; optional):
CSS class to apply to the backdrop.
- centered (boolean; optional):
If True, vertically center modal on page.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- contentClassName (string; optional):
**DEPRECATED** Use `content_class_name` instead CSS class to
apply to the modal content.
- content_class_name (string; optional):
CSS class to apply to the modal content.
- enforceFocus (boolean; optional):
When True The modal will prevent focus from leaving the Modal
while open.
- fade (boolean; optional):
Set to False for a modal that simply appears rather than fades
into view.
- fullscreen (a value equal to: PropTypes.bool, PropTypes.oneOf(['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.
- is_open (boolean; optional):
Whether modal is currently open.
- keyboard (boolean; optional):
Close the modal when escape key is pressed.
- labelledBy (string; optional):
**DEPRECATED** Use `labelledby` instead The ARIA labelledby
attribute.
- labelledby (string; optional):
The ARIA labelledby attribute.
- modalClassName (string; optional):
**DEPRECATED** Use `modal_class_name` instead CSS class to apply
to the modal.
- modal_class_name (string; optional):
CSS class to apply to the modal.
- role (string; optional):
The ARIA role attribute.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Modal, default: div.
- zIndex (number | string; optional):
**DEPRECATED** Use `zindex` instead Set the z-index of the modal.
Default 1050.
- zindex (number | string; optional):
Set the z-index of the modal. Default 1050.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autoFocus (boolean; optional):
**DEPRECATED** Use `autofocus` instead Puts the focus on
the modal when initialized.
- autofocus (boolean; optional):
Puts the focus on the modal when initialized.
- 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.
- backdropClassName (string; optional):
**DEPRECATED** Use `backdrop_class_name` instead CSS class to
apply to the backdrop.
- backdrop_class_name (string; optional):
CSS class to apply to the backdrop.
- centered (boolean; optional):
If True, vertically center modal on page.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- contentClassName (string; optional):
**DEPRECATED** Use `content_class_name` instead CSS class to
apply to the modal content.
- content_class_name (string; optional):
CSS class to apply to the modal content.
- enforceFocus (boolean; optional):
When True The modal will prevent focus from leaving the Modal
while open.
- fade (boolean; optional):
Set to False for a modal that simply appears rather than fades
into view.
- fullscreen (a value equal to: PropTypes.bool, PropTypes.oneOf(['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.
- is_open (boolean; optional):
Whether modal is currently open.
- keyboard (boolean; optional):
Close the modal when escape key is pressed.
- labelledBy (string; optional):
**DEPRECATED** Use `labelledby` instead The ARIA labelledby
attribute.
- labelledby (string; optional):
The ARIA labelledby attribute.
- modalClassName (string; optional):
**DEPRECATED** Use `modal_class_name` instead CSS class to apply
to the modal.
- modal_class_name (string; optional):
CSS class to apply to the modal.
- role (string; optional):
The ARIA role attribute.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Modal, default: div.
- zIndex (number | string; optional):
**DEPRECATED** Use `zindex` instead Set the z-index of the modal.
Default 1050.
- zindex (number | string; optional):
Set the z-index of the modal. Default 1050."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Modal'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, tag=Component.UNDEFINED, is_open=Component.UNDEFINED, centered=Component.UNDEFINED, scrollable=Component.UNDEFINED, autofocus=Component.UNDEFINED, autoFocus=Component.UNDEFINED, enforceFocus=Component.UNDEFINED, size=Component.UNDEFINED, role=Component.UNDEFINED, labelledby=Component.UNDEFINED, labelledBy=Component.UNDEFINED, keyboard=Component.UNDEFINED, backdrop=Component.UNDEFINED, modal_class_name=Component.UNDEFINED, modalClassName=Component.UNDEFINED, backdrop_class_name=Component.UNDEFINED, backdropClassName=Component.UNDEFINED, content_class_name=Component.UNDEFINED, contentClassName=Component.UNDEFINED, fade=Component.UNDEFINED, fullscreen=Component.UNDEFINED, zindex=Component.UNDEFINED, zIndex=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'autoFocus', 'autofocus', 'backdrop', 'backdropClassName', 'backdrop_class_name', 'centered', 'className', 'class_name', 'contentClassName', 'content_class_name', 'enforceFocus', 'fade', 'fullscreen', 'is_open', 'keyboard', 'labelledBy', 'labelledby', 'modalClassName', 'modal_class_name', 'role', 'scrollable', 'size', 'style', 'tag', 'zIndex', 'zindex']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'autoFocus', 'autofocus', 'backdrop', 'backdropClassName', 'backdrop_class_name', 'centered', 'className', 'class_name', 'contentClassName', 'content_class_name', 'enforceFocus', 'fade', 'fullscreen', 'is_open', 'keyboard', 'labelledBy', 'labelledby', 'modalClassName', 'modal_class_name', 'role', 'scrollable', 'size', 'style', 'tag', 'zIndex', '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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, tag=undefined, is_open=undefined, centered=undefined, scrollable=undefined, autofocus=undefined, autoFocus=undefined, enforceFocus=undefined, size=undefined, role=undefined, labelledby=undefined, labelledBy=undefined, keyboard=undefined, backdrop=undefined, modal_class_name=undefined, modalClassName=undefined, backdrop_class_name=undefined, backdropClassName=undefined, content_class_name=undefined, contentClassName=undefined, fade=undefined, fullscreen=undefined, zindex=undefined, zIndex=undefined, **kwargs)
|
61,008 |
dash_bootstrap_components._components.ModalBody
|
ModalBody
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalBody, default: div.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalBody, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ModalBody'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', '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 if k != 'children'}
super(ModalBody, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,023 |
dash_bootstrap_components._components.ModalFooter
|
ModalFooter
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalFooter, default: div.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalFooter, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ModalFooter'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', '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 if k != 'children'}
super(ModalFooter, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,038 |
dash_bootstrap_components._components.ModalHeader
|
ModalHeader
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- close_button (boolean; default True):
Add a close button to the header that can be used to close the
modal.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalHeader, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- close_button (boolean; default True):
Add a close button to the header that can be used to close the
modal.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalHeader, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ModalHeader'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, close_button=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'close_button', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'close_button', 'loading_state', 'style', '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 if k != 'children'}
super(ModalHeader, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, close_button=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,053 |
dash_bootstrap_components._components.ModalTitle
|
ModalTitle
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalTitle, default: div.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the ModalTitle, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'ModalTitle'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'loading_state', 'style', '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 if k != 'children'}
super(ModalTitle, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,068 |
dash_bootstrap_components._components.Nav
|
Nav
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- card (boolean; optional):
Set to True when using Nav with pills styling inside a CardHeader.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- fill (boolean; optional):
Expand the nav items to fill available horizontal space.
- horizontal (a value equal to: 'start', 'center', 'end', 'between', 'around'; optional):
Specify the horizontal alignment of the NavItems. Options are
'start', 'center', or 'end'.
- justified (boolean; optional):
Expand the nav items to fill available horizontal space, making
sure every nav item has the same width.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- pills (boolean; optional):
Apply pill styling to nav items. Active items will be indicated by
a pill.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- card (boolean; optional):
Set to True when using Nav with pills styling inside a CardHeader.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- fill (boolean; optional):
Expand the nav items to fill available horizontal space.
- horizontal (a value equal to: 'start', 'center', 'end', 'between', 'around'; optional):
Specify the horizontal alignment of the NavItems. Options are
'start', 'center', or 'end'.
- justified (boolean; optional):
Expand the nav items to fill available horizontal space, making
sure every nav item has the same width.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- pills (boolean; optional):
Apply pill styling to nav items. Active items will be indicated by
a pill.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Nav'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, pills=Component.UNDEFINED, card=Component.UNDEFINED, fill=Component.UNDEFINED, justified=Component.UNDEFINED, vertical=Component.UNDEFINED, horizontal=Component.UNDEFINED, navbar=Component.UNDEFINED, navbar_scroll=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'card', 'className', 'class_name', 'fill', 'horizontal', 'justified', 'key', 'loading_state', 'navbar', 'navbar_scroll', 'pills', 'style', 'vertical']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'card', 'className', 'class_name', 'fill', 'horizontal', 'justified', 'key', 'loading_state', 'navbar', 'navbar_scroll', 'pills', 'style', 'vertical']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, pills=undefined, card=undefined, fill=undefined, justified=undefined, vertical=undefined, horizontal=undefined, navbar=undefined, navbar_scroll=undefined, loading_state=undefined, **kwargs)
|
61,083 |
dash_bootstrap_components._components.NavItem
|
NavItem
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'NavItem'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, loading_state=undefined, **kwargs)
|
61,098 |
dash_bootstrap_components._components.NavLink
|
NavLink
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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".
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; default False):
Disable the link.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
The URL of the linked resource.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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\".
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; default False):
Disable the link.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
The URL of the linked resource.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'NavLink'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, href=Component.UNDEFINED, active=Component.UNDEFINED, disabled=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, loading_state=Component.UNDEFINED, target=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'active', 'className', 'class_name', 'disabled', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'active', 'className', 'class_name', 'disabled', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'target']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, href=undefined, active=undefined, disabled=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, loading_state=undefined, target=undefined, **kwargs)
|
61,113 |
dash_bootstrap_components._components.Navbar
|
Navbar
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'light'):
Sets the color of the Navbar. 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; optional):
Applies the `navbar-dark` class to the Navbar, causing text in the
children of the Navbar to use light colors for contrast /
visibility.
- expand (boolean | string; default 'md'):
Specify screen size at which to expand the menu bar, e.g. sm, md,
lg etc.
- fixed (string; optional):
Fix the navbar's position at the top or bottom of the page,
options: top, bottom.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- light (boolean; default True):
Applies the `navbar-light` class to the Navbar, causing text in
the children of the Navbar to use dark colors for contrast /
visibility.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- role (string; optional):
The ARIA role attribute.
- 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'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Navbar, default 'nav'.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'light'):
Sets the color of the Navbar. 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; optional):
Applies the `navbar-dark` class to the Navbar, causing text in the
children of the Navbar to use light colors for contrast /
visibility.
- expand (boolean | string; default 'md'):
Specify screen size at which to expand the menu bar, e.g. sm, md,
lg etc.
- fixed (string; optional):
Fix the navbar's position at the top or bottom of the page,
options: top, bottom.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- light (boolean; default True):
Applies the `navbar-light` class to the Navbar, causing text in
the children of the Navbar to use dark colors for contrast /
visibility.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- role (string; optional):
The ARIA role attribute.
- 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'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Navbar, default 'nav'."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Navbar'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, light=Component.UNDEFINED, dark=Component.UNDEFINED, fixed=Component.UNDEFINED, sticky=Component.UNDEFINED, color=Component.UNDEFINED, role=Component.UNDEFINED, tag=Component.UNDEFINED, expand=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'color', 'dark', 'expand', 'fixed', 'key', 'light', 'loading_state', 'role', 'sticky', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'color', 'dark', 'expand', 'fixed', 'key', 'light', 'loading_state', 'role', 'sticky', 'style', '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 if k != 'children'}
super(Navbar, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, light=undefined, dark=undefined, fixed=undefined, sticky=undefined, color=undefined, role=undefined, tag=undefined, expand=undefined, loading_state=undefined, **kwargs)
|
61,128 |
dash_bootstrap_components._components.NavbarBrand
|
NavbarBrand
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
URL of the linked resource.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
URL of the linked resource.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'NavbarBrand'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, external_link=Component.UNDEFINED, href=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'external_link', 'href', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'external_link', 'href', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, external_link=undefined, href=undefined, loading_state=undefined, **kwargs)
|
61,143 |
dash_bootstrap_components._components.NavbarSimple
|
NavbarSimple
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- brand (a list of or a singular dash component, string or number; optional):
Brand text, to go top left of the navbar.
- brand_external_link (boolean; optional):
If True, the browser will treat the brand link as external,
forcing a page refresh at the new location. If False, this just
changes the location without triggering a page refresh. Use this
if you are observing dcc.Location, for instance. Defaults to True
for absolute URLs and False otherwise.
- brand_href (string; optional):
Link to attach to brand.
- brand_style (dict; optional):
CSS style options for brand.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'light'):
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; optional):
Applies the `navbar-dark` class to the NavbarSimple, causing text
in the children of the Navbar to use light colors for contrast /
visibility.
- 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.
- fixed (string; optional):
Fix the navbar's position at the top or bottom of the page,
options: top, bottom.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- light (boolean; default True):
Applies the `navbar-light` class to the NavbarSimple, causing text
in the children of the Navbar to use dark colors for contrast /
visibility.
- links_left (boolean; default False):
Align the navlinks in the navbar to the left. Default: False.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- brand (a list of or a singular dash component, string or number; optional):
Brand text, to go top left of the navbar.
- brand_external_link (boolean; optional):
If True, the browser will treat the brand link as external,
forcing a page refresh at the new location. If False, this just
changes the location without triggering a page refresh. Use this
if you are observing dcc.Location, for instance. Defaults to True
for absolute URLs and False otherwise.
- brand_href (string; optional):
Link to attach to brand.
- brand_style (dict; optional):
CSS style options for brand.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'light'):
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; optional):
Applies the `navbar-dark` class to the NavbarSimple, causing text
in the children of the Navbar to use light colors for contrast /
visibility.
- 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.
- fixed (string; optional):
Fix the navbar's position at the top or bottom of the page,
options: top, bottom.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- light (boolean; default True):
Applies the `navbar-light` class to the NavbarSimple, causing text
in the children of the Navbar to use dark colors for contrast /
visibility.
- links_left (boolean; default False):
Align the navlinks in the navbar to the left. Default: False.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = ['brand']
_base_nodes = ['brand', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'NavbarSimple'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, brand=Component.UNDEFINED, brand_href=Component.UNDEFINED, brand_style=Component.UNDEFINED, brand_external_link=Component.UNDEFINED, fluid=Component.UNDEFINED, links_left=Component.UNDEFINED, light=Component.UNDEFINED, dark=Component.UNDEFINED, fixed=Component.UNDEFINED, sticky=Component.UNDEFINED, color=Component.UNDEFINED, expand=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'brand', 'brand_external_link', 'brand_href', 'brand_style', 'className', 'class_name', 'color', 'dark', 'expand', 'fixed', 'fluid', 'key', 'light', 'links_left', 'loading_state', 'sticky', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'brand', 'brand_external_link', 'brand_href', 'brand_style', 'className', 'class_name', 'color', 'dark', 'expand', 'fixed', 'fluid', 'key', 'light', 'links_left', 'loading_state', 'sticky', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, brand=undefined, brand_href=undefined, brand_style=undefined, brand_external_link=undefined, fluid=undefined, links_left=undefined, light=undefined, dark=undefined, fixed=undefined, sticky=undefined, color=undefined, expand=undefined, loading_state=undefined, **kwargs)
|
61,158 |
dash_bootstrap_components._components.NavbarToggler
|
NavbarToggler
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- type (string; optional):
Toggle type, default: button.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- type (string; optional):
Toggle type, default: button."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'NavbarToggler'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, type=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'type']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'style', 'type']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, type=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, loading_state=undefined, **kwargs)
|
61,173 |
dash_bootstrap_components._components.Offcanvas
|
Offcanvas
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autoFocus (boolean; optional):
**DEPRECATED** Use `autofocus` instead Puts the focus on
the modal when initialized.
- autofocus (boolean; optional):
Puts the focus on the offcanvas when initialized.
- 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.
- backdropClassName (string; optional):
**DEPRECATED** - Use backdrop_class_name instead. CSS class to
apply to the backdrop.
- backdrop_class_name (string; optional):
CSS class to apply to the backdrop.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- close_button (boolean; default True):
Specify whether the Component should contain a close button in the
header.
- is_open (boolean; default False):
Whether offcanvas is currently open.
- keyboard (boolean; optional):
Close the offcanvas when escape key is pressed.
- labelledBy (string; optional):
**DEPRECATED** Use `labelledby` instead The ARIA labelledby
attribute.
- labelledby (string; optional):
The ARIA labelledby attribute.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- placement (a value equal to: 'start', 'end', 'top', 'bottom'; optional):
Which side of the viewport the offcanvas will appear from.
- scrollable (boolean; optional):
Allow body scrolling while offcanvas is open.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- title (a list of or a singular dash component, string or number; optional):
The header title.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autoFocus (boolean; optional):
**DEPRECATED** Use `autofocus` instead Puts the focus on
the modal when initialized.
- autofocus (boolean; optional):
Puts the focus on the offcanvas when initialized.
- 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.
- backdropClassName (string; optional):
**DEPRECATED** - Use backdrop_class_name instead. CSS class to
apply to the backdrop.
- backdrop_class_name (string; optional):
CSS class to apply to the backdrop.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- close_button (boolean; default True):
Specify whether the Component should contain a close button in the
header.
- is_open (boolean; default False):
Whether offcanvas is currently open.
- keyboard (boolean; optional):
Close the offcanvas when escape key is pressed.
- labelledBy (string; optional):
**DEPRECATED** Use `labelledby` instead The ARIA labelledby
attribute.
- labelledby (string; optional):
The ARIA labelledby attribute.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- placement (a value equal to: 'start', 'end', 'top', 'bottom'; optional):
Which side of the viewport the offcanvas will appear from.
- scrollable (boolean; optional):
Allow body scrolling while offcanvas is open.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- title (a list of or a singular dash component, string or number; optional):
The header title."""
_children_props = ['title']
_base_nodes = ['title', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'Offcanvas'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, labelledby=Component.UNDEFINED, labelledBy=Component.UNDEFINED, backdrop=Component.UNDEFINED, backdrop_class_name=Component.UNDEFINED, backdropClassName=Component.UNDEFINED, keyboard=Component.UNDEFINED, is_open=Component.UNDEFINED, placement=Component.UNDEFINED, scrollable=Component.UNDEFINED, autofocus=Component.UNDEFINED, autoFocus=Component.UNDEFINED, title=Component.UNDEFINED, close_button=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'autoFocus', 'autofocus', 'backdrop', 'backdropClassName', 'backdrop_class_name', 'className', 'class_name', 'close_button', 'is_open', 'keyboard', 'labelledBy', 'labelledby', 'loading_state', 'placement', 'scrollable', 'style', 'title']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'autoFocus', 'autofocus', 'backdrop', 'backdropClassName', 'backdrop_class_name', 'className', 'class_name', 'close_button', 'is_open', 'keyboard', 'labelledBy', 'labelledby', 'loading_state', 'placement', 'scrollable', 'style', 'title']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, labelledby=undefined, labelledBy=undefined, backdrop=undefined, backdrop_class_name=undefined, backdropClassName=undefined, keyboard=undefined, is_open=undefined, placement=undefined, scrollable=undefined, autofocus=undefined, autoFocus=undefined, title=undefined, close_button=undefined, loading_state=undefined, **kwargs)
|
61,188 |
dash_bootstrap_components._components.Pagination
|
Pagination
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_page (number; default 1):
The currently active page.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- first_last (boolean; default False):
When True, this will display a first and last icon at the
beginning and end of the component.
- fully_expanded (boolean; default True):
When True, this will display all numbers between `min_value` and
`max_value`.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- min_value (number; default 1):
Minimum (leftmost) value to appear in the pagination.
- previous_next (boolean; default False):
When True, this will display a previous and next icon before and
after the individual page numbers.
- size (a value equal to: 'sm', 'lg'; optional):
Set the size of all page items in the pagination.
- step (number; default 1):
Page increment step.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_page (number; default 1):
The currently active page.
- className (string; optional):
**DEPRECATED** - Use class_name instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- first_last (boolean; default False):
When True, this will display a first and last icon at the
beginning and end of the component.
- fully_expanded (boolean; default True):
When True, this will display all numbers between `min_value` and
`max_value`.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- min_value (number; default 1):
Minimum (leftmost) value to appear in the pagination.
- previous_next (boolean; default False):
When True, this will display a previous and next icon before and
after the individual page numbers.
- size (a value equal to: 'sm', 'lg'; optional):
Set the size of all page items in the pagination.
- step (number; default 1):
Page increment step.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Pagination'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, size=Component.UNDEFINED, min_value=Component.UNDEFINED, max_value=Component.REQUIRED, step=Component.UNDEFINED, active_page=Component.UNDEFINED, fully_expanded=Component.UNDEFINED, previous_next=Component.UNDEFINED, first_last=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'active_page', 'className', 'class_name', 'first_last', 'fully_expanded', 'loading_state', 'max_value', 'min_value', 'previous_next', 'size', 'step', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'active_page', 'className', 'class_name', 'first_last', 'fully_expanded', 'loading_state', 'max_value', 'min_value', 'previous_next', 'size', 'step', 'style']
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)
|
(id=undefined, class_name=undefined, className=undefined, style=undefined, size=undefined, min_value=undefined, max_value=required, step=undefined, active_page=undefined, fully_expanded=undefined, previous_next=undefined, first_last=undefined, loading_state=undefined, **kwargs)
|
61,203 |
dash_bootstrap_components._components.Placeholder
|
Placeholder
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- animation (a value equal to: 'glow', 'wave'; optional):
Changes the animation of the placeholder.
- button (boolean; default False):
Show as a button shape.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Background color, options: primary, secondary, success, info,
warning, danger, light, dark.
- 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
loading_state is set to True.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- show_initially (boolean; default True):
Whether the Placeholder should show on app start-up before the
loading state has been determined. Default True.
- size (a value equal to: 'xs', 'sm', 'lg'; optional):
Component size variations. Only valid when `button=False`.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- 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.
- 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.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- animation (a value equal to: 'glow', 'wave'; optional):
Changes the animation of the placeholder.
- button (boolean; default False):
Show as a button shape.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Background color, options: primary, secondary, success, info,
warning, danger, light, dark.
- 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
loading_state is set to True.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- show_initially (boolean; default True):
Whether the Placeholder should show on app start-up before the
loading state has been determined. Default True.
- size (a value equal to: 'xs', 'sm', 'lg'; optional):
Component size variations. Only valid when `button=False`.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- 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.
- 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Placeholder'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, loading_state=Component.UNDEFINED, animation=Component.UNDEFINED, color=Component.UNDEFINED, size=Component.UNDEFINED, button=Component.UNDEFINED, delay_hide=Component.UNDEFINED, delay_show=Component.UNDEFINED, show_initially=Component.UNDEFINED, xs=Component.UNDEFINED, sm=Component.UNDEFINED, md=Component.UNDEFINED, lg=Component.UNDEFINED, xl=Component.UNDEFINED, xxl=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'animation', 'button', 'className', 'class_name', 'color', 'delay_hide', 'delay_show', 'key', 'lg', 'loading_state', 'md', 'show_initially', 'size', 'sm', 'style', 'xl', 'xs', 'xxl']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'animation', 'button', 'className', 'class_name', 'color', 'delay_hide', 'delay_show', 'key', 'lg', 'loading_state', 'md', 'show_initially', 'size', 'sm', 'style', 'xl', 'xs', 'xxl']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, loading_state=undefined, animation=undefined, color=undefined, size=undefined, button=undefined, delay_hide=undefined, delay_show=undefined, show_initially=undefined, xs=undefined, sm=undefined, md=undefined, lg=undefined, xl=undefined, xxl=undefined, **kwargs)
|
61,218 |
dash_bootstrap_components._components.Popover
|
Popover
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autohide (boolean; default False):
Optionally hide popover when hovering over content - default
False.
- body (boolean; optional):
When body is `True`, the Popover will render all children in a
`PopoverBody` automatically.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- delay (dict; default {show: 0, hide: 50}):
Optionally override show/hide delays.
`delay` is a dict with keys:
- hide (number; optional)
- show (number; optional) | number
- flip (boolean; default True):
Whether to flip the direction of the popover if too close to the
container edge, default True.
- hide_arrow (boolean; optional):
Hide popover arrow.
- innerClassName (string; optional):
**DEPRECATED** Use `inner_class_name` instead. CSS class to apply
to the popover.
- inner_class_name (string; optional):
CSS class to apply to the popover.
- is_open (boolean; optional):
Whether the Popover is open or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string | dict; optional):
ID of the component to attach the popover to.
- trigger (string; optional):
Space separated list of triggers (e.g. "click hover focus
legacy"). These specify ways in which the target component 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.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autohide (boolean; default False):
Optionally hide popover when hovering over content - default
False.
- body (boolean; optional):
When body is `True`, the Popover will render all children in a
`PopoverBody` automatically.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- delay (dict; default {show: 0, hide: 50}):
Optionally override show/hide delays.
`delay` is a dict with keys:
- hide (number; optional)
- show (number; optional) | number
- flip (boolean; default True):
Whether to flip the direction of the popover if too close to the
container edge, default True.
- hide_arrow (boolean; optional):
Hide popover arrow.
- innerClassName (string; optional):
**DEPRECATED** Use `inner_class_name` instead. CSS class to apply
to the popover.
- inner_class_name (string; optional):
CSS class to apply to the popover.
- is_open (boolean; optional):
Whether the Popover is open or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string | dict; optional):
ID of the component to attach the popover to.
- trigger (string; optional):
Space separated list of triggers (e.g. \"click hover focus
legacy\"). These specify ways in which the target component 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."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Popover'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, placement=Component.UNDEFINED, target=Component.UNDEFINED, trigger=Component.UNDEFINED, is_open=Component.UNDEFINED, hide_arrow=Component.UNDEFINED, inner_class_name=Component.UNDEFINED, innerClassName=Component.UNDEFINED, delay=Component.UNDEFINED, offset=Component.UNDEFINED, flip=Component.UNDEFINED, body=Component.UNDEFINED, autohide=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'autohide', 'body', 'className', 'class_name', 'delay', 'flip', 'hide_arrow', 'innerClassName', 'inner_class_name', 'is_open', 'key', 'loading_state', 'offset', 'persisted_props', 'persistence', 'persistence_type', 'placement', 'style', 'target', 'trigger']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'autohide', 'body', 'className', 'class_name', 'delay', 'flip', 'hide_arrow', 'innerClassName', 'inner_class_name', 'is_open', 'key', 'loading_state', 'offset', 'persisted_props', 'persistence', 'persistence_type', 'placement', 'style', 'target', 'trigger']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, placement=undefined, target=undefined, trigger=undefined, is_open=undefined, hide_arrow=undefined, inner_class_name=undefined, innerClassName=undefined, delay=undefined, offset=undefined, flip=undefined, body=undefined, autohide=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,233 |
dash_bootstrap_components._components.PopoverBody
|
PopoverBody
|
A PopoverBody component.
Componnet 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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the PopoverBody, default: div.
|
class PopoverBody(Component):
"""A PopoverBody component.
Componnet 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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the PopoverBody, default: div."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'PopoverBody'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(PopoverBody, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,248 |
dash_bootstrap_components._components.PopoverHeader
|
PopoverHeader
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the PopoverHeader, default: h3.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the PopoverHeader, default: h3."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'PopoverHeader'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'key', 'loading_state', 'style', '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 if k != 'children'}
super(PopoverHeader, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, tag=undefined, loading_state=undefined, **kwargs)
|
61,263 |
dash_bootstrap_components._components.Progress
|
Progress
|
A Progress component.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component. Use this to nest progress bars.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- animated (boolean; optional):
Animate the bar, must have striped set to True to work.
- bar (boolean; optional):
Set to True when nesting Progress inside another Progress
component to create a multi-progress bar.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- hide_label (boolean; default False):
Set to True to hide the label.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (string; optional):
Adds a label to the progress bar.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- max (number; optional):
Upper limit for value, default: 100.
- min (number; optional):
Lower limit for value, default: 0.
- striped (boolean; optional):
Use striped progress bar.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- value (string | number; optional):
Specify progress, value from min to max inclusive.
|
class Progress(Component):
"""A Progress component.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component. Use this to nest progress bars.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- animated (boolean; optional):
Animate the bar, must have striped set to True to work.
- bar (boolean; optional):
Set to True when nesting Progress inside another Progress
component to create a multi-progress bar.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- hide_label (boolean; default False):
Set to True to hide the label.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (string; optional):
Adds a label to the progress bar.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- max (number; optional):
Upper limit for value, default: 100.
- min (number; optional):
Lower limit for value, default: 0.
- striped (boolean; optional):
Use striped progress bar.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- value (string | number; optional):
Specify progress, value from min to max inclusive."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Progress'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, bar=Component.UNDEFINED, min=Component.UNDEFINED, max=Component.UNDEFINED, value=Component.UNDEFINED, label=Component.UNDEFINED, hide_label=Component.UNDEFINED, animated=Component.UNDEFINED, striped=Component.UNDEFINED, color=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'animated', 'bar', 'className', 'class_name', 'color', 'hide_label', 'key', 'label', 'loading_state', 'max', 'min', 'striped', 'style', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'animated', 'bar', 'className', 'class_name', 'color', 'hide_label', 'key', 'label', 'loading_state', 'max', 'min', 'striped', 'style', 'value']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, bar=undefined, min=undefined, max=undefined, value=undefined, label=undefined, hide_label=undefined, animated=undefined, striped=undefined, color=undefined, loading_state=undefined, **kwargs)
|
61,278 |
dash_bootstrap_components._components.RadioButton
|
RadioButton
|
A RadioButton 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the RadioButton.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input.
|
class RadioButton(Component):
"""A RadioButton 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the RadioButton.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input."""
_children_props = ['label']
_base_nodes = ['label', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'RadioButton'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, input_style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, input_class_name=Component.UNDEFINED, inputClassName=Component.UNDEFINED, label=Component.UNDEFINED, label_id=Component.UNDEFINED, label_style=Component.UNDEFINED, labelStyle=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, name=Component.UNDEFINED, value=Component.UNDEFINED, disabled=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
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)
|
(id=undefined, class_name=undefined, className=undefined, style=undefined, input_style=undefined, inputStyle=undefined, input_class_name=undefined, inputClassName=undefined, label=undefined, label_id=undefined, label_style=undefined, labelStyle=undefined, label_class_name=undefined, labelClassName=undefined, name=undefined, value=undefined, disabled=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,293 |
dash_bootstrap_components._components.RadioItems
|
RadioItems
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- inline (boolean; optional):
Arrange RadioItems inline.
- inputCheckedClassName (string; optional):
**DEPRECATED** Use `input_checked_class_name` instead. Additional
CSS classes to apply to the <input> element when the corresponding
radio is checked.
- inputCheckedStyle (dict; optional):
**DEPRECATED** Use `input_checked_style` instead. Additional
inline style arguments to apply to <input> elements on checked
items.
- inputClassName (string; default ''):
**DEPRECATED** Use `input_class_name` instead. The class of the
<input> radio element.
- inputStyle (dict; optional):
**DEPRECATED** Use `input_style` instead. The style 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.
- input_checked_style (dict; optional):
Additional inline style arguments to apply to <input> elements on
checked items.
- input_class_name (string; default ''):
The class of the <input> radio element.
- input_style (dict; optional):
The style of the <input> radio element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- labelCheckedClassName (string; optional):
**DEPRECATED** Use `label_checked_class_name` instead. Additional
CSS classes to apply to the <label> element when the corresponding
radio is checked.
- labelCheckedStyle (dict; optional):
**DEPRECATED** Use `label_checked_style` instead. Additional
inline style arguments to apply to <label> elements on checked
items.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_checked_class_name (string; optional):
Additional CSS classes to apply to the <label> element when the
corresponding radio is checked.
- label_checked_style (dict; optional):
Additional inline style arguments to apply to <label> elements on
checked items.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- options (list of dicts; optional):
The options to display as items in the component. This can be an
array or a dictionary as follows:
1. Array of options where the
label and the value are the same thing - [string|number]
2. An
array of options ``` { "label": [string|number], "value":
[string|number], "disabled": [bool] (Optional),
"input_id": [string] (Optional), "label_id": [string]
(Optional) } ```
3. 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:
- 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 (a list of or a singular dash component, string or number; required):
The radio item's label.
- label_id (string; optional):
id for this option's label, can be used to attach tooltips or
apply CSS styles.
- value (string | number; required):
The value of the radio item. This value corresponds to the
items specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- switch (boolean; optional):
Set to True to render toggle-like switches instead of radios.
- value (string | number; optional):
The currently selected value.
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- inline (boolean; optional):
Arrange RadioItems inline.
- inputCheckedClassName (string; optional):
**DEPRECATED** Use `input_checked_class_name` instead. Additional
CSS classes to apply to the <input> element when the corresponding
radio is checked.
- inputCheckedStyle (dict; optional):
**DEPRECATED** Use `input_checked_style` instead. Additional
inline style arguments to apply to <input> elements on checked
items.
- inputClassName (string; default ''):
**DEPRECATED** Use `input_class_name` instead. The class of the
<input> radio element.
- inputStyle (dict; optional):
**DEPRECATED** Use `input_style` instead. The style 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.
- input_checked_style (dict; optional):
Additional inline style arguments to apply to <input> elements on
checked items.
- input_class_name (string; default ''):
The class of the <input> radio element.
- input_style (dict; optional):
The style of the <input> radio element.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- labelCheckedClassName (string; optional):
**DEPRECATED** Use `label_checked_class_name` instead. Additional
CSS classes to apply to the <label> element when the corresponding
radio is checked.
- labelCheckedStyle (dict; optional):
**DEPRECATED** Use `label_checked_style` instead. Additional
inline style arguments to apply to <label> elements on checked
items.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_checked_class_name (string; optional):
Additional CSS classes to apply to the <label> element when the
corresponding radio is checked.
- label_checked_style (dict; optional):
Additional inline style arguments to apply to <label> elements on
checked items.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- 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:
- 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 (a list of or a singular dash component, string or number; required):
The radio item's label.
- label_id (string; optional):
id for this option's label, can be used to attach tooltips or
apply CSS styles.
- value (string | number; required):
The value of the radio item. This value corresponds to the
items specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- switch (boolean; optional):
Set to True to render toggle-like switches instead of radios.
- value (string | number; optional):
The currently selected value."""
_children_props = ['options[].label']
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'RadioItems'
@_explicitize_args
def __init__(self, options=Component.UNDEFINED, value=Component.UNDEFINED, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, input_style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, input_checked_style=Component.UNDEFINED, inputCheckedStyle=Component.UNDEFINED, input_class_name=Component.UNDEFINED, inputClassName=Component.UNDEFINED, input_checked_class_name=Component.UNDEFINED, inputCheckedClassName=Component.UNDEFINED, label_style=Component.UNDEFINED, labelStyle=Component.UNDEFINED, label_checked_style=Component.UNDEFINED, labelCheckedStyle=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, label_checked_class_name=Component.UNDEFINED, labelCheckedClassName=Component.UNDEFINED, inline=Component.UNDEFINED, switch=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, name=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'inline', 'inputCheckedClassName', 'inputCheckedStyle', 'inputClassName', 'inputStyle', 'input_checked_class_name', 'input_checked_style', 'input_class_name', 'input_style', 'key', 'labelCheckedClassName', 'labelCheckedStyle', 'labelClassName', 'labelStyle', 'label_checked_class_name', 'label_checked_style', 'label_class_name', 'label_style', 'loading_state', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'style', 'switch', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'inline', 'inputCheckedClassName', 'inputCheckedStyle', 'inputClassName', 'inputStyle', 'input_checked_class_name', 'input_checked_style', 'input_class_name', 'input_style', 'key', 'labelCheckedClassName', 'labelCheckedStyle', 'labelClassName', 'labelStyle', 'label_checked_class_name', 'label_checked_style', 'label_class_name', 'label_style', 'loading_state', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'style', 'switch', 'value']
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)
|
(options=undefined, value=undefined, id=undefined, key=undefined, style=undefined, class_name=undefined, className=undefined, input_style=undefined, inputStyle=undefined, input_checked_style=undefined, inputCheckedStyle=undefined, input_class_name=undefined, inputClassName=undefined, input_checked_class_name=undefined, inputCheckedClassName=undefined, label_style=undefined, labelStyle=undefined, label_checked_style=undefined, labelCheckedStyle=undefined, label_class_name=undefined, labelClassName=undefined, label_checked_class_name=undefined, labelCheckedClassName=undefined, inline=undefined, switch=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, name=undefined, **kwargs)
|
61,308 |
dash_bootstrap_components._components.Row
|
Row
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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'.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Row'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, align=Component.UNDEFINED, justify=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'align', 'className', 'class_name', 'justify', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'align', 'className', 'class_name', 'justify', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, align=undefined, justify=undefined, loading_state=undefined, **kwargs)
|
61,323 |
dash_bootstrap_components._components.Select
|
Select
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; optional):
Set to True to disable the Select.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- name (string; optional):
The name of the control, which is submitted with the form data.
- options (list of dicts; optional):
The options to display as items in the component. This can be an
array or a dictionary as follows:
1. Array of options where the
label and the value are the same thing - [string|number]
2. An
array of options ``` { "label": [string|number], "value":
[string|number], "disabled": [bool] (Optional), "title":
[string] (Optional) } ```
3. 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:
- disabled (boolean; optional):
If True, this checkbox is disabled and can't be clicked on.
- label (string | number; required):
The options's label.
- 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; required):
The value of the option. This value corresponds to the items
specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- placeholder (string; default ''):
Placeholder text to display before a selection is made.
- 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.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- value (string | number; default ''):
The value of the currently selected option.
|
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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; optional):
Set to True to disable the Select.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- name (string; optional):
The name of the control, which is submitted with the form data.
- 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:
- disabled (boolean; optional):
If True, this checkbox is disabled and can't be clicked on.
- label (string | number; required):
The options's label.
- 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; required):
The value of the option. This value corresponds to the items
specified in the `value` property.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- placeholder (string; default ''):
Placeholder text to display before a selection is made.
- 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.
- size (string; optional):
Set the size of the Input. Options: 'sm' (small), 'md' (medium) or
'lg' (large). Default is 'md'.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- 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.
- value (string | number; default ''):
The value of the currently selected option."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Select'
@_explicitize_args
def __init__(self, options=Component.UNDEFINED, value=Component.UNDEFINED, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, placeholder=Component.UNDEFINED, disabled=Component.UNDEFINED, required=Component.UNDEFINED, valid=Component.UNDEFINED, invalid=Component.UNDEFINED, size=Component.UNDEFINED, html_size=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, name=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'disabled', 'html_size', 'invalid', 'key', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'required', 'size', 'style', 'valid', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'disabled', 'html_size', 'invalid', 'key', 'name', 'options', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'required', 'size', 'style', 'valid', 'value']
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)
|
(options=undefined, value=undefined, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, placeholder=undefined, disabled=undefined, required=undefined, valid=undefined, invalid=undefined, size=undefined, html_size=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, name=undefined, **kwargs)
|
61,338 |
dash_bootstrap_components._components.Spinner
|
Spinner
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- 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 loading_state is set to
True.
- fullscreen (boolean; optional):
Boolean that determines if the loading spinner will be displayed
full-screen or not.
- fullscreenClassName (string; optional):
**DEPRECATED** - use `fullscreen_class_name` instead. Often used
with CSS to style elements with common properties.
- fullscreen_class_name (string; optional):
Often used with CSS to style elements with common properties.
- fullscreen_style (dict; optional):
Defines CSS styles for the container when fullscreen=True.
- show_initially (boolean; default True):
Whether the Spinner should show on app start-up before the loading
state has been determined. Default True.
- size (string; optional):
The spinner size. Options are 'sm', and 'md'.
- spinnerClassName (string; optional):
**DEPRECATED** - use `spinner_class_name` instead. CSS class
names to apply to the spinner.
- spinner_class_name (string; optional):
CSS class names to apply to the spinner.
- spinner_style (dict; optional):
Inline CSS styles to apply to the spinner.
- type (string; default 'border'):
The type of spinner. Options 'border' and 'grow'. Default
'border'.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- 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 loading_state is set to
True.
- fullscreen (boolean; optional):
Boolean that determines if the loading spinner will be displayed
full-screen or not.
- fullscreenClassName (string; optional):
**DEPRECATED** - use `fullscreen_class_name` instead. Often used
with CSS to style elements with common properties.
- fullscreen_class_name (string; optional):
Often used with CSS to style elements with common properties.
- fullscreen_style (dict; optional):
Defines CSS styles for the container when fullscreen=True.
- show_initially (boolean; default True):
Whether the Spinner should show on app start-up before the loading
state has been determined. Default True.
- size (string; optional):
The spinner size. Options are 'sm', and 'md'.
- spinnerClassName (string; optional):
**DEPRECATED** - use `spinner_class_name` instead. CSS class
names to apply to the spinner.
- spinner_class_name (string; optional):
CSS class names to apply to the spinner.
- spinner_style (dict; optional):
Inline CSS styles to apply to the spinner.
- type (string; default 'border'):
The type of spinner. Options 'border' and 'grow'. Default
'border'."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Spinner'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, fullscreen_style=Component.UNDEFINED, spinner_style=Component.UNDEFINED, fullscreen_class_name=Component.UNDEFINED, fullscreenClassName=Component.UNDEFINED, spinner_class_name=Component.UNDEFINED, spinnerClassName=Component.UNDEFINED, color=Component.UNDEFINED, type=Component.UNDEFINED, size=Component.UNDEFINED, fullscreen=Component.UNDEFINED, delay_hide=Component.UNDEFINED, delay_show=Component.UNDEFINED, show_initially=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'color', 'delay_hide', 'delay_show', 'fullscreen', 'fullscreenClassName', 'fullscreen_class_name', 'fullscreen_style', 'show_initially', 'size', 'spinnerClassName', 'spinner_class_name', 'spinner_style', 'type']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'color', 'delay_hide', 'delay_show', 'fullscreen', 'fullscreenClassName', 'fullscreen_class_name', 'fullscreen_style', 'show_initially', 'size', 'spinnerClassName', 'spinner_class_name', 'spinner_style', 'type']
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)
|
(children=None, id=undefined, fullscreen_style=undefined, spinner_style=undefined, fullscreen_class_name=undefined, fullscreenClassName=undefined, spinner_class_name=undefined, spinnerClassName=undefined, color=undefined, type=undefined, size=undefined, fullscreen=undefined, delay_hide=undefined, delay_show=undefined, show_initially=undefined, **kwargs)
|
61,353 |
dash_bootstrap_components._components.Stack
|
Stack
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- 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).
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Stack'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, loading_state=Component.UNDEFINED, direction=Component.UNDEFINED, gap=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'direction', 'gap', 'key', 'loading_state', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'direction', 'gap', 'key', 'loading_state', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, loading_state=undefined, direction=undefined, gap=undefined, **kwargs)
|
61,368 |
dash_bootstrap_components._components.Switch
|
Switch
|
A Switch 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the Switch.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input.
|
class Switch(Component):
"""A Switch 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:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. The class of the
container (div).
- class_name (string; optional):
The class of the container (div).
- disabled (boolean; default False):
Disable the Switch.
- inputClassName (string; default ''):
**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.
- input_class_name (string; default ''):
The class of the <input> checkbox element.
- input_style (dict; optional):
The style of the <input> checkbox element.
- label (a list of or a singular dash component, string or number; optional):
The label of the <input> element.
- labelClassName (string; default ''):
**DEPRECATED** Use `label_class_name` instead. CSS classes to
apply to the <label> element for each item.
- labelStyle (dict; optional):
**DEPRECATED** Use `label_style` instead. Inline style arguments
to apply to the <label> element for each item.
- label_class_name (string; default ''):
CSS classes to apply to the <label> element for each item.
- label_id (string; optional):
The id of the label.
- label_style (dict; optional):
Inline style arguments to apply to the <label> element for each
item.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- name (string; optional):
The name of the control, which is submitted with the form data.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
The style of the container (div).
- value (boolean; default False):
The value of the input."""
_children_props = ['label']
_base_nodes = ['label', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'Switch'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, input_style=Component.UNDEFINED, inputStyle=Component.UNDEFINED, input_class_name=Component.UNDEFINED, inputClassName=Component.UNDEFINED, label=Component.UNDEFINED, label_id=Component.UNDEFINED, label_style=Component.UNDEFINED, labelStyle=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, name=Component.UNDEFINED, value=Component.UNDEFINED, disabled=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'class_name', 'disabled', 'inputClassName', 'inputStyle', 'input_class_name', 'input_style', 'label', 'labelClassName', 'labelStyle', 'label_class_name', 'label_id', 'label_style', 'loading_state', 'name', 'persisted_props', 'persistence', 'persistence_type', 'style', 'value']
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)
|
(id=undefined, class_name=undefined, className=undefined, style=undefined, input_style=undefined, inputStyle=undefined, input_class_name=undefined, inputClassName=undefined, label=undefined, label_id=undefined, label_style=undefined, labelStyle=undefined, label_class_name=undefined, labelClassName=undefined, name=undefined, value=undefined, disabled=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,383 |
dash_bootstrap_components._components.Tab
|
Tab
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- activeLabelClassName (string; optional):
**DEPRECATED** Use `active_label_class_name` instead Often used
with CSS to style elements with common properties. The classes
specified with this prop will be applied to the NavLink in the tab
when it is active.
- activeTabClassName (string; optional):
**DEPRECATED** Use `active_tab_class_name` instead Often used
with CSS to style elements with common properties. The classes
specified with this prop will be applied to the NavItem in the tab
when it is active.
- active_label_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavLink in
the tab when it is active.
- 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.
- active_tab_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavItem in
the tab when it is active.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; default False):
Determines if tab is disabled or not - defaults to False.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (string; optional):
The tab's label, displayed in the tab itself.
- labelClassName (string; optional):
**DEPRECATED** Use `label_class_name` instead Often used with CSS
to style elements with common properties. The classes specified
with this prop will be applied to the NavLink in the tab.
- label_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavLink in
the tab.
- label_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the NavLink in the tab.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the content of the Tab.
- tabClassName (string; optional):
**DEPRECATED** Use `tab_class_name` instead Often used with CSS
to style elements with common properties. The classes specified
with this prop will be applied to the NavItem in the tab.
- tab_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavItem in
the tab.
- 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.
- tab_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the NavItem in the tab.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- activeLabelClassName (string; optional):
**DEPRECATED** Use `active_label_class_name` instead Often used
with CSS to style elements with common properties. The classes
specified with this prop will be applied to the NavLink in the tab
when it is active.
- activeTabClassName (string; optional):
**DEPRECATED** Use `active_tab_class_name` instead Often used
with CSS to style elements with common properties. The classes
specified with this prop will be applied to the NavItem in the tab
when it is active.
- active_label_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavLink in
the tab when it is active.
- 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.
- active_tab_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavItem in
the tab when it is active.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- disabled (boolean; default False):
Determines if tab is disabled or not - defaults to False.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- label (string; optional):
The tab's label, displayed in the tab itself.
- labelClassName (string; optional):
**DEPRECATED** Use `label_class_name` instead Often used with CSS
to style elements with common properties. The classes specified
with this prop will be applied to the NavLink in the tab.
- label_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavLink in
the tab.
- label_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the NavLink in the tab.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the content of the Tab.
- tabClassName (string; optional):
**DEPRECATED** Use `tab_class_name` instead Often used with CSS
to style elements with common properties. The classes specified
with this prop will be applied to the NavItem in the tab.
- tab_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the NavItem in
the tab.
- 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.
- tab_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the NavItem in the tab."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Tab'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, tab_style=Component.UNDEFINED, active_tab_style=Component.UNDEFINED, label_style=Component.UNDEFINED, active_label_style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, tab_class_name=Component.UNDEFINED, tabClassName=Component.UNDEFINED, active_tab_class_name=Component.UNDEFINED, activeTabClassName=Component.UNDEFINED, label_class_name=Component.UNDEFINED, labelClassName=Component.UNDEFINED, active_label_class_name=Component.UNDEFINED, activeLabelClassName=Component.UNDEFINED, key=Component.UNDEFINED, label=Component.UNDEFINED, tab_id=Component.UNDEFINED, disabled=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'activeLabelClassName', 'activeTabClassName', 'active_label_class_name', 'active_label_style', 'active_tab_class_name', 'active_tab_style', 'className', 'class_name', 'disabled', 'key', 'label', 'labelClassName', 'label_class_name', 'label_style', 'loading_state', 'style', 'tabClassName', 'tab_class_name', 'tab_id', 'tab_style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'activeLabelClassName', 'activeTabClassName', 'active_label_class_name', 'active_label_style', 'active_tab_class_name', 'active_tab_style', 'className', 'class_name', 'disabled', 'key', 'label', 'labelClassName', 'label_class_name', 'label_style', 'loading_state', 'style', 'tabClassName', 'tab_class_name', 'tab_id', 'tab_style']
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)
|
(children=None, id=undefined, style=undefined, tab_style=undefined, active_tab_style=undefined, label_style=undefined, active_label_style=undefined, class_name=undefined, className=undefined, tab_class_name=undefined, tabClassName=undefined, active_tab_class_name=undefined, activeTabClassName=undefined, label_class_name=undefined, labelClassName=undefined, active_label_class_name=undefined, activeLabelClassName=undefined, key=undefined, label=undefined, tab_id=undefined, disabled=undefined, loading_state=undefined, **kwargs)
|
61,398 |
dash_bootstrap_components._components.Table
|
Table
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Table color, options: primary, secondary, success, info, warning,
danger, dark, light. Default: secondary.
- dark (boolean; optional):
**DEPRECATED** - Use color="dark" instead. Apply the
`table-dark` class for dark cell backgrounds and light text.
- hover (boolean; optional):
Apply the `table-hover` class which enables a hover state on table
rows within the table body.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- responsive (boolean | string; optional):
Set to True or one of the breakpoints 'sm', 'md', 'lg', 'xl' to
make table scroll horizontally at lower breakpoints.
- size (string; optional):
Specify table size, options: 'sm', 'md', 'lg'.
- striped (boolean; optional):
Apply the `table-striped` class which applies 'zebra striping' to
rows in the table body.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Table color, options: primary, secondary, success, info, warning,
danger, dark, light. Default: secondary.
- dark (boolean; optional):
**DEPRECATED** - Use color=\"dark\" instead. Apply the
`table-dark` class for dark cell backgrounds and light text.
- hover (boolean; optional):
Apply the `table-hover` class which enables a hover state on table
rows within the table body.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- responsive (boolean | string; optional):
Set to True or one of the breakpoints 'sm', 'md', 'lg', 'xl' to
make table scroll horizontally at lower breakpoints.
- size (string; optional):
Specify table size, options: 'sm', 'md', 'lg'.
- striped (boolean; optional):
Apply the `table-striped` class which applies 'zebra striping' to
rows in the table body.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Table'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, size=Component.UNDEFINED, bordered=Component.UNDEFINED, borderless=Component.UNDEFINED, striped=Component.UNDEFINED, color=Component.UNDEFINED, dark=Component.UNDEFINED, hover=Component.UNDEFINED, responsive=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'bordered', 'borderless', 'className', 'class_name', 'color', 'dark', 'hover', 'key', 'loading_state', 'responsive', 'size', 'striped', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'bordered', 'borderless', 'className', 'class_name', 'color', 'dark', 'hover', 'key', 'loading_state', 'responsive', 'size', 'striped', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, size=undefined, bordered=undefined, borderless=undefined, striped=undefined, color=undefined, dark=undefined, hover=undefined, responsive=undefined, loading_state=undefined, **kwargs)
|
61,413 |
dash_bootstrap_components._components.Tabs
|
Tabs
|
A Tabs component.
Create Bootstrap styled tabs. Use the `active_tab` property to set, or get
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_tab's; default ['active_tab']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
class Tabs(Component):
"""A Tabs component.
Create Bootstrap styled tabs. Use the `active_tab` property to set, or get
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- 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.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_tab's; default ['active_tab']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Tabs'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, active_tab=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'active_tab', 'className', 'class_name', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'active_tab', 'className', 'class_name', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'style']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, active_tab=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,428 |
dash_bootstrap_components._components.Textarea
|
Textarea
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- accessKey (string; optional):
**DEPRECATED** Use `accesskey` instead Defines a keyboard
shortcut to activate or add focus to the element.
- accesskey (string; optional):
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.
- autofocus (string; optional):
The element should be automatically focused after the page loaded.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- cols (string | number; optional):
Defines the number of columns in a textarea.
- contentEditable (string | number; optional):
**DEPRECATED** Use `contenteditable` instead Indicates whether
the element's content is editable.
- contenteditable (string | number; optional):
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.
- contextmenu (string; optional):
Defines the ID of a <menu> element which will serve as the
element's context menu.
- debounce (boolean; 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.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- lang (string; optional):
Defines the language used in the element.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- maxLength (string | number; optional):
**DEPRECATED** Use `maxlength` instead Defines the maximum number
of characters allowed in the element.
- maxlength (string | number; optional):
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.
- minlength (string | number; optional):
Defines the minimum number of characters allowed in the element.
- n_blur (number; default 0):
Number of times the input lost focus.
- n_blur_timestamp (number; default -1):
Last time the input lost focus.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the textarea had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- name (string; optional):
Name of the element. For example used by the server to identify
the fields in form submits.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- placeholder (string; optional):
Provides a hint to the user of what can be entered in the field.
- readOnly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
**DEPRECATED** Use `readonly` instead Indicates whether the
element can be edited.
- 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.
- size (string; optional):
Set the size of the Textarea, valid options are 'sm', 'md', or
'lg'.
- spellCheck (a value equal to: 'true', 'false' | boolean; optional):
**DEPRECATED** Use `spellcheck` instead Indicates whether spell
checking is allowed for the element.
- spellcheck (a value equal to: 'true', 'false' | boolean; optional):
Indicates whether spell checking is allowed for the element.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tabIndex (string | number; optional):
**DEPRECATED** Use `tabindex` instead Overrides the browser's
default tab order and follows the one specified instead.
- 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.
- 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.
- value (string; default ''):
The value of the textarea.
- wrap (string; optional):
Indicates whether the text should be wrapped.
|
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 this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- accessKey (string; optional):
**DEPRECATED** Use `accesskey` instead Defines a keyboard
shortcut to activate or add focus to the element.
- accesskey (string; optional):
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.
- autofocus (string; optional):
The element should be automatically focused after the page loaded.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- cols (string | number; optional):
Defines the number of columns in a textarea.
- contentEditable (string | number; optional):
**DEPRECATED** Use `contenteditable` instead Indicates whether
the element's content is editable.
- contenteditable (string | number; optional):
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.
- contextmenu (string; optional):
Defines the ID of a <menu> element which will serve as the
element's context menu.
- debounce (boolean; 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.
- 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.
- 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.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- lang (string; optional):
Defines the language used in the element.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- maxLength (string | number; optional):
**DEPRECATED** Use `maxlength` instead Defines the maximum number
of characters allowed in the element.
- maxlength (string | number; optional):
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.
- minlength (string | number; optional):
Defines the minimum number of characters allowed in the element.
- n_blur (number; default 0):
Number of times the input lost focus.
- n_blur_timestamp (number; default -1):
Last time the input lost focus.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the textarea had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- name (string; optional):
Name of the element. For example used by the server to identify
the fields in form submits.
- persisted_props (list of a value equal to: 'value's; default ['value']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- placeholder (string; optional):
Provides a hint to the user of what can be entered in the field.
- readOnly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
**DEPRECATED** Use `readonly` instead Indicates whether the
element can be edited.
- 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.
- size (string; optional):
Set the size of the Textarea, valid options are 'sm', 'md', or
'lg'.
- spellCheck (a value equal to: 'true', 'false' | boolean; optional):
**DEPRECATED** Use `spellcheck` instead Indicates whether spell
checking is allowed for the element.
- spellcheck (a value equal to: 'true', 'false' | boolean; optional):
Indicates whether spell checking is allowed for the element.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tabIndex (string | number; optional):
**DEPRECATED** Use `tabindex` instead Overrides the browser's
default tab order and follows the one specified instead.
- 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.
- 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.
- value (string; default ''):
The value of the textarea.
- wrap (string; optional):
Indicates whether the text should be wrapped."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Textarea'
@_explicitize_args
def __init__(self, id=Component.UNDEFINED, key=Component.UNDEFINED, value=Component.UNDEFINED, autofocus=Component.UNDEFINED, autoFocus=Component.UNDEFINED, cols=Component.UNDEFINED, disabled=Component.UNDEFINED, form=Component.UNDEFINED, maxlength=Component.UNDEFINED, maxLength=Component.UNDEFINED, minlength=Component.UNDEFINED, minLength=Component.UNDEFINED, name=Component.UNDEFINED, placeholder=Component.UNDEFINED, readonly=Component.UNDEFINED, readOnly=Component.UNDEFINED, required=Component.UNDEFINED, rows=Component.UNDEFINED, wrap=Component.UNDEFINED, accesskey=Component.UNDEFINED, accessKey=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, contenteditable=Component.UNDEFINED, contentEditable=Component.UNDEFINED, contextmenu=Component.UNDEFINED, contextMenu=Component.UNDEFINED, dir=Component.UNDEFINED, draggable=Component.UNDEFINED, hidden=Component.UNDEFINED, lang=Component.UNDEFINED, spellcheck=Component.UNDEFINED, spellCheck=Component.UNDEFINED, style=Component.UNDEFINED, tabindex=Component.UNDEFINED, tabIndex=Component.UNDEFINED, title=Component.UNDEFINED, size=Component.UNDEFINED, valid=Component.UNDEFINED, invalid=Component.UNDEFINED, n_blur=Component.UNDEFINED, n_blur_timestamp=Component.UNDEFINED, n_submit=Component.UNDEFINED, n_submit_timestamp=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, debounce=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['id', 'accessKey', 'accesskey', 'autoFocus', 'autofocus', 'className', 'class_name', 'cols', 'contentEditable', 'contenteditable', 'contextMenu', 'contextmenu', 'debounce', 'dir', 'disabled', 'draggable', 'form', 'hidden', 'invalid', 'key', 'lang', 'loading_state', 'maxLength', 'maxlength', 'minLength', 'minlength', 'n_blur', 'n_blur_timestamp', 'n_clicks', 'n_clicks_timestamp', 'n_submit', 'n_submit_timestamp', 'name', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'readOnly', 'readonly', 'required', 'rows', 'size', 'spellCheck', 'spellcheck', 'style', 'tabIndex', 'tabindex', 'title', 'valid', 'value', 'wrap']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'accessKey', 'accesskey', 'autoFocus', 'autofocus', 'className', 'class_name', 'cols', 'contentEditable', 'contenteditable', 'contextMenu', 'contextmenu', 'debounce', 'dir', 'disabled', 'draggable', 'form', 'hidden', 'invalid', 'key', 'lang', 'loading_state', 'maxLength', 'maxlength', 'minLength', 'minlength', 'n_blur', 'n_blur_timestamp', 'n_clicks', 'n_clicks_timestamp', 'n_submit', 'n_submit_timestamp', 'name', 'persisted_props', 'persistence', 'persistence_type', 'placeholder', 'readOnly', 'readonly', 'required', 'rows', 'size', 'spellCheck', 'spellcheck', 'style', 'tabIndex', 'tabindex', 'title', 'valid', 'value', 'wrap']
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)
|
(id=undefined, key=undefined, value=undefined, autofocus=undefined, autoFocus=undefined, cols=undefined, disabled=undefined, form=undefined, maxlength=undefined, maxLength=undefined, minlength=undefined, minLength=undefined, name=undefined, placeholder=undefined, readonly=undefined, readOnly=undefined, required=undefined, rows=undefined, wrap=undefined, accesskey=undefined, accessKey=undefined, class_name=undefined, className=undefined, contenteditable=undefined, contentEditable=undefined, contextmenu=undefined, contextMenu=undefined, dir=undefined, draggable=undefined, hidden=undefined, lang=undefined, spellcheck=undefined, spellCheck=undefined, style=undefined, tabindex=undefined, tabIndex=undefined, title=undefined, size=undefined, valid=undefined, invalid=undefined, n_blur=undefined, n_blur_timestamp=undefined, n_submit=undefined, n_submit_timestamp=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, debounce=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,443 |
dash_bootstrap_components._components.Toast
|
Toast
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- bodyClassName (string; optional):
**DEPRECATED** - use `body_class_name` instead. Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the body of the toast.
- body_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the body of
the toast.
- body_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the body of the toast.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Toast color, options: primary, secondary, success, info, warning,
danger, light, dark. Default: secondary.
- 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.
- header (a list of or a singular dash component, string or number; optional):
Text to populate the header with.
- headerClassName (string; optional):
**DEPRECATED** - use `header_class_name` instead Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the header of the
toast.
- header_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the header of
the toast.
- header_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the header of the toast.
- 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".
- is_open (boolean; default True):
Whether Toast is currently open.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_dismiss (number; default 0):
An integer that represents the number of times that the dismiss
button has been clicked on.
- n_dismiss_timestamp (number; default -1):
Use of *_timestamp props has been deprecated in Dash in favour of
dash.callback_context. See "How do I determine which Input has
changed?" in the Dash FAQs https://dash.plot.ly/faqs. An integer
that represents the time (in ms since 1970) at which n_dismiss
changed. This can be used to tell which button was changed most
recently.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Toast, default: div.
|
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 this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- bodyClassName (string; optional):
**DEPRECATED** - use `body_class_name` instead. Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the body of the toast.
- body_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the body of
the toast.
- body_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the body of the toast.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; optional):
Toast color, options: primary, secondary, success, info, warning,
danger, light, dark. Default: secondary.
- 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.
- header (a list of or a singular dash component, string or number; optional):
Text to populate the header with.
- headerClassName (string; optional):
**DEPRECATED** - use `header_class_name` instead Often used with
CSS to style elements with common properties. The classes
specified with this prop will be applied to the header of the
toast.
- header_class_name (string; optional):
Often used with CSS to style elements with common properties. The
classes specified with this prop will be applied to the header of
the toast.
- header_style (dict; optional):
Defines CSS styles which will override styles previously set. The
styles set here apply to the header of the toast.
- 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\".
- is_open (boolean; default True):
Whether Toast is currently open.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_dismiss (number; default 0):
An integer that represents the number of times that the dismiss
button has been clicked on.
- n_dismiss_timestamp (number; default -1):
Use of *_timestamp props has been deprecated in Dash in favour of
dash.callback_context. See \"How do I determine which Input has
changed?\" in the Dash FAQs https://dash.plot.ly/faqs. An integer
that represents the time (in ms since 1970) at which n_dismiss
changed. This can be used to tell which button was changed most
recently.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
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 (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Toast, default: div."""
_children_props = ['header']
_base_nodes = ['header', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'Toast'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, header_style=Component.UNDEFINED, header_class_name=Component.UNDEFINED, headerClassName=Component.UNDEFINED, body_style=Component.UNDEFINED, body_class_name=Component.UNDEFINED, bodyClassName=Component.UNDEFINED, tag=Component.UNDEFINED, is_open=Component.UNDEFINED, key=Component.UNDEFINED, header=Component.UNDEFINED, dismissable=Component.UNDEFINED, duration=Component.UNDEFINED, n_dismiss=Component.UNDEFINED, n_dismiss_timestamp=Component.UNDEFINED, icon=Component.UNDEFINED, color=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'bodyClassName', 'body_class_name', 'body_style', 'className', 'class_name', 'color', 'dismissable', 'duration', 'header', 'headerClassName', 'header_class_name', 'header_style', 'icon', 'is_open', 'key', 'loading_state', 'n_dismiss', 'n_dismiss_timestamp', 'persisted_props', 'persistence', 'persistence_type', 'style', 'tag']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'bodyClassName', 'body_class_name', 'body_style', 'className', 'class_name', 'color', 'dismissable', 'duration', 'header', 'headerClassName', 'header_class_name', 'header_style', 'icon', 'is_open', 'key', 'loading_state', 'n_dismiss', 'n_dismiss_timestamp', 'persisted_props', 'persistence', 'persistence_type', 'style', '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 if k != 'children'}
super(Toast, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, header_style=undefined, header_class_name=undefined, headerClassName=undefined, body_style=undefined, body_class_name=undefined, bodyClassName=undefined, tag=undefined, is_open=undefined, key=undefined, header=undefined, dismissable=undefined, duration=undefined, n_dismiss=undefined, n_dismiss_timestamp=undefined, icon=undefined, color=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
61,458 |
dash_bootstrap_components._components.Tooltip
|
Tooltip
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autohide (boolean; default True):
Optionally hide tooltip when hovering over tooltip content -
default True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- delay (dict; default {show: 0, hide: 50}):
Control the delay of hide and show events.
`delay` is a dict with keys:
- hide (number; optional)
- show (number; optional)
- 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.
- flip (boolean; default True):
Whether to flip the direction of the popover if too close to the
container edge, default True.
- is_open (boolean; optional):
Whether the Tooltip is open or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string | dict; optional):
The id of the element to attach the tooltip to.
- 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".
|
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 component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- autohide (boolean; default True):
Optionally hide tooltip when hovering over tooltip content -
default True.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- delay (dict; default {show: 0, hide: 50}):
Control the delay of hide and show events.
`delay` is a dict with keys:
- hide (number; optional)
- show (number; optional)
- 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.
- flip (boolean; default True):
Whether to flip the direction of the popover if too close to the
container edge, default True.
- is_open (boolean; optional):
Whether the Tooltip is open or not.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- 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.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- target (string | dict; optional):
The id of the element to attach the tooltip to.
- 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\"."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Tooltip'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, target=Component.UNDEFINED, placement=Component.UNDEFINED, flip=Component.UNDEFINED, delay=Component.UNDEFINED, autohide=Component.UNDEFINED, fade=Component.UNDEFINED, trigger=Component.UNDEFINED, is_open=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'autohide', 'className', 'class_name', 'delay', 'fade', 'flip', 'is_open', 'key', 'loading_state', 'placement', 'style', 'target', 'trigger']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'autohide', 'className', 'class_name', 'delay', 'fade', 'flip', 'is_open', 'key', 'loading_state', 'placement', 'style', 'target', 'trigger']
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)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, target=undefined, placement=undefined, flip=undefined, delay=undefined, autohide=undefined, fade=undefined, trigger=undefined, is_open=undefined, loading_state=undefined, **kwargs)
|
61,480 |
cached_property
|
cached_property
|
A property that is only computed once per instance and then replaces itself
with an ordinary attribute. Deleting the attribute resets the property.
Source: https://github.com/bottlepy/bottle/commit/fa7733e075da0d790d809aa3d2f53071897e6f76
|
class cached_property(object):
"""
A property that is only computed once per instance and then replaces itself
with an ordinary attribute. Deleting the attribute resets the property.
Source: https://github.com/bottlepy/bottle/commit/fa7733e075da0d790d809aa3d2f53071897e6f76
""" # noqa
def __init__(self, func):
self.__doc__ = getattr(func, "__doc__")
self.func = func
def __get__(self, obj, cls):
if obj is None:
return self
if asyncio and asyncio.iscoroutinefunction(self.func):
return self._wrap_in_coroutine(obj)
value = obj.__dict__[self.func.__name__] = self.func(obj)
return value
def _wrap_in_coroutine(self, obj):
@wraps(obj)
@asyncio.coroutine
def wrapper():
future = asyncio.ensure_future(self.func(obj))
obj.__dict__[self.func.__name__] = future
return future
return wrapper()
|
(func)
|
61,481 |
cached_property
|
__get__
| null |
def __get__(self, obj, cls):
if obj is None:
return self
if asyncio and asyncio.iscoroutinefunction(self.func):
return self._wrap_in_coroutine(obj)
value = obj.__dict__[self.func.__name__] = self.func(obj)
return value
|
(self, obj, cls)
|
61,482 |
cached_property
|
__init__
| null |
def __init__(self, func):
self.__doc__ = getattr(func, "__doc__")
self.func = func
|
(self, func)
|
61,483 |
cached_property
|
_wrap_in_coroutine
| null |
def _wrap_in_coroutine(self, obj):
@wraps(obj)
@asyncio.coroutine
def wrapper():
future = asyncio.ensure_future(self.func(obj))
obj.__dict__[self.func.__name__] = future
return future
return wrapper()
|
(self, obj)
|
61,484 |
cached_property
|
cached_property_with_ttl
|
A property that is only computed once per instance and then replaces itself
with an ordinary attribute. Setting the ttl to a number expresses how long
the property will last before being timed out.
|
class cached_property_with_ttl(object):
"""
A property that is only computed once per instance and then replaces itself
with an ordinary attribute. Setting the ttl to a number expresses how long
the property will last before being timed out.
"""
def __init__(self, ttl=None):
if callable(ttl):
func = ttl
ttl = None
else:
func = None
self.ttl = ttl
self._prepare_func(func)
def __call__(self, func):
self._prepare_func(func)
return self
def __get__(self, obj, cls):
if obj is None:
return self
now = time()
obj_dict = obj.__dict__
name = self.__name__
try:
value, last_updated = obj_dict[name]
except KeyError:
pass
else:
ttl_expired = self.ttl and self.ttl < now - last_updated
if not ttl_expired:
return value
value = self.func(obj)
obj_dict[name] = (value, now)
return value
def __delete__(self, obj):
obj.__dict__.pop(self.__name__, None)
def __set__(self, obj, value):
obj.__dict__[self.__name__] = (value, time())
def _prepare_func(self, func):
self.func = func
if func:
self.__doc__ = func.__doc__
self.__name__ = func.__name__
self.__module__ = func.__module__
|
(ttl=None)
|
61,485 |
cached_property
|
__call__
| null |
def __call__(self, func):
self._prepare_func(func)
return self
|
(self, func)
|
61,486 |
cached_property
|
__delete__
| null |
def __delete__(self, obj):
obj.__dict__.pop(self.__name__, None)
|
(self, obj)
|
61,487 |
cached_property
|
__get__
| null |
def __get__(self, obj, cls):
if obj is None:
return self
now = time()
obj_dict = obj.__dict__
name = self.__name__
try:
value, last_updated = obj_dict[name]
except KeyError:
pass
else:
ttl_expired = self.ttl and self.ttl < now - last_updated
if not ttl_expired:
return value
value = self.func(obj)
obj_dict[name] = (value, now)
return value
|
(self, obj, cls)
|
61,488 |
cached_property
|
__init__
| null |
def __init__(self, ttl=None):
if callable(ttl):
func = ttl
ttl = None
else:
func = None
self.ttl = ttl
self._prepare_func(func)
|
(self, ttl=None)
|
61,489 |
cached_property
|
__set__
| null |
def __set__(self, obj, value):
obj.__dict__[self.__name__] = (value, time())
|
(self, obj, value)
|
61,490 |
cached_property
|
_prepare_func
| null |
def _prepare_func(self, func):
self.func = func
if func:
self.__doc__ = func.__doc__
self.__name__ = func.__name__
self.__module__ = func.__module__
|
(self, func)
|
61,498 |
cached_property
|
threaded_cached_property
|
A cached_property version for use in environments where multiple threads
might concurrently try to access the property.
|
class threaded_cached_property(object):
"""
A cached_property version for use in environments where multiple threads
might concurrently try to access the property.
"""
def __init__(self, func):
self.__doc__ = getattr(func, "__doc__")
self.func = func
self.lock = threading.RLock()
def __get__(self, obj, cls):
if obj is None:
return self
obj_dict = obj.__dict__
name = self.func.__name__
with self.lock:
try:
# check if the value was computed before the lock was acquired
return obj_dict[name]
except KeyError:
# if not, do the calculation and release the lock
return obj_dict.setdefault(name, self.func(obj))
|
(func)
|
61,499 |
cached_property
|
__get__
| null |
def __get__(self, obj, cls):
if obj is None:
return self
obj_dict = obj.__dict__
name = self.func.__name__
with self.lock:
try:
# check if the value was computed before the lock was acquired
return obj_dict[name]
except KeyError:
# if not, do the calculation and release the lock
return obj_dict.setdefault(name, self.func(obj))
|
(self, obj, cls)
|
61,500 |
cached_property
|
__init__
| null |
def __init__(self, func):
self.__doc__ = getattr(func, "__doc__")
self.func = func
self.lock = threading.RLock()
|
(self, func)
|
61,501 |
cached_property
|
threaded_cached_property_with_ttl
|
A cached_property version for use in environments where multiple threads
might concurrently try to access the property.
|
class threaded_cached_property_with_ttl(cached_property_with_ttl):
"""
A cached_property version for use in environments where multiple threads
might concurrently try to access the property.
"""
def __init__(self, ttl=None):
super(threaded_cached_property_with_ttl, self).__init__(ttl)
self.lock = threading.RLock()
def __get__(self, obj, cls):
with self.lock:
return super(threaded_cached_property_with_ttl, self).__get__(obj, cls)
|
(ttl=None)
|
61,504 |
cached_property
|
__get__
| null |
def __get__(self, obj, cls):
with self.lock:
return super(threaded_cached_property_with_ttl, self).__get__(obj, cls)
|
(self, obj, cls)
|
61,505 |
cached_property
|
__init__
| null |
def __init__(self, ttl=None):
super(threaded_cached_property_with_ttl, self).__init__(ttl)
self.lock = threading.RLock()
|
(self, ttl=None)
|
61,531 |
textile.core
|
Textile
| null |
class Textile(object):
restricted_url_schemes = ('http', 'https', 'ftp', 'mailto')
unrestricted_url_schemes = restricted_url_schemes + ('file', 'tel',
'callto', 'sftp', 'data')
btag = ('bq', 'bc', 'notextile', 'pre', 'h[1-6]', r'fn\d+', 'p', '###')
btag_lite = ('bq', 'bc', 'p')
note_index = 1
doctype_whitelist = ['xhtml', 'html5']
glyph_definitions = {
'quote_single_open': '‘',
'quote_single_close': '’',
'quote_double_open': '“',
'quote_double_close': '”',
'apostrophe': '’',
'prime': '′',
'prime_double': '″',
'ellipsis': '…',
'ampersand': '&',
'emdash': '—',
'endash': '–',
'dimension': '×',
'trademark': '™',
'registered': '®',
'copyright': '©',
'half': '½',
'quarter': '¼',
'threequarters': '¾',
'degrees': '°',
'plusminus': '±',
}
def __init__(self, restricted=False, lite=False, noimage=False,
get_sizes=False, html_type='xhtml', rel='', block_tags=True):
"""Textile properties that are common to regular textile and
textile_restricted"""
self.restricted = restricted
self.lite = lite
self.noimage = noimage
self.get_sizes = get_sizes
self.fn = {}
self.urlrefs = {}
self.shelf = {}
self.rel = rel
self.html_type = html_type
self.max_span_depth = 5
self.span_depth = 0
uid = uuid.uuid4().hex
self.uid = 'textileRef:{0}:'.format(uid)
self.linkPrefix = '{0}-'.format(uid)
self.linkIndex = 0
self.refCache = {}
self.refIndex = 0
self.block_tags = block_tags
cur = r''
if regex_snippets['cur']: # pragma: no branch
cur = r'(?:[{0}]{1}*)?'.format(regex_snippets['cur'],
regex_snippets['space'])
# We'll be searching for characters that need to be HTML-encoded to
# produce properly valid html. These are the defaults that work in
# most cases. Below, we'll copy this and modify the necessary pieces
# to make it work for characters at the beginning of the string.
self.glyph_search = [
# apostrophe's
re.compile(r"(^|{0}|\))'({0})".format(regex_snippets['wrd']),
flags=re.U),
# back in '88
re.compile(r"({0})'(\d+{1}?)\b(?![.]?[{1}]*?')".format(
regex_snippets['space'], regex_snippets['wrd']),
flags=re.U),
# single opening following an open bracket.
re.compile(r"([([{])'(?=\S)", flags=re.U),
# single closing
re.compile(r"(^|\S)'(?={0}|{1}|<|$)".format(
regex_snippets['space'], pnct_re_s), flags=re.U),
# single opening
re.compile(r"'", re.U),
# double opening following an open bracket. Allows things like
# Hello ["(Mum) & dad"]
re.compile(r'([([{])"(?=\S)', flags=re.U),
# double closing
re.compile(r'(^|\S)"(?={0}|{1}|<|$)'.format(
regex_snippets['space'], pnct_re_s), re.U),
# double opening
re.compile(r'"'),
# ellipsis
re.compile(r'([^.]?)\.{3}'),
# ampersand
re.compile(r'(\s?)&(\s)', re.U),
# em dash
re.compile(r'(\s?)--(\s?)'),
# en dash
re.compile(r' - '),
# dimension sign
re.compile(r'([0-9]+[\])]?[\'"]? ?)[x]( ?[\[(]?)'
r'(?=[+-]?{0}[0-9]*\.?[0-9]+)'.format(cur), flags=re.I | re.U),
# trademark
re.compile(r'(\b ?|{0}|^)[([]TM[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# registered
re.compile(r'(\b ?|{0}|^)[([]R[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# copyright
re.compile(r'(\b ?|{0}|^)[([]C[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# 1/2
re.compile(r'[([]1\/2[])]'),
# 1/4
re.compile(r'[([]1\/4[])]'),
# 3/4
re.compile(r'[([]3\/4[])]'),
# degrees
re.compile(r'[([]o[])]'),
# plus/minus
re.compile(r'[([]\+\/-[])]'),
# 3+ uppercase acronym
re.compile(r'\b([{0}][{1}]{{2,}})\b(?:[(]([^)]*)[)])'.format(
regex_snippets['abr'], regex_snippets['acr']), flags=re.U),
# 3+ uppercase
re.compile(r'({space}|^|[>(;-])([{abr}]{{3,}})([{nab}]*)'
'(?={space}|{pnct}|<|$)(?=[^">]*?(<|$))'.format(**{ 'space':
regex_snippets['space'], 'abr': regex_snippets['abr'],
'nab': regex_snippets['nab'], 'pnct': pnct_re_s}), re.U),
]
# These are the changes that need to be made for characters that occur
# at the beginning of the string.
self.glyph_search_initial = list(self.glyph_search)
# apostrophe's
self.glyph_search_initial[0] = re.compile(r"({0}|\))'({0})".format(
regex_snippets['wrd']), flags=re.U)
# single closing
self.glyph_search_initial[3] = re.compile(r"(\S)'(?={0}|{1}|$)".format(
regex_snippets['space'], pnct_re_s), re.U)
# double closing
self.glyph_search_initial[6] = re.compile(r'(\S)"(?={0}|{1}|<|$)'.format(
regex_snippets['space'], pnct_re_s), re.U)
self.glyph_replace = [x.format(**self.glyph_definitions) for x in (
r'\1{apostrophe}\2', # apostrophe's
r'\1{apostrophe}\2', # back in '88
r'\1{quote_single_open}', # single opening after bracket
r'\1{quote_single_close}', # single closing
r'{quote_single_open}', # single opening
r'\1{quote_double_open}', # double opening after bracket
r'\1{quote_double_close}', # double closing
r'{quote_double_open}', # double opening
r'\1{ellipsis}', # ellipsis
r'\1{ampersand}\2', # ampersand
r'\1{emdash}\2', # em dash
r' {endash} ', # en dash
r'\1{dimension}\2', # dimension sign
r'\1{trademark}', # trademark
r'\1{registered}', # registered
r'\1{copyright}', # copyright
r'{half}', # 1/2
r'{quarter}', # 1/4
r'{threequarters}', # 3/4
r'{degrees}', # degrees
r'{plusminus}', # plus/minus
r'<acronym title="\2">\1</acronym>', # 3+ uppercase acronym
r'\1<span class="caps">{0}:glyph:\2' # 3+ uppercase
r'</span>\3'.format(self.uid),
)]
if self.html_type == 'html5':
self.glyph_replace[21] = r'<abbr title="\2">\1</abbr>'
if self.restricted is True:
self.url_schemes = self.restricted_url_schemes
else:
self.url_schemes = self.unrestricted_url_schemes
all_schemes_re_s = '|'.join([
'(?:{0})'.format(scheme)
for scheme in self.url_schemes
])
self.url_ref_regex = re.compile(
r'(?:(?<=^)|(?<=\s))\[(.+)\]\s?((?:{0}:\/\/|\/)\S+)(?=\s|$)'.format(all_schemes_re_s),
re.U
)
def parse(self, text, rel=None, sanitize=False):
"""Parse the input text as textile and return html output."""
self.notes = OrderedDict()
self.unreferencedNotes = OrderedDict()
self.notelist_cache = OrderedDict()
if text.strip() == '':
return text
if self.restricted:
text = encode_html(text, quotes=False)
text = normalize_newlines(text)
text = text.replace(self.uid, '')
if self.block_tags:
if self.lite:
self.blocktag_whitelist = ['bq', 'p']
text = self.block(text)
else:
self.blocktag_whitelist = [ 'bq', 'p', 'bc', 'notextile',
'pre', 'h[1-6]',
'fn{0}+'.format(regex_snippets['digit']), '###']
text = self.block(text)
text = self.placeNoteLists(text)
else:
# Inline markup (em, strong, sup, sub, del etc).
text = self.span(text)
# Glyph level substitutions (mainly typographic -- " & ' => curly
# quotes, -- => em-dash etc.
text = self.glyphs(text)
if rel:
self.rel = ' rel="{0}"'.format(rel)
text = self.getRefs(text)
if not self.lite:
text = self.placeNoteLists(text)
text = self.retrieve(text)
text = text.replace('{0}:glyph:'.format(self.uid), '')
if sanitize:
text = sanitizer.sanitize(text)
text = self.retrieveURLs(text)
# if the text contains a break tag (<br> or <br />) not followed by
# a newline, replace it with a new style break tag and a newline.
text = re.sub(r'<br( /)?>(?!\n)', '<br />\n', text)
text = text.rstrip('\n')
return text
def table(self, text):
text = "{0}\n\n".format(text)
pattern = re.compile(r'^(?:table(?P<tatts>_?{s}{a}{c})\.'
r'(?P<summary>.*?)\n)?^(?P<rows>{a}{c}\.? ?\|.*\|)'
r'[\s]*\n\n'.format(**{'s': table_span_re_s, 'a': align_re_s,
'c': cls_re_s}), flags=re.S | re.M | re.U)
match = pattern.search(text)
if match:
table = Table(self, **match.groupdict())
return table.process()
return text
def textileLists(self, text):
pattern = re.compile(r'^((?:[*;:]+|[*;:#]*#(?:_|\d+)?){0}[ .].*)$'
r'(?![^#*;:])'.format(cls_re_s), re.U | re.M | re.S)
return pattern.sub(self.fTextileList, text)
def fTextileList(self, match):
text = re.split(r'\n(?=[*#;:])', match.group(), flags=re.M)
pt = ''
result = []
ls = OrderedDict()
for i, line in enumerate(text):
try:
nextline = text[i + 1]
except IndexError:
nextline = ''
m = re.search(r"^(?P<tl>[#*;:]+)(?P<st>_|\d+)?(?P<atts>{0})[ .]"
"(?P<content>.*)$".format(cls_re_s), line, re.S)
if m:
tl, start, atts, content = m.groups()
content = content.strip()
else:
result.append(line)
continue
nl = ''
ltype = list_type(tl)
tl_tags = {';': 'dt', ':': 'dd'}
litem = tl_tags.get(tl[0], 'li')
showitem = len(content) > 0
# handle list continuation/start attribute on ordered lists
if ltype == 'o':
if not hasattr(self, 'olstarts'):
self.olstarts = {tl: 1}
# does the first line of this ol have a start attribute
if len(tl) > len(pt):
# no, set it to 1.
if start is None:
self.olstarts[tl] = 1
# yes, set it to the given number
elif start != '_':
self.olstarts[tl] = int(start)
# we won't need to handle the '_' case, we'll just
# print out the number when it's needed
# put together the start attribute if needed
if len(tl) > len(pt) and start is not None:
start = ' start="{0}"'.format(self.olstarts[tl])
# This will only increment the count for list items, not
# definition items
if showitem:
# Assume properly formatted input
try:
self.olstarts[tl] = self.olstarts[tl] + 1
# if we get here, we've got some poor textile formatting.
# add this type of list to olstarts and assume we'll start
# it at 1. expect screwy output.
except KeyError:
self.olstarts[tl] = 1
nm = re.match(r"^(?P<nextlistitem>[#\*;:]+)(_|[\d]+)?{0}"
r"[ .].*".format(cls_re_s), nextline)
if nm:
nl = nm.group('nextlistitem')
# We need to handle nested definition lists differently. If
# the next tag is a dt (';') of a lower nested level than the
# current dd (':'),
if ';' in pt and ':' in tl:
ls[tl] = 2
atts = pba(atts, restricted=self.restricted)
tabs = '\t' * len(tl)
# If start is still None, set it to '', else leave the value that
# we've already formatted.
start = start or ''
# if this item tag isn't in the list, create a new list and
# item, else just create the item
if tl not in ls:
ls[tl] = 1
itemtag = ("\n{0}\t<{1}>{2}".format(tabs, litem, content) if
showitem else '')
line = "<{0}l{1}{2}>{3}".format(ltype, atts, start, itemtag)
else:
line = ("\t<{0}{1}>{2}".format(litem, atts, content) if
showitem else '')
line = '{0}{1}'.format(tabs, line)
if len(nl) <= len(tl):
if showitem:
line = "{0}</{1}>".format(line, litem)
# work backward through the list closing nested lists/items
for k, v in reversed(list(ls.items())):
if len(k) > len(nl):
if v != 2:
line = "{0}\n{1}</{2}l>".format(line, tabs,
list_type(k))
if len(k) > 1 and v != 2:
line = "{0}</{1}>".format(line, litem)
del ls[k]
# Remember the current Textile tag:
pt = tl
# This else exists in the original php version. I'm not sure how
# to come up with a case where the line would not match. I think
# it may have been necessary due to the way php returns matches.
# else:
#line = "{0}\n".format(line)
result.append(line)
return self.doTagBr(litem, "\n".join(result))
def doTagBr(self, tag, input):
return re.compile(r'<({0})([^>]*?)>(.*)(</\1>)'.format(re.escape(tag)),
re.S).sub(self.doBr, input)
def doPBr(self, in_):
return re.compile(r'<(p)([^>]*?)>(.*)(</\1>)', re.S).sub(self.doBr,
in_)
def doBr(self, match):
content = re.sub(r'(.+)(?:(?<!<br>)|(?<!<br />))\n(?![#*;:\s|])',
r'\1<br />', match.group(3))
return '<{0}{1}>{2}{3}'.format(match.group(1), match.group(2), content,
match.group(4))
def block(self, text):
if not self.lite:
tre = '|'.join(self.btag)
else:
tre = '|'.join(self.btag_lite)
# split the text by two or more newlines, retaining the newlines in the
# split list
text = re.split(r'(\n{2,})', text)
# some blocks, when processed, will ask us to output nothing, if that's
# the case, we'd want to drop the whitespace which follows it.
eat_whitespace = False
# check to see if previous block has already been escaped
escaped = False
# check if multiline paragraph (p..) tags <p>..</p> are added to line
multiline_para = False
tag = 'p'
atts = cite = ext = ''
out = []
for line in text:
# the line is just whitespace, add it to the output, and move on
if not line.strip():
if not eat_whitespace:
out.append(line)
continue
eat_whitespace = False
pattern = (r'^(?P<tag>{0})(?P<atts>{1}{2})\.(?P<ext>\.?)'
r'(?::(?P<cite>\S+))? (?P<content>.*)$'.format(tre,
align_re_s, cls_re_s))
match = re.search(pattern, line, flags=re.S | re.U)
# tag specified on this line.
if match:
# if we had a previous extended tag but not this time, close up
# the tag
if ext and out:
# it's out[-2] because the last element in out is the
# whitespace that preceded this line
if not escaped:
content = encode_html(out[-2], quotes=True)
escaped = True
else:
content = out[-2]
if not multiline_para:
content = generate_tag(block.inner_tag, content,
block.inner_atts)
content = generate_tag(block.outer_tag, content,
block.outer_atts)
out[-2] = content
tag, atts, ext, cite, content = match.groups()
block = Block(self, **match.groupdict())
inner_block = generate_tag(block.inner_tag, block.content,
block.inner_atts)
# code tags and raw text won't be indented inside outer_tag.
if block.inner_tag != 'code' and not has_raw_text(inner_block):
inner_block = "\n\t\t{0}\n\t".format(inner_block)
if ext:
line = block.content
else:
line = generate_tag(block.outer_tag, inner_block,
block.outer_atts)
# pre tags and raw text won't be indented.
if block.outer_tag != 'pre' and not has_raw_text(line):
line = "\t{0}".format(line)
# set having paragraph tags to false
if block.tag == 'p' and ext:
multiline_para = False
# no tag specified
else:
# if we're inside an extended block, add the text from the
# previous line to the front.
if ext and out:
if block.tag == 'p':
line = generate_tag(block.tag, line, block.outer_atts)
multiline_para = True
line = '{0}{1}'.format(out.pop(), line)
# the logic in the if statement below is a bit confusing in
# php-textile. I'm still not sure I understand what the php
# code is doing. Something tells me it's a phpsadness. Anyway,
# this works, and is much easier to understand: if we're not in
# an extension, and the line doesn't begin with a space, treat
# it like a block to insert. Lines that begin with a space are
# not processed as a block.
if not ext and not line[0] == ' ':
block = Block(self, tag, atts, ext, cite, line)
# if the block contains html tags, generate_tag would
# mangle it, so process as is.
if block.tag == 'p' and not has_raw_text(block.content):
line = block.content
else:
line = generate_tag(block.outer_tag, block.content,
block.outer_atts)
line = "\t{0}".format(line)
else:
if block.tag == 'pre' or block.inner_tag == 'code':
line = self.shelve(encode_html(line, quotes=True))
else:
line = self.graf(line)
if block.tag == 'p':
escaped = True
if block.tag == 'p' and ext and not multiline_para:
line = generate_tag(block.tag, line, block.outer_atts)
multiline_para = True
else:
line = self.doPBr(line)
if not block.tag == 'p':
multiline_para = False
line = line.replace('<br>', '<br />')
# if we're in an extended block, and we haven't specified a new
# tag, join this line to the last item of the output
if ext and not match:
last_item = out.pop()
out.append('{0}{1}'.format(last_item, line))
elif not block.eat:
# or if it's a type of block which indicates we shouldn't drop
# it, add it to the output.
out.append(line)
if not ext:
tag = 'p'
atts = ''
cite = ''
# if it's a block we should drop, don't keep the whitespace which
# will come after it.
if block.eat:
eat_whitespace = True
# at this point, we've gone through all the lines. if there's still an
# extension in effect, we close it here
if ext and out and not block.tag == 'p':
block.content = out.pop()
block.process()
final = generate_tag(block.outer_tag, block.content,
block.outer_atts)
out.append(final)
return ''.join(out)
def footnoteRef(self, text):
# somehow php-textile gets away with not capturing the space.
return re.compile(r'(?<=\S)\[(?P<id>{0}+)(?P<nolink>!?)\]'
r'(?P<space>{1}?)'.format(regex_snippets['digit'],
regex_snippets['space']), re.U).sub(self.footnoteID, text)
def footnoteID(self, m):
fn_att = OrderedDict({'class': 'footnote'})
if m.group('id') not in self.fn:
self.fn[m.group('id')] = '{0}{1}'.format(self.linkPrefix,
self._increment_link_index())
fnid = self.fn[m.group('id')]
fn_att['id'] = 'fnrev{0}'.format(fnid)
fnid = self.fn[m.group('id')]
footref = generate_tag('a', m.group('id'), {'href': '#fn{0}'.format(
fnid)})
if '!' == m.group('nolink'):
footref = m.group('id')
footref = generate_tag('sup', footref, fn_att)
return '{0}{1}'.format(footref, m.group('space'))
def glyphs(self, text):
"""
Because of the split command, the regular expressions are different for
when the text at the beginning and the rest of the text.
for example:
let's say the raw text provided is "*Here*'s some textile"
before it gets to this glyphs method, the text has been converted to
"<strong>Here</strong>'s some textile"
When run through the split, we end up with ["<strong>", "Here",
"</strong>", "'s some textile"]. The re.search that follows tells it
not to ignore html tags.
If the single quote is the first character on the line, it's an open
single quote. If it's the first character of one of those splits, it's
an apostrophe or closed single quote, but the regex will bear that out.
A similar situation occurs for double quotes as well.
So, for the first pass, we use the glyph_search_initial set of
regexes. For all remaining passes, we use glyph_search
"""
text = text.rstrip('\n')
result = []
searchlist = self.glyph_search_initial
# split the text by any angle-bracketed tags
for i, line in enumerate(re.compile(r'(<[\w\/!?].*?>)', re.U).split(
text)):
if not i % 2:
for s, r in zip(searchlist, self.glyph_replace):
line = s.sub(r, line)
result.append(line)
if i == 0:
searchlist = self.glyph_search
return ''.join(result)
def getRefs(self, text):
"""Capture and store URL references in self.urlrefs."""
return self.url_ref_regex.sub(self.refs, text)
def refs(self, match):
flag, url = match.groups()
self.urlrefs[flag] = url
return ''
def relURL(self, url):
scheme = urlparse(url)[0]
if scheme and scheme not in self.url_schemes:
return '#'
return url
def shelve(self, text):
self.refIndex = self.refIndex + 1
itemID = '{0}{1}:shelve'.format(self.uid, self.refIndex)
self.shelf[itemID] = text
return itemID
def retrieve(self, text):
while True:
old = text
for k, v in self.shelf.items():
text = text.replace(k, v)
if text == old:
break
return text
def graf(self, text):
if not self.lite:
text = self.noTextile(text)
text = self.code(text)
text = self.getHTMLComments(text)
text = self.getRefs(text)
text = self.links(text)
if not self.noimage:
text = self.image(text)
if not self.lite:
text = self.table(text)
text = self.redcloth_list(text)
text = self.textileLists(text)
text = self.span(text)
text = self.footnoteRef(text)
text = self.noteRef(text)
text = self.glyphs(text)
return text.rstrip('\n')
def links(self, text):
"""For some reason, the part of the regex below that matches the url
does not match a trailing parenthesis. It gets caught by tail, and
we check later to see if it should be included as part of the url."""
text = self.markStartOfLinks(text)
return self.replaceLinks(text)
def markStartOfLinks(self, text):
"""Finds and marks the start of well formed links in the input text."""
# Slice text on '":<not space>' boundaries. These always occur in
# inline links between the link text and the url part and are much more
# infrequent than '"' characters so we have less possible links to
# process.
slice_re = re.compile(r'":(?={0})'.format(regex_snippets['char']))
slices = slice_re.split(text)
output = []
if len(slices) > 1:
# There are never any start of links in the last slice, so pop it
# off (we'll glue it back later).
last_slice = slices.pop()
for s in slices:
# If there is no possible start quote then this slice is not
# a link
if '"' not in s:
output.append(s)
continue
# Cut this slice into possible starting points wherever we find
# a '"' character. Any of these parts could represent the start
# of the link text - we have to find which one.
possible_start_quotes = s.split('"')
# Start our search for the start of the link with the closest
# prior quote mark.
possibility = possible_start_quotes.pop()
# Init the balanced count. If this is still zero at the end of
# our do loop we'll mark the " that caused it to balance as the
# start of the link and move on to the next slice.
balanced = 0
linkparts = []
i = 0
while balanced != 0 or i == 0: # pragma: no branch
# Starting at the end, pop off the previous part of the
# slice's fragments.
# Add this part to those parts that make up the link text.
linkparts.append(possibility)
if len(possibility) > 0:
# did this part inc or dec the balanced count?
if re.search(r'^\S|=$', possibility, flags=re.U): # pragma: no branch
balanced = balanced - 1
if re.search(r'\S$', possibility, flags=re.U): # pragma: no branch
balanced = balanced + 1
try:
possibility = possible_start_quotes.pop()
except IndexError:
break
else:
# If quotes occur next to each other, we get zero
# length strings. eg. ...""Open the door,
# HAL!"":url... In this case we count a zero length in
# the last position as a closing quote and others as
# opening quotes.
if i == 0:
balanced = balanced + 1
else:
balanced = balanced - 1
i = i + 1
try:
possibility = possible_start_quotes.pop()
except IndexError: # pragma: no cover
# If out of possible starting segments we back the
# last one from the linkparts array
linkparts.pop()
break
# If the next possibility is empty or ends in a space
# we have a closing ".
if (possibility == '' or possibility.endswith(' ')):
# force search exit
balanced = 0;
if balanced <= 0:
possible_start_quotes.append(possibility)
break
# Rebuild the link's text by reversing the parts and sticking
# them back together with quotes.
linkparts.reverse()
link_content = '"'.join(linkparts)
# Rebuild the remaining stuff that goes before the link but
# that's already in order.
pre_link = '"'.join(possible_start_quotes)
# Re-assemble the link starts with a specific marker for the
# next regex.
o = '{0}{1}linkStartMarker:"{2}'.format(pre_link, self.uid,
link_content)
output.append(o)
# Add the last part back
output.append(last_slice)
# Re-assemble the full text with the start and end markers
text = '":'.join(output)
return text
def replaceLinks(self, text):
"""Replaces links with tokens and stores them on the shelf."""
stopchars = r"\s|^'\"*"
pattern = r"""
(?P<pre>\[)? # Optionally open with a square bracket eg. Look ["here":url]
{0}linkStartMarker:" # marks start of the link
(?P<inner>(?:.|\n)*?) # grab the content of the inner "..." part of the link, can be anything but
# do not worry about matching class, id, lang or title yet
": # literal ": marks end of atts + text + title block
(?P<urlx>[^{1}]*) # url upto a stopchar
""".format(self.uid, stopchars)
text = re.compile(pattern, flags=re.X | re.U).sub(self.fLink, text)
return text
def fLink(self, m):
in_ = m.group()
pre, inner, url = m.groups()
pre = pre or ''
if inner == '':
return '{0}"{1}":{2}'.format(pre, inner, url)
m = re.search(r'''^
(?P<atts>{0}) # $atts (if any)
{1}* # any optional spaces
(?P<text> # $text is...
(!.+!) # an image
| # else...
.+? # link text
) # end of $text
(?:\((?P<title>[^)]+?)\))? # $title (if any)
$'''.format(cls_re_s, regex_snippets['space']), inner,
flags=re.X | re.U)
atts = (m and m.group('atts')) or ''
text = (m and m.group('text')) or inner
title = (m and m.group('title')) or ''
pop, tight = '', ''
counts = { '[': None, ']': url.count(']'), '(': None, ')': None }
# Look for footnotes or other square-bracket delimited stuff at the end
# of the url...
#
# eg. "text":url][otherstuff... will have "[otherstuff" popped back
# out.
#
# "text":url?q[]=x][123] will have "[123]" popped off the back, the
# remaining closing square brackets will later be tested for balance
if (counts[']']):
m = re.search(r'(?P<url>^.*\])(?P<tight>\[.*?)$', url, flags=re.U)
if m:
url, tight = m.groups()
# Split off any trailing text that isn't part of an array assignment.
# eg. "text":...?q[]=value1&q[]=value2 ... is ok
# "text":...?q[]=value1]following ... would have "following" popped
# back out and the remaining square bracket will later be tested for
# balance
if (counts[']']):
m = re.search(r'(?P<url>^.*\])(?!=)(?P<end>.*?)$', url, flags=re.U)
url = m.group('url')
tight = '{0}{1}'.format(m.group('end'), tight)
# Now we have the array of all the multi-byte chars in the url we will
# parse the uri backwards and pop off any chars that don't belong
# there (like . or , or unmatched brackets of various kinds).
first = True
popped = True
counts[']'] = url.count(']')
url_chars = list(url)
def _endchar(c, pop, popped, url_chars, counts, pre):
"""Textile URL shouldn't end in these characters, we pop them off
the end and push them out the back of the url again."""
pop = '{0}{1}'.format(c, pop)
url_chars.pop()
popped = True
return pop, popped, url_chars, counts, pre
def _rightanglebracket(c, pop, popped, url_chars, counts, pre):
url_chars.pop()
urlLeft = ''.join(url_chars)
m = re.search(r'(?P<url_chars>.*)(?P<tag><\/[a-z]+)$', urlLeft)
url_chars = m.group('url_chars')
pop = '{0}{1}{2}'.format(m.group('tag'), c, pop)
popped = True
return pop, popped, url_chars, counts, pre
def _closingsquarebracket(c, pop, popped, url_chars, counts, pre):
"""If we find a closing square bracket we are going to see if it is
balanced. If it is balanced with matching opening bracket then it
is part of the URL else we spit it back out of the URL."""
# If counts['['] is None, count the occurrences of '['
counts['['] = counts['['] or url.count('[')
if counts['['] == counts[']']:
# It is balanced, so keep it
url_chars.append(c)
else:
# In the case of un-matched closing square brackets we just eat
# it
popped = True
url_chars.pop()
counts[']'] = counts[']'] - 1;
if first: # pragma: no branch
pre = ''
return pop, popped, url_chars, counts, pre
def _closingparenthesis(c, pop, popped, url_chars, counts, pre):
if counts[')'] is None: # pragma: no branch
counts['('] = url.count('(')
counts[')'] = url.count(')')
if counts['('] != counts[')']:
# Unbalanced so spit it out the back end
popped = True
pop = '{0}{1}'.format(url_chars.pop(), pop)
counts[')'] = counts[')'] - 1
return pop, popped, url_chars, counts, pre
def _casesdefault(c, pop, popped, url_chars, counts, pre):
return pop, popped, url_chars, counts, pre
cases = {
'!': _endchar,
'?': _endchar,
':': _endchar,
';': _endchar,
'.': _endchar,
',': _endchar,
'>': _rightanglebracket,
']': _closingsquarebracket,
')': _closingparenthesis,
}
for c in url_chars[-1::-1]: # pragma: no branch
popped = False
pop, popped, url_chars, counts, pre = cases.get(c,
_casesdefault)(c, pop, popped, url_chars, counts, pre)
first = False
if popped is False:
break
url = ''.join(url_chars)
uri_parts = urlsplit(url)
scheme_in_list = uri_parts.scheme in self.url_schemes
valid_scheme = (uri_parts.scheme and scheme_in_list)
if not is_valid_url(url) and not valid_scheme:
return in_.replace('{0}linkStartMarker:'.format(self.uid), '')
if text == '$':
text = url
if "://" in text:
text = text.split("://")[1]
elif ":" in text:
text = text.split(":")[1]
text = text.strip()
title = encode_html(title)
if not self.noimage: # pragma: no branch
text = self.image(text)
text = self.span(text)
text = self.glyphs(text)
url = self.shelveURL(self.encode_url(urlunsplit(uri_parts)))
attributes = parse_attributes(atts, restricted=self.restricted)
attributes['href'] = url
if title:
# if the title contains unicode data, it is annoying to get Python
# 2.6 and all the latter versions working properly. But shelving
# the title is a quick and dirty solution.
attributes['title'] = self.shelve(title)
if self.rel:
attributes['rel'] = self.rel
a_text = generate_tag('a', text, attributes)
a_shelf_id = self.shelve(a_text)
out = '{0}{1}{2}{3}'.format(pre, a_shelf_id, pop, tight)
return out
def encode_url(self, url):
"""
Converts a (unicode) URL to an ASCII URL, with the domain part
IDNA-encoded and the path part %-encoded (as per RFC 3986).
Fixed version of the following code fragment from Stack Overflow:
http://stackoverflow.com/a/804380/72656
"""
# parse it
parsed = urlsplit(url)
if parsed.netloc:
# divide the netloc further
netloc_pattern = re.compile(r"""
(?:(?P<user>[^:@]+)(?::(?P<password>[^:@]+))?@)?
(?P<host>[^:]+)
(?::(?P<port>[0-9]+))?
""", re.X | re.U)
netloc_parsed = netloc_pattern.match(parsed.netloc).groupdict()
else:
netloc_parsed = {'user': '', 'password': '', 'host': '', 'port':
''}
# encode each component
scheme = parsed.scheme
user = netloc_parsed['user'] and quote(netloc_parsed['user'])
password = (netloc_parsed['password'] and
quote(netloc_parsed['password']))
host = netloc_parsed['host']
port = netloc_parsed['port'] and netloc_parsed['port']
# the below splits the path portion of the url by slashes, translates
# percent-encoded characters back into strings, then re-percent-encodes
# what's necessary. Sounds screwy, but the url could include encoded
# slashes, and this is a way to clean that up. It branches for PY2/3
# because the quote and unquote functions expects different input
# types: unicode strings for PY2 and str for PY3.
path_parts = (quote(unquote(pce), b'') for pce in
parsed.path.split('/'))
path = '/'.join(path_parts)
# put it back together
netloc = ''
if user:
netloc = '{0}{1}'.format(netloc, user)
if password:
netloc = '{0}:{1}'.format(netloc, password)
netloc = '{0}@'.format(netloc)
netloc = '{0}{1}'.format(netloc, host)
if port:
netloc = '{0}:{1}'.format(netloc, port)
return urlunsplit((scheme, netloc, path, parsed.query, parsed.fragment))
def span(self, text):
qtags = (r'\*\*', r'\*', r'\?\?', r'\-', r'__',
r'_', r'%', r'\+', r'~', r'\^')
pnct = r""".,"'?!;:‹›«»„“”‚‘’"""
self.span_depth = self.span_depth + 1
if self.span_depth <= self.max_span_depth:
for tag in qtags:
pattern = re.compile(r"""
(?P<pre>^|(?<=[\s>{pnct}\(])|[{{[])
(?P<tag>{tag})(?!{tag})
(?P<atts>{cls})
(?!{tag})
(?::(?P<cite>\S+[^{tag}]{space}))?
(?P<content>[^{space}{tag}]+|\S.*?[^\s{tag}\n])
(?P<end>[{pnct}]*)
{tag}
(?P<tail>$|[\[\]}}<]|(?=[{pnct}]{{1,2}}[^0-9]|\s|\)))
""".format(**{'tag': tag, 'cls': cls_re_s, 'pnct': pnct,
'space': regex_snippets['space']}), flags=re.X | re.U)
text = pattern.sub(self.fSpan, text)
self.span_depth = self.span_depth - 1
return text
def fSpan(self, match):
pre, tag, atts, cite, content, end, tail = match.groups()
qtags = {
'*': 'strong',
'**': 'b',
'??': 'cite',
'_': 'em',
'__': 'i',
'-': 'del',
'%': 'span',
'+': 'ins',
'~': 'sub',
'^': 'sup'
}
tag = qtags[tag]
atts = pba(atts, restricted=self.restricted)
if cite:
atts = '{0} cite="{1}"'.format(atts, cite.rstrip())
content = self.span(content)
out = "<{0}{1}>{2}{3}</{4}>".format(tag, atts, content, end, tag)
if pre and not tail or tail and not pre:
out = '{0}{1}{2}'.format(pre, out, tail)
return out
def image(self, text):
pattern = re.compile(r"""
(?:[\[{{])? # pre
\! # opening !
(\<|\=|\>)? # optional alignment atts
({0}) # optional style,class atts
(?:\.\s)? # optional dot-space
([^\s(!]+) # presume this is the src
\s? # optional space
(?:\(([^\)]+)\))? # optional title
\! # closing
(?::(\S+))? # optional href
(?:[\]}}]|(?=\s|$)) # lookahead: space or end of string
""".format(cls_re_s), re.U | re.X)
return pattern.sub(self.fImage, text)
def fImage(self, match):
# (None, '', '/imgs/myphoto.jpg', None, None)
align, attributes, url, title, href = match.groups()
atts = OrderedDict()
size = None
alignments = {'<': 'left', '=': 'center', '>': 'right'}
if not title:
title = ''
if not is_rel_url(url) and self.get_sizes:
size = imagesize.getimagesize(url)
if href:
href = self.shelveURL(href)
url = self.shelveURL(url)
if align:
atts.update(align=alignments[align])
atts.update(alt=title)
if size:
atts.update(height="{0}".format(size[1]))
atts.update(src=url)
if attributes:
atts.update(parse_attributes(attributes, restricted=self.restricted))
if title:
atts.update(title=title)
if size:
atts.update(width="{0}".format(size[0]))
img = generate_tag('img', ' /', atts)
if href:
a_atts = OrderedDict(href=href)
if self.rel:
a_atts.update(rel=self.rel)
img = generate_tag('a', img, a_atts)
return img
def code(self, text):
text = self.doSpecial(text, '<code>', '</code>', self.fCode)
text = self.doSpecial(text, '@', '@', self.fCode)
text = self.doSpecial(text, '<pre>', '</pre>', self.fPre)
return text
def fCode(self, match):
before, text, after = match.groups()
after = after or ''
# text needs to be escaped
text = encode_html(text, quotes=False)
return ''.join([before, self.shelve('<code>{0}</code>'.format(text)), after])
def fPre(self, match):
before, text, after = match.groups()
if after is None:
after = ''
# text needs to be escaped
text = encode_html(text)
return ''.join([before, '<pre>', self.shelve(text), '</pre>', after])
def doSpecial(self, text, start, end, method):
pattern = re.compile(r'(^|\s|[\[({{>|]){0}(.*?){1}($|[\])}}])?'.format(
re.escape(start), re.escape(end)), re.M | re.S)
return pattern.sub(method, text)
def noTextile(self, text):
text = self.doSpecial(text, '<notextile>', '</notextile>',
self.fTextile)
return self.doSpecial(text, '==', '==', self.fTextile)
def fTextile(self, match):
before, notextile, after = match.groups()
if after is None: # pragma: no branch
after = ''
return ''.join([before, self.shelve(notextile), after])
def getHTMLComments(self, text):
"""Search the string for HTML comments, e.g. <!-- comment text -->. We
send the text that matches this to fParseHTMLComments."""
return self.doSpecial(text, '<!--', '-->', self.fParseHTMLComments)
def fParseHTMLComments(self, match):
"""If self.restricted is True, clean the matched contents of the HTML
comment. Otherwise, return the comments unchanged.
The original php had an if statement in here regarding restricted mode.
nose reported that this line wasn't covered. It's correct. In
restricted mode, the html comment tags have already been converted to
<!*#8212; and —> so they don't match in getHTMLComments,
and never arrive here.
"""
before, commenttext, after = match.groups()
commenttext = self.shelve(commenttext)
return '{0}<!--{1}-->'.format(before, commenttext)
def redcloth_list(self, text):
"""Parse the text for definition lists and send them to be
formatted."""
pattern = re.compile(r"^([-]+{0}[ .].*:=.*)$(?![^-])".format(cls_re_s),
re.M | re.U | re.S)
return pattern.sub(self.fRCList, text)
def fRCList(self, match):
"""Format a definition list."""
out = []
text = re.split(r'\n(?=[-])', match.group(), flags=re.M)
for line in text:
# parse the attributes and content
m = re.match(r'^[-]+({0})[ .](.*)$'.format(cls_re_s), line,
flags=re.M | re.S)
if not m:
continue
atts, content = m.groups()
# cleanup
content = content.strip()
atts = pba(atts, restricted=self.restricted)
# split the content into the term and definition
xm = re.match(r'^(.*?)[\s]*:=(.*?)[\s]*(=:|:=)?[\s]*$', content,
re.S)
term, definition, ending = xm.groups()
# cleanup
term = term.strip()
definition = definition.strip(' ')
# if this is the first time through, out as a bool is False
if not out:
if definition == '':
dltag = "<dl{0}>".format(atts)
else:
dltag = "<dl>"
out.append(dltag)
if definition != '' and term != '':
if definition.startswith('\n'):
definition = '<p>{0}</p>'.format(definition.lstrip())
definition = definition.replace('\n', '<br />').strip()
term = self.graf(term)
definition = self.graf(definition)
out.extend(['\t<dt{0}>{1}</dt>'.format(atts, term),
'\t<dd>{0}</dd>'.format(definition)])
out.append('</dl>')
out = '\n'.join(out)
return out
def placeNoteLists(self, text):
"""Parse the text for endnotes."""
if self.notes:
o = OrderedDict()
for label, info in self.notes.items():
if 'seq' in info:
i = info['seq']
info['seq'] = label
o[i] = info
else:
self.unreferencedNotes[label] = info
if o: # pragma: no branch
# sort o by key
o = OrderedDict(sorted(o.items(), key=lambda t: t[0]))
self.notes = o
text_re = re.compile(r'<p>notelist({0})(?:\:([\w|{1}]))?([\^!]?)(\+?)'
r'\.?[\s]*</p>'.format(cls_re_s, syms_re_s), re.U)
text = text_re.sub(self.fNoteLists, text)
return text
def fNoteLists(self, match):
"""Given the text that matches as a note, format it into HTML."""
att, start_char, g_links, extras = match.groups()
start_char = start_char or 'a'
index = '{0}{1}{2}'.format(g_links, extras, start_char)
result = ''
if index not in self.notelist_cache: # pragma: no branch
o = []
if self.notes: # pragma: no branch
for seq, info in self.notes.items():
links = self.makeBackrefLink(info, g_links, start_char)
atts = ''
if 'def' in info:
infoid = info['id']
atts = info['def']['atts']
content = info['def']['content']
li = ('\t\t<li{0}>{1}<span id="note{2}"> '
'</span>{3}</li>').format(atts, links, infoid,
content)
else:
li = ('\t\t<li{0}>{1} Undefined Note [#{2}].<li>'
).format(atts, links, info['seq'])
o.append(li)
if '+' == extras and self.unreferencedNotes:
for seq, info in self.unreferencedNotes.items():
atts = info['def']['atts']
content = info['def']['content']
li = '\t\t<li{0}>{1}</li>'.format(atts, content)
o.append(li)
self.notelist_cache[index] = "\n".join(o)
result = self.notelist_cache[index]
list_atts = pba(att, restricted=self.restricted)
result = '<ol{0}>\n{1}\n\t</ol>'.format(list_atts, result)
return result
def makeBackrefLink(self, info, g_links, i):
"""Given the pieces of a back reference link, create an <a> tag."""
atts, content, infoid, link = '', '', '', ''
if 'def' in info:
link = info['def']['link']
backlink_type = link or g_links
i_ = encode_high(i)
allow_inc = i not in syms_re_s
i_ = int(i_)
if backlink_type == "!":
return ''
elif backlink_type == '^':
return """<sup><a href="#noteref{0}">{1}</a></sup>""".format(
info['refids'][0], i)
else:
result = []
for refid in info['refids']:
i_entity = decode_high(i_)
sup = """<sup><a href="#noteref{0}">{1}</a></sup>""".format(
refid, i_entity)
if allow_inc:
i_ = i_ + 1
result.append(sup)
result = ' '.join(result)
return result
def fParseNoteDefs(self, m):
"""Parse the note definitions and format them as HTML"""
label = m.group('label')
link = m.group('link')
att = m.group('att')
content = m.group('content')
# Assign an id if the note reference parse hasn't found the label yet.
if label not in self.notes:
self.notes[label] = {'id': '{0}{1}'.format(self.linkPrefix,
self._increment_link_index())}
# Ignores subsequent defs using the same label
if 'def' not in self.notes[label]: # pragma: no branch
self.notes[label]['def'] = {'atts': pba(att, restricted=self.restricted), 'content':
self.graf(content), 'link': link}
return ''
def noteRef(self, text):
"""Search the text looking for note references."""
text_re = re.compile(r"""
\[ # start
({0}) # !atts
\#
([^\]!]+) # !label
([!]?) # !nolink
\]""".format(cls_re_s), re.X)
text = text_re.sub(self.fParseNoteRefs, text)
return text
def fParseNoteRefs(self, match):
"""Parse and format the matched text into note references.
By the time this function is called, all the defs will have been
processed into the notes array. So now we can resolve the link numbers
in the order we process the refs..."""
atts, label, nolink = match.groups()
atts = pba(atts, restricted=self.restricted)
nolink = nolink == '!'
# Assign a sequence number to this reference if there isn't one already
if label in self.notes:
num = self.notes[label]['seq']
else:
self.notes[label] = {
'seq': self.note_index, 'refids': [], 'id': ''
}
num = self.note_index
self.note_index = self.note_index + 1
# Make our anchor point and stash it for possible use in backlinks when
# the note list is generated later...
refid = '{0}{1}'.format(self.linkPrefix, self._increment_link_index())
self.notes[label]['refids'].append(refid)
# If we are referencing a note that hasn't had the definition parsed
# yet, then assign it an ID...
if not self.notes[label]['id']:
self.notes[label]['id'] = '{0}{1}'.format(self.linkPrefix,
self._increment_link_index())
labelid = self.notes[label]['id']
# Build the link (if any)...
result = '<span id="noteref{0}">{1}</span>'.format(refid, num)
if not nolink:
result = '<a href="#note{0}">{1}</a>'.format(labelid, result)
# Build the reference...
result = '<sup{0}>{1}</sup>'.format(atts, result)
return result
def shelveURL(self, text):
if text == '':
return ''
self.refIndex = self.refIndex + 1
self.refCache[self.refIndex] = text
output = '{0}{1}{2}'.format(self.uid, self.refIndex, ':url')
return output
def retrieveURLs(self, text):
return re.sub(r'{0}(?P<token>[0-9]+):url'.format(self.uid), self.retrieveURL, text)
def retrieveURL(self, match):
url = self.refCache.get(int(match.group('token')), '')
if url == '':
return url
if url in self.urlrefs:
url = self.urlrefs[url]
return url
def _increment_link_index(self):
"""The self.linkIndex property needs to be incremented in various
places. Don't Repeat Yourself."""
self.linkIndex = self.linkIndex + 1
return self.linkIndex
|
(restricted=False, lite=False, noimage=False, get_sizes=False, html_type='xhtml', rel='', block_tags=True)
|
61,532 |
textile.core
|
__init__
|
Textile properties that are common to regular textile and
textile_restricted
|
def __init__(self, restricted=False, lite=False, noimage=False,
get_sizes=False, html_type='xhtml', rel='', block_tags=True):
"""Textile properties that are common to regular textile and
textile_restricted"""
self.restricted = restricted
self.lite = lite
self.noimage = noimage
self.get_sizes = get_sizes
self.fn = {}
self.urlrefs = {}
self.shelf = {}
self.rel = rel
self.html_type = html_type
self.max_span_depth = 5
self.span_depth = 0
uid = uuid.uuid4().hex
self.uid = 'textileRef:{0}:'.format(uid)
self.linkPrefix = '{0}-'.format(uid)
self.linkIndex = 0
self.refCache = {}
self.refIndex = 0
self.block_tags = block_tags
cur = r''
if regex_snippets['cur']: # pragma: no branch
cur = r'(?:[{0}]{1}*)?'.format(regex_snippets['cur'],
regex_snippets['space'])
# We'll be searching for characters that need to be HTML-encoded to
# produce properly valid html. These are the defaults that work in
# most cases. Below, we'll copy this and modify the necessary pieces
# to make it work for characters at the beginning of the string.
self.glyph_search = [
# apostrophe's
re.compile(r"(^|{0}|\))'({0})".format(regex_snippets['wrd']),
flags=re.U),
# back in '88
re.compile(r"({0})'(\d+{1}?)\b(?![.]?[{1}]*?')".format(
regex_snippets['space'], regex_snippets['wrd']),
flags=re.U),
# single opening following an open bracket.
re.compile(r"([([{])'(?=\S)", flags=re.U),
# single closing
re.compile(r"(^|\S)'(?={0}|{1}|<|$)".format(
regex_snippets['space'], pnct_re_s), flags=re.U),
# single opening
re.compile(r"'", re.U),
# double opening following an open bracket. Allows things like
# Hello ["(Mum) & dad"]
re.compile(r'([([{])"(?=\S)', flags=re.U),
# double closing
re.compile(r'(^|\S)"(?={0}|{1}|<|$)'.format(
regex_snippets['space'], pnct_re_s), re.U),
# double opening
re.compile(r'"'),
# ellipsis
re.compile(r'([^.]?)\.{3}'),
# ampersand
re.compile(r'(\s?)&(\s)', re.U),
# em dash
re.compile(r'(\s?)--(\s?)'),
# en dash
re.compile(r' - '),
# dimension sign
re.compile(r'([0-9]+[\])]?[\'"]? ?)[x]( ?[\[(]?)'
r'(?=[+-]?{0}[0-9]*\.?[0-9]+)'.format(cur), flags=re.I | re.U),
# trademark
re.compile(r'(\b ?|{0}|^)[([]TM[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# registered
re.compile(r'(\b ?|{0}|^)[([]R[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# copyright
re.compile(r'(\b ?|{0}|^)[([]C[])]'.format(regex_snippets['space']
), flags=re.I | re.U),
# 1/2
re.compile(r'[([]1\/2[])]'),
# 1/4
re.compile(r'[([]1\/4[])]'),
# 3/4
re.compile(r'[([]3\/4[])]'),
# degrees
re.compile(r'[([]o[])]'),
# plus/minus
re.compile(r'[([]\+\/-[])]'),
# 3+ uppercase acronym
re.compile(r'\b([{0}][{1}]{{2,}})\b(?:[(]([^)]*)[)])'.format(
regex_snippets['abr'], regex_snippets['acr']), flags=re.U),
# 3+ uppercase
re.compile(r'({space}|^|[>(;-])([{abr}]{{3,}})([{nab}]*)'
'(?={space}|{pnct}|<|$)(?=[^">]*?(<|$))'.format(**{ 'space':
regex_snippets['space'], 'abr': regex_snippets['abr'],
'nab': regex_snippets['nab'], 'pnct': pnct_re_s}), re.U),
]
# These are the changes that need to be made for characters that occur
# at the beginning of the string.
self.glyph_search_initial = list(self.glyph_search)
# apostrophe's
self.glyph_search_initial[0] = re.compile(r"({0}|\))'({0})".format(
regex_snippets['wrd']), flags=re.U)
# single closing
self.glyph_search_initial[3] = re.compile(r"(\S)'(?={0}|{1}|$)".format(
regex_snippets['space'], pnct_re_s), re.U)
# double closing
self.glyph_search_initial[6] = re.compile(r'(\S)"(?={0}|{1}|<|$)'.format(
regex_snippets['space'], pnct_re_s), re.U)
self.glyph_replace = [x.format(**self.glyph_definitions) for x in (
r'\1{apostrophe}\2', # apostrophe's
r'\1{apostrophe}\2', # back in '88
r'\1{quote_single_open}', # single opening after bracket
r'\1{quote_single_close}', # single closing
r'{quote_single_open}', # single opening
r'\1{quote_double_open}', # double opening after bracket
r'\1{quote_double_close}', # double closing
r'{quote_double_open}', # double opening
r'\1{ellipsis}', # ellipsis
r'\1{ampersand}\2', # ampersand
r'\1{emdash}\2', # em dash
r' {endash} ', # en dash
r'\1{dimension}\2', # dimension sign
r'\1{trademark}', # trademark
r'\1{registered}', # registered
r'\1{copyright}', # copyright
r'{half}', # 1/2
r'{quarter}', # 1/4
r'{threequarters}', # 3/4
r'{degrees}', # degrees
r'{plusminus}', # plus/minus
r'<acronym title="\2">\1</acronym>', # 3+ uppercase acronym
r'\1<span class="caps">{0}:glyph:\2' # 3+ uppercase
r'</span>\3'.format(self.uid),
)]
if self.html_type == 'html5':
self.glyph_replace[21] = r'<abbr title="\2">\1</abbr>'
if self.restricted is True:
self.url_schemes = self.restricted_url_schemes
else:
self.url_schemes = self.unrestricted_url_schemes
all_schemes_re_s = '|'.join([
'(?:{0})'.format(scheme)
for scheme in self.url_schemes
])
self.url_ref_regex = re.compile(
r'(?:(?<=^)|(?<=\s))\[(.+)\]\s?((?:{0}:\/\/|\/)\S+)(?=\s|$)'.format(all_schemes_re_s),
re.U
)
|
(self, restricted=False, lite=False, noimage=False, get_sizes=False, html_type='xhtml', rel='', block_tags=True)
|
61,533 |
textile.core
|
_increment_link_index
|
The self.linkIndex property needs to be incremented in various
places. Don't Repeat Yourself.
|
def _increment_link_index(self):
"""The self.linkIndex property needs to be incremented in various
places. Don't Repeat Yourself."""
self.linkIndex = self.linkIndex + 1
return self.linkIndex
|
(self)
|
61,534 |
textile.core
|
block
| null |
def block(self, text):
if not self.lite:
tre = '|'.join(self.btag)
else:
tre = '|'.join(self.btag_lite)
# split the text by two or more newlines, retaining the newlines in the
# split list
text = re.split(r'(\n{2,})', text)
# some blocks, when processed, will ask us to output nothing, if that's
# the case, we'd want to drop the whitespace which follows it.
eat_whitespace = False
# check to see if previous block has already been escaped
escaped = False
# check if multiline paragraph (p..) tags <p>..</p> are added to line
multiline_para = False
tag = 'p'
atts = cite = ext = ''
out = []
for line in text:
# the line is just whitespace, add it to the output, and move on
if not line.strip():
if not eat_whitespace:
out.append(line)
continue
eat_whitespace = False
pattern = (r'^(?P<tag>{0})(?P<atts>{1}{2})\.(?P<ext>\.?)'
r'(?::(?P<cite>\S+))? (?P<content>.*)$'.format(tre,
align_re_s, cls_re_s))
match = re.search(pattern, line, flags=re.S | re.U)
# tag specified on this line.
if match:
# if we had a previous extended tag but not this time, close up
# the tag
if ext and out:
# it's out[-2] because the last element in out is the
# whitespace that preceded this line
if not escaped:
content = encode_html(out[-2], quotes=True)
escaped = True
else:
content = out[-2]
if not multiline_para:
content = generate_tag(block.inner_tag, content,
block.inner_atts)
content = generate_tag(block.outer_tag, content,
block.outer_atts)
out[-2] = content
tag, atts, ext, cite, content = match.groups()
block = Block(self, **match.groupdict())
inner_block = generate_tag(block.inner_tag, block.content,
block.inner_atts)
# code tags and raw text won't be indented inside outer_tag.
if block.inner_tag != 'code' and not has_raw_text(inner_block):
inner_block = "\n\t\t{0}\n\t".format(inner_block)
if ext:
line = block.content
else:
line = generate_tag(block.outer_tag, inner_block,
block.outer_atts)
# pre tags and raw text won't be indented.
if block.outer_tag != 'pre' and not has_raw_text(line):
line = "\t{0}".format(line)
# set having paragraph tags to false
if block.tag == 'p' and ext:
multiline_para = False
# no tag specified
else:
# if we're inside an extended block, add the text from the
# previous line to the front.
if ext and out:
if block.tag == 'p':
line = generate_tag(block.tag, line, block.outer_atts)
multiline_para = True
line = '{0}{1}'.format(out.pop(), line)
# the logic in the if statement below is a bit confusing in
# php-textile. I'm still not sure I understand what the php
# code is doing. Something tells me it's a phpsadness. Anyway,
# this works, and is much easier to understand: if we're not in
# an extension, and the line doesn't begin with a space, treat
# it like a block to insert. Lines that begin with a space are
# not processed as a block.
if not ext and not line[0] == ' ':
block = Block(self, tag, atts, ext, cite, line)
# if the block contains html tags, generate_tag would
# mangle it, so process as is.
if block.tag == 'p' and not has_raw_text(block.content):
line = block.content
else:
line = generate_tag(block.outer_tag, block.content,
block.outer_atts)
line = "\t{0}".format(line)
else:
if block.tag == 'pre' or block.inner_tag == 'code':
line = self.shelve(encode_html(line, quotes=True))
else:
line = self.graf(line)
if block.tag == 'p':
escaped = True
if block.tag == 'p' and ext and not multiline_para:
line = generate_tag(block.tag, line, block.outer_atts)
multiline_para = True
else:
line = self.doPBr(line)
if not block.tag == 'p':
multiline_para = False
line = line.replace('<br>', '<br />')
# if we're in an extended block, and we haven't specified a new
# tag, join this line to the last item of the output
if ext and not match:
last_item = out.pop()
out.append('{0}{1}'.format(last_item, line))
elif not block.eat:
# or if it's a type of block which indicates we shouldn't drop
# it, add it to the output.
out.append(line)
if not ext:
tag = 'p'
atts = ''
cite = ''
# if it's a block we should drop, don't keep the whitespace which
# will come after it.
if block.eat:
eat_whitespace = True
# at this point, we've gone through all the lines. if there's still an
# extension in effect, we close it here
if ext and out and not block.tag == 'p':
block.content = out.pop()
block.process()
final = generate_tag(block.outer_tag, block.content,
block.outer_atts)
out.append(final)
return ''.join(out)
|
(self, text)
|
61,535 |
textile.core
|
code
| null |
def code(self, text):
text = self.doSpecial(text, '<code>', '</code>', self.fCode)
text = self.doSpecial(text, '@', '@', self.fCode)
text = self.doSpecial(text, '<pre>', '</pre>', self.fPre)
return text
|
(self, text)
|
61,536 |
textile.core
|
doBr
| null |
def doBr(self, match):
content = re.sub(r'(.+)(?:(?<!<br>)|(?<!<br />))\n(?![#*;:\s|])',
r'\1<br />', match.group(3))
return '<{0}{1}>{2}{3}'.format(match.group(1), match.group(2), content,
match.group(4))
|
(self, match)
|
61,537 |
textile.core
|
doPBr
| null |
def doPBr(self, in_):
return re.compile(r'<(p)([^>]*?)>(.*)(</\1>)', re.S).sub(self.doBr,
in_)
|
(self, in_)
|
61,538 |
textile.core
|
doSpecial
| null |
def doSpecial(self, text, start, end, method):
pattern = re.compile(r'(^|\s|[\[({{>|]){0}(.*?){1}($|[\])}}])?'.format(
re.escape(start), re.escape(end)), re.M | re.S)
return pattern.sub(method, text)
|
(self, text, start, end, method)
|
61,539 |
textile.core
|
doTagBr
| null |
def doTagBr(self, tag, input):
return re.compile(r'<({0})([^>]*?)>(.*)(</\1>)'.format(re.escape(tag)),
re.S).sub(self.doBr, input)
|
(self, tag, input)
|
61,540 |
textile.core
|
encode_url
|
Converts a (unicode) URL to an ASCII URL, with the domain part
IDNA-encoded and the path part %-encoded (as per RFC 3986).
Fixed version of the following code fragment from Stack Overflow:
http://stackoverflow.com/a/804380/72656
|
def encode_url(self, url):
"""
Converts a (unicode) URL to an ASCII URL, with the domain part
IDNA-encoded and the path part %-encoded (as per RFC 3986).
Fixed version of the following code fragment from Stack Overflow:
http://stackoverflow.com/a/804380/72656
"""
# parse it
parsed = urlsplit(url)
if parsed.netloc:
# divide the netloc further
netloc_pattern = re.compile(r"""
(?:(?P<user>[^:@]+)(?::(?P<password>[^:@]+))?@)?
(?P<host>[^:]+)
(?::(?P<port>[0-9]+))?
""", re.X | re.U)
netloc_parsed = netloc_pattern.match(parsed.netloc).groupdict()
else:
netloc_parsed = {'user': '', 'password': '', 'host': '', 'port':
''}
# encode each component
scheme = parsed.scheme
user = netloc_parsed['user'] and quote(netloc_parsed['user'])
password = (netloc_parsed['password'] and
quote(netloc_parsed['password']))
host = netloc_parsed['host']
port = netloc_parsed['port'] and netloc_parsed['port']
# the below splits the path portion of the url by slashes, translates
# percent-encoded characters back into strings, then re-percent-encodes
# what's necessary. Sounds screwy, but the url could include encoded
# slashes, and this is a way to clean that up. It branches for PY2/3
# because the quote and unquote functions expects different input
# types: unicode strings for PY2 and str for PY3.
path_parts = (quote(unquote(pce), b'') for pce in
parsed.path.split('/'))
path = '/'.join(path_parts)
# put it back together
netloc = ''
if user:
netloc = '{0}{1}'.format(netloc, user)
if password:
netloc = '{0}:{1}'.format(netloc, password)
netloc = '{0}@'.format(netloc)
netloc = '{0}{1}'.format(netloc, host)
if port:
netloc = '{0}:{1}'.format(netloc, port)
return urlunsplit((scheme, netloc, path, parsed.query, parsed.fragment))
|
(self, url)
|
61,541 |
textile.core
|
fCode
| null |
def fCode(self, match):
before, text, after = match.groups()
after = after or ''
# text needs to be escaped
text = encode_html(text, quotes=False)
return ''.join([before, self.shelve('<code>{0}</code>'.format(text)), after])
|
(self, match)
|
61,542 |
textile.core
|
fImage
| null |
def fImage(self, match):
# (None, '', '/imgs/myphoto.jpg', None, None)
align, attributes, url, title, href = match.groups()
atts = OrderedDict()
size = None
alignments = {'<': 'left', '=': 'center', '>': 'right'}
if not title:
title = ''
if not is_rel_url(url) and self.get_sizes:
size = imagesize.getimagesize(url)
if href:
href = self.shelveURL(href)
url = self.shelveURL(url)
if align:
atts.update(align=alignments[align])
atts.update(alt=title)
if size:
atts.update(height="{0}".format(size[1]))
atts.update(src=url)
if attributes:
atts.update(parse_attributes(attributes, restricted=self.restricted))
if title:
atts.update(title=title)
if size:
atts.update(width="{0}".format(size[0]))
img = generate_tag('img', ' /', atts)
if href:
a_atts = OrderedDict(href=href)
if self.rel:
a_atts.update(rel=self.rel)
img = generate_tag('a', img, a_atts)
return img
|
(self, match)
|
61,543 |
textile.core
|
fLink
| null |
def fLink(self, m):
in_ = m.group()
pre, inner, url = m.groups()
pre = pre or ''
if inner == '':
return '{0}"{1}":{2}'.format(pre, inner, url)
m = re.search(r'''^
(?P<atts>{0}) # $atts (if any)
{1}* # any optional spaces
(?P<text> # $text is...
(!.+!) # an image
| # else...
.+? # link text
) # end of $text
(?:\((?P<title>[^)]+?)\))? # $title (if any)
$'''.format(cls_re_s, regex_snippets['space']), inner,
flags=re.X | re.U)
atts = (m and m.group('atts')) or ''
text = (m and m.group('text')) or inner
title = (m and m.group('title')) or ''
pop, tight = '', ''
counts = { '[': None, ']': url.count(']'), '(': None, ')': None }
# Look for footnotes or other square-bracket delimited stuff at the end
# of the url...
#
# eg. "text":url][otherstuff... will have "[otherstuff" popped back
# out.
#
# "text":url?q[]=x][123] will have "[123]" popped off the back, the
# remaining closing square brackets will later be tested for balance
if (counts[']']):
m = re.search(r'(?P<url>^.*\])(?P<tight>\[.*?)$', url, flags=re.U)
if m:
url, tight = m.groups()
# Split off any trailing text that isn't part of an array assignment.
# eg. "text":...?q[]=value1&q[]=value2 ... is ok
# "text":...?q[]=value1]following ... would have "following" popped
# back out and the remaining square bracket will later be tested for
# balance
if (counts[']']):
m = re.search(r'(?P<url>^.*\])(?!=)(?P<end>.*?)$', url, flags=re.U)
url = m.group('url')
tight = '{0}{1}'.format(m.group('end'), tight)
# Now we have the array of all the multi-byte chars in the url we will
# parse the uri backwards and pop off any chars that don't belong
# there (like . or , or unmatched brackets of various kinds).
first = True
popped = True
counts[']'] = url.count(']')
url_chars = list(url)
def _endchar(c, pop, popped, url_chars, counts, pre):
"""Textile URL shouldn't end in these characters, we pop them off
the end and push them out the back of the url again."""
pop = '{0}{1}'.format(c, pop)
url_chars.pop()
popped = True
return pop, popped, url_chars, counts, pre
def _rightanglebracket(c, pop, popped, url_chars, counts, pre):
url_chars.pop()
urlLeft = ''.join(url_chars)
m = re.search(r'(?P<url_chars>.*)(?P<tag><\/[a-z]+)$', urlLeft)
url_chars = m.group('url_chars')
pop = '{0}{1}{2}'.format(m.group('tag'), c, pop)
popped = True
return pop, popped, url_chars, counts, pre
def _closingsquarebracket(c, pop, popped, url_chars, counts, pre):
"""If we find a closing square bracket we are going to see if it is
balanced. If it is balanced with matching opening bracket then it
is part of the URL else we spit it back out of the URL."""
# If counts['['] is None, count the occurrences of '['
counts['['] = counts['['] or url.count('[')
if counts['['] == counts[']']:
# It is balanced, so keep it
url_chars.append(c)
else:
# In the case of un-matched closing square brackets we just eat
# it
popped = True
url_chars.pop()
counts[']'] = counts[']'] - 1;
if first: # pragma: no branch
pre = ''
return pop, popped, url_chars, counts, pre
def _closingparenthesis(c, pop, popped, url_chars, counts, pre):
if counts[')'] is None: # pragma: no branch
counts['('] = url.count('(')
counts[')'] = url.count(')')
if counts['('] != counts[')']:
# Unbalanced so spit it out the back end
popped = True
pop = '{0}{1}'.format(url_chars.pop(), pop)
counts[')'] = counts[')'] - 1
return pop, popped, url_chars, counts, pre
def _casesdefault(c, pop, popped, url_chars, counts, pre):
return pop, popped, url_chars, counts, pre
cases = {
'!': _endchar,
'?': _endchar,
':': _endchar,
';': _endchar,
'.': _endchar,
',': _endchar,
'>': _rightanglebracket,
']': _closingsquarebracket,
')': _closingparenthesis,
}
for c in url_chars[-1::-1]: # pragma: no branch
popped = False
pop, popped, url_chars, counts, pre = cases.get(c,
_casesdefault)(c, pop, popped, url_chars, counts, pre)
first = False
if popped is False:
break
url = ''.join(url_chars)
uri_parts = urlsplit(url)
scheme_in_list = uri_parts.scheme in self.url_schemes
valid_scheme = (uri_parts.scheme and scheme_in_list)
if not is_valid_url(url) and not valid_scheme:
return in_.replace('{0}linkStartMarker:'.format(self.uid), '')
if text == '$':
text = url
if "://" in text:
text = text.split("://")[1]
elif ":" in text:
text = text.split(":")[1]
text = text.strip()
title = encode_html(title)
if not self.noimage: # pragma: no branch
text = self.image(text)
text = self.span(text)
text = self.glyphs(text)
url = self.shelveURL(self.encode_url(urlunsplit(uri_parts)))
attributes = parse_attributes(atts, restricted=self.restricted)
attributes['href'] = url
if title:
# if the title contains unicode data, it is annoying to get Python
# 2.6 and all the latter versions working properly. But shelving
# the title is a quick and dirty solution.
attributes['title'] = self.shelve(title)
if self.rel:
attributes['rel'] = self.rel
a_text = generate_tag('a', text, attributes)
a_shelf_id = self.shelve(a_text)
out = '{0}{1}{2}{3}'.format(pre, a_shelf_id, pop, tight)
return out
|
(self, m)
|
61,544 |
textile.core
|
fNoteLists
|
Given the text that matches as a note, format it into HTML.
|
def fNoteLists(self, match):
"""Given the text that matches as a note, format it into HTML."""
att, start_char, g_links, extras = match.groups()
start_char = start_char or 'a'
index = '{0}{1}{2}'.format(g_links, extras, start_char)
result = ''
if index not in self.notelist_cache: # pragma: no branch
o = []
if self.notes: # pragma: no branch
for seq, info in self.notes.items():
links = self.makeBackrefLink(info, g_links, start_char)
atts = ''
if 'def' in info:
infoid = info['id']
atts = info['def']['atts']
content = info['def']['content']
li = ('\t\t<li{0}>{1}<span id="note{2}"> '
'</span>{3}</li>').format(atts, links, infoid,
content)
else:
li = ('\t\t<li{0}>{1} Undefined Note [#{2}].<li>'
).format(atts, links, info['seq'])
o.append(li)
if '+' == extras and self.unreferencedNotes:
for seq, info in self.unreferencedNotes.items():
atts = info['def']['atts']
content = info['def']['content']
li = '\t\t<li{0}>{1}</li>'.format(atts, content)
o.append(li)
self.notelist_cache[index] = "\n".join(o)
result = self.notelist_cache[index]
list_atts = pba(att, restricted=self.restricted)
result = '<ol{0}>\n{1}\n\t</ol>'.format(list_atts, result)
return result
|
(self, match)
|
61,545 |
textile.core
|
fParseHTMLComments
|
If self.restricted is True, clean the matched contents of the HTML
comment. Otherwise, return the comments unchanged.
The original php had an if statement in here regarding restricted mode.
nose reported that this line wasn't covered. It's correct. In
restricted mode, the html comment tags have already been converted to
<!*#8212; and —> so they don't match in getHTMLComments,
and never arrive here.
|
def fParseHTMLComments(self, match):
"""If self.restricted is True, clean the matched contents of the HTML
comment. Otherwise, return the comments unchanged.
The original php had an if statement in here regarding restricted mode.
nose reported that this line wasn't covered. It's correct. In
restricted mode, the html comment tags have already been converted to
<!*#8212; and —> so they don't match in getHTMLComments,
and never arrive here.
"""
before, commenttext, after = match.groups()
commenttext = self.shelve(commenttext)
return '{0}<!--{1}-->'.format(before, commenttext)
|
(self, match)
|
61,546 |
textile.core
|
fParseNoteDefs
|
Parse the note definitions and format them as HTML
|
def fParseNoteDefs(self, m):
"""Parse the note definitions and format them as HTML"""
label = m.group('label')
link = m.group('link')
att = m.group('att')
content = m.group('content')
# Assign an id if the note reference parse hasn't found the label yet.
if label not in self.notes:
self.notes[label] = {'id': '{0}{1}'.format(self.linkPrefix,
self._increment_link_index())}
# Ignores subsequent defs using the same label
if 'def' not in self.notes[label]: # pragma: no branch
self.notes[label]['def'] = {'atts': pba(att, restricted=self.restricted), 'content':
self.graf(content), 'link': link}
return ''
|
(self, m)
|
61,547 |
textile.core
|
fParseNoteRefs
|
Parse and format the matched text into note references.
By the time this function is called, all the defs will have been
processed into the notes array. So now we can resolve the link numbers
in the order we process the refs...
|
def fParseNoteRefs(self, match):
"""Parse and format the matched text into note references.
By the time this function is called, all the defs will have been
processed into the notes array. So now we can resolve the link numbers
in the order we process the refs..."""
atts, label, nolink = match.groups()
atts = pba(atts, restricted=self.restricted)
nolink = nolink == '!'
# Assign a sequence number to this reference if there isn't one already
if label in self.notes:
num = self.notes[label]['seq']
else:
self.notes[label] = {
'seq': self.note_index, 'refids': [], 'id': ''
}
num = self.note_index
self.note_index = self.note_index + 1
# Make our anchor point and stash it for possible use in backlinks when
# the note list is generated later...
refid = '{0}{1}'.format(self.linkPrefix, self._increment_link_index())
self.notes[label]['refids'].append(refid)
# If we are referencing a note that hasn't had the definition parsed
# yet, then assign it an ID...
if not self.notes[label]['id']:
self.notes[label]['id'] = '{0}{1}'.format(self.linkPrefix,
self._increment_link_index())
labelid = self.notes[label]['id']
# Build the link (if any)...
result = '<span id="noteref{0}">{1}</span>'.format(refid, num)
if not nolink:
result = '<a href="#note{0}">{1}</a>'.format(labelid, result)
# Build the reference...
result = '<sup{0}>{1}</sup>'.format(atts, result)
return result
|
(self, match)
|
61,548 |
textile.core
|
fPre
| null |
def fPre(self, match):
before, text, after = match.groups()
if after is None:
after = ''
# text needs to be escaped
text = encode_html(text)
return ''.join([before, '<pre>', self.shelve(text), '</pre>', after])
|
(self, match)
|
61,549 |
textile.core
|
fRCList
|
Format a definition list.
|
def fRCList(self, match):
"""Format a definition list."""
out = []
text = re.split(r'\n(?=[-])', match.group(), flags=re.M)
for line in text:
# parse the attributes and content
m = re.match(r'^[-]+({0})[ .](.*)$'.format(cls_re_s), line,
flags=re.M | re.S)
if not m:
continue
atts, content = m.groups()
# cleanup
content = content.strip()
atts = pba(atts, restricted=self.restricted)
# split the content into the term and definition
xm = re.match(r'^(.*?)[\s]*:=(.*?)[\s]*(=:|:=)?[\s]*$', content,
re.S)
term, definition, ending = xm.groups()
# cleanup
term = term.strip()
definition = definition.strip(' ')
# if this is the first time through, out as a bool is False
if not out:
if definition == '':
dltag = "<dl{0}>".format(atts)
else:
dltag = "<dl>"
out.append(dltag)
if definition != '' and term != '':
if definition.startswith('\n'):
definition = '<p>{0}</p>'.format(definition.lstrip())
definition = definition.replace('\n', '<br />').strip()
term = self.graf(term)
definition = self.graf(definition)
out.extend(['\t<dt{0}>{1}</dt>'.format(atts, term),
'\t<dd>{0}</dd>'.format(definition)])
out.append('</dl>')
out = '\n'.join(out)
return out
|
(self, match)
|
61,550 |
textile.core
|
fSpan
| null |
def fSpan(self, match):
pre, tag, atts, cite, content, end, tail = match.groups()
qtags = {
'*': 'strong',
'**': 'b',
'??': 'cite',
'_': 'em',
'__': 'i',
'-': 'del',
'%': 'span',
'+': 'ins',
'~': 'sub',
'^': 'sup'
}
tag = qtags[tag]
atts = pba(atts, restricted=self.restricted)
if cite:
atts = '{0} cite="{1}"'.format(atts, cite.rstrip())
content = self.span(content)
out = "<{0}{1}>{2}{3}</{4}>".format(tag, atts, content, end, tag)
if pre and not tail or tail and not pre:
out = '{0}{1}{2}'.format(pre, out, tail)
return out
|
(self, match)
|
61,551 |
textile.core
|
fTextile
| null |
def fTextile(self, match):
before, notextile, after = match.groups()
if after is None: # pragma: no branch
after = ''
return ''.join([before, self.shelve(notextile), after])
|
(self, match)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.