Source code for dazzler.components.core._slider

"""Autogenerated file: DO NOT EDIT!"""
import typing  # noqa: F401
from dazzler.system import Component, Aspect, UNDEFINED  # noqa: F401


class Slider(Component):
    """
    A slider with a caret contained within a min and max value.

    :CSS:

        - ``dazzler-core-slider``
        - ``slider-area``: The outer div of the slider.
        - ``slider-handle``: The drag handle
        - ``slider-spacer``: The space that is before the handle.

    :Example:

    .. literalinclude:: ../../tests/components/pages/slider.py
        :lines: 5-43
    """
    minimum = Aspect(required=True, docstring="Minimum (leftmost) value of the slider.")  # noqa: E501
    maximum = Aspect(required=True, docstring="Maximum (rightmost) value of the slider.")  # noqa: E501
    value = Aspect(default=0, docstring="Current value (default=0)")
    round = Aspect(docstring="Round the value (Possible values: 'ceil', 'floor')")  # noqa: E501
    debounce = Aspect(default=50, docstring="Time in milliseconds to wait before updating the value. (default=50)")  # noqa: E501
    class_name = Aspect(docstring="Class name automatically added by dazzler api with a prefix for the component library.ie: core component Container become ``dazzler-core-container``.When added on the component, the class names will be concatenated.")  # noqa: E501
    style = Aspect(docstring="Style object for the top level wrapper of the component.")  # noqa: E501

    def __init__(
            self,
            minimum: typing.Union[float, int],
            maximum: typing.Union[float, int],
            value: typing.Optional[typing.Union[float, int]] = 0,
            round: typing.Optional[typing.Any] = UNDEFINED,
            debounce: typing.Optional[typing.Union[float, int]] = 50,
            class_name: typing.Optional[str] = UNDEFINED,
            style: typing.Optional[typing.Dict] = UNDEFINED,
            identity: str = None
    ):
        """
        :param minimum: Minimum (leftmost) value of the slider.
        :param maximum: Maximum (rightmost) value of the slider.
        :param value: Current value (default=0)
        :param round: Round the value (Possible values: 'ceil', 'floor')
        :param debounce: Time in milliseconds to wait before updating the
            value. (default=50)
        :param class_name: Class name automatically added by dazzler api
            with a prefix for the  component library. ie: core component
            Container become ``dazzler-core-container``. When added on the
            component, the class names will be concatenated.
        :param style: Style object for the top level wrapper of the
            component.
        """
        Component.__init__(self, locals(), identity)