dash-api/lib/python3.11/site-packages/dash_bootstrap_components/_components/Checkbox.py

# AUTO GENERATED FILE - DO NOT EDIT

import typing  # noqa: F401
from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
from dash.development.base_component import Component, _explicitize_args

ComponentType = typing.Union[
    str,
    int,
    float,
    Component,
    None,
    typing.Sequence[typing.Union[str, int, float, Component, None]],
]

NumberType = typing.Union[
    typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
]


class Checkbox(Component):
    """A Checkbox component.
Render a single checkbox.

Keyword arguments:

- id (string; optional):
    The ID of the Checkbox.

- value (boolean; default False):
    The value of the input.

- disabled (boolean; default False):
    Disable the Checkbox.

- label (a list of or a singular dash component, string or number; optional):
    A label to display alongside the Checkbox.

- class_name (string; optional):
    Additional CSS classes to apply to the container div.

- input_style (dict; optional):
    Additional inline CSS styles to apply to the <input> element.

- input_class_name (string; default ''):
    Additional CSS classes to apply to the <input> element.

- label_id (string; optional):
    The ID of the label.

- label_style (dict; optional):
    Additional inline CSS styles to add to the label.

- label_class_name (string; default ''):
    Additional CSS classes to apply to the label.

- name (string; optional):
    The name of the control, which is submitted with the form data.

- persistence (boolean | string | number; optional):
    Used to allow user interactions to be persisted when the page is
    refreshed. See https://dash.plotly.com/persistence for more
    details.

- persisted_props (list of a value equal to: 'value's; optional):
    Properties whose user interactions will persist after refreshing
    the component or the page. Since only `value` is allowed this prop
    can normally be ignored.

- persistence_type (a value equal to: 'local', 'session', 'memory'; optional):
    Where persisted user changes will be stored: - memory: only kept
    in memory, reset on page refresh. - local: window.localStorage,
    data is kept after the browser quit. - session:
    window.sessionStorage, data is cleared once the browser quit.

- className (string; optional):
    **DEPRECATED** Use `class_name` instead.  Additional CSS classes
    to apply to the container div.

- inputStyle (dict; optional):
    **DEPRECATED** Use `input_style` instead.  Additional inline CSS
    styles to apply to the <input> element.

- inputClassName (string; optional):
    **DEPRECATED** Use `input_class_name` instead.  Additional CSS
    classes to apply to the <input> element.

- labelStyle (dict; optional):
    **DEPRECATED** Use `label_style` instead.  Additional inline CSS
    styles to add to the label.

- labelClassName (string; optional):
    **DEPRECATED** Use `label_class_name` instead.  Additional CSS
    classes to apply to the label."""
    _children_props = ['label']
    _base_nodes = ['label', 'children']
    _namespace = 'dash_bootstrap_components'
    _type = 'Checkbox'


    def __init__(
        self,
        id: typing.Optional[typing.Union[str, dict]] = None,
        *,
        value: typing.Optional[bool] = None,
        disabled: typing.Optional[bool] = None,
        label: typing.Optional[ComponentType] = None,
        class_name: typing.Optional[str] = None,
        style: typing.Optional[typing.Any] = None,
        input_style: typing.Optional[dict] = None,
        input_class_name: typing.Optional[str] = None,
        label_id: typing.Optional[str] = None,
        label_style: typing.Optional[dict] = None,
        label_class_name: typing.Optional[str] = None,
        name: typing.Optional[str] = None,
        persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
        persisted_props: typing.Optional[typing.Sequence[Literal["value"]]] = None,
        persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
        className: typing.Optional[str] = None,
        inputStyle: typing.Optional[dict] = None,
        inputClassName: typing.Optional[str] = None,
        labelStyle: typing.Optional[dict] = None,
        labelClassName: typing.Optional[str] = None,
        **kwargs
    ):
        self._prop_names = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
        self._valid_wildcard_attributes =            []
        self.available_properties = ['id', 'value', 'disabled', 'label', 'class_name', 'style', 'input_style', 'input_class_name', 'label_id', 'label_style', 'label_class_name', 'name', 'persistence', 'persisted_props', 'persistence_type', 'className', 'inputStyle', 'inputClassName', 'labelStyle', 'labelClassName']
        self.available_wildcard_properties =            []
        _explicit_args = kwargs.pop('_explicit_args')
        _locals = locals()
        _locals.update(kwargs)  # For wildcard attrs and excess named props
        args = {k: _locals[k] for k in _explicit_args}

        super(Checkbox, self).__init__(**args)

setattr(Checkbox, "__init__", _explicitize_args(Checkbox.__init__))