# 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

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

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


class FefferyScroll(Component):
    """A FefferyScroll component.
滚动操作组件FefferyScroll

Keyword arguments:

- id (string; optional):
    组件唯一id.

- key (string; optional):
    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.

- scrollMode (a value equal to: 'to-top', 'to-bottom', 'top-offset', 'relative-offset', 'target'; default 'to-top'):
    设置页面滚动模式，可选的有`'to-top'`、`'to-bottom'`、`'top-offset'`、`'relative-offset'`、`'target'`
    默认值：`'to-top'`.

- executeScroll (boolean; default False):
    用于指示是否进行滚动操作，在回调中设置`executeScroll`参数Output为`True`从而触发新一次滚动，每次由`executeScroll=True`触发的滚动完成后，`executeScroll`会自动重置为`False`
    默认值：`False`.

- scrollTopOffset (number; optional):
    当`scrollMode='top-offset'`时，用于设置滚动终点距离页面顶端的像素.

- scrollRelativeOffset (number; optional):
    当`scrollMode='relative-offset'`时，用于设置相对滚动的像素距离，负数则为向上滚动.

- scrollTargetId (string; optional):
    当`scrollMode='target'`时，用于设置滚动目标元素的id信息.

- duration (number; default 500):
    用于设置滚动过程耗时（单位：毫秒） 默认值：`500`.

- smooth (boolean | a value equal to: 'linear', 'easeInQuad', 'easeOutQuad', 'easeInOutQuad', 'easeInCubic', 'easeOutCubic', 'easeInOutCubic', 'easeInQuart', 'easeOutQuart', 'easeInOutQuart', 'easeInQuint', 'easeOutQuint', 'easeInOutQuint'; default True):
    用于设置滚动过程动画模式 默认值：True.

- delay (number; default 0):
    用于设置滚动延时（单位：毫秒） 默认值：0.

- containerId (string; optional):
    当滚动目标位于局部滚动条内时，用于设置局部滚动条所在的容器id信息.

- offset (number; optional):
    设置滚动过程的额外偏移像素距离."""
    _children_props: typing.List[str] = []
    _base_nodes = ['children']
    _namespace = 'feffery_utils_components'
    _type = 'FefferyScroll'


    def __init__(
        self,
        id: typing.Optional[typing.Union[str, dict]] = None,
        key: typing.Optional[str] = None,
        scrollMode: typing.Optional[Literal["to-top", "to-bottom", "top-offset", "relative-offset", "target"]] = None,
        executeScroll: typing.Optional[bool] = None,
        scrollTopOffset: typing.Optional[NumberType] = None,
        scrollRelativeOffset: typing.Optional[NumberType] = None,
        scrollTargetId: typing.Optional[str] = None,
        duration: typing.Optional[NumberType] = None,
        smooth: typing.Optional[typing.Union[bool, Literal["linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint"]]] = None,
        delay: typing.Optional[NumberType] = None,
        containerId: typing.Optional[str] = None,
        offset: typing.Optional[NumberType] = None,
        **kwargs
    ):
        self._prop_names = ['id', 'key', 'scrollMode', 'executeScroll', 'scrollTopOffset', 'scrollRelativeOffset', 'scrollTargetId', 'duration', 'smooth', 'delay', 'containerId', 'offset']
        self._valid_wildcard_attributes =            []
        self.available_properties = ['id', 'key', 'scrollMode', 'executeScroll', 'scrollTopOffset', 'scrollRelativeOffset', 'scrollTargetId', 'duration', 'smooth', 'delay', 'containerId', 'offset']
        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(FefferyScroll, self).__init__(**args)

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