feffery_antd_components 0.4.4 → 0.4.5

package/feffery_antd_components/AntdTour.py

@@ -1,8 +1,9 @@
 # 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
+from typing_extensions import Literal, NotRequired, TypedDict  # noqa: F401
 
 ComponentSingleType = typing.Union[str, int, float, Component, None]
 ComponentType = typing.Union[
@@ -10,201 +11,193 @@ ComponentType = typing.Union[
     typing.Sequence[ComponentSingleType],
 ]
 
-NumberType = typing.Union[
-    typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
-]
+NumberType = typing.Union[typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex]
 
 
 class AntdTour(Component):
     """An AntdTour component.
-漫游式引导组件AntdTour
+    漫游式引导组件AntdTour
 
-Keyword arguments:
+    Keyword arguments:
 
-- id (string; optional):
-    组件唯一id.
+    - id (string; optional):
+        组件唯一id.
 
-- key (string; optional):
-    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
+    - key (string; optional):
+        对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
-- className (string | dict; optional):
-    当前组件css类名，支持[动态css](/advanced-classname).
+    - className (string | dict; optional):
+        当前组件css类名，支持[动态css](/advanced-classname).
 
-- locale (a value equal to: 'zh-cn', 'en-us', 'de-de', 'ru-ru'; default 'zh-cn'):
-    组件文案语种，可选项有`'zh-cn'`（简体中文）、`'en-us'`（英语）、`'de-de'`（德语）、`'ru-ru'`（俄语）
-    默认值：`'zh-cn'`.
+    - locale (a value equal to: 'zh-cn', 'en-us', 'de-de', 'ru-ru', 'fr-fr'; default 'zh-cn'):
+        组件文案语种，可选项有`'zh-cn'`（简体中文）、`'en-us'`（英语）、`'de-de'`（德语）、`'fr-fr'`（法语）、`'ru-ru'`（俄语）
+        默认值：`'zh-cn'`.
 
-- steps (list of dicts; optional):
-    配置引导步骤.
+    - steps (list of dicts; optional):
+        配置引导步骤.
 
-    `steps` is a list of dicts with keys:
+        `steps` is a list of dicts with keys:
 
-    - targetId (string; optional):
-        当前步骤目标元素id，优先级高于`targetSelector`.
+        - targetId (string; optional):
+            当前步骤目标元素id，优先级高于`targetSelector`.
 
-    - targetSelector (string; optional):
-        定位当前步骤目标元素的javascript代码字符串.
+        - targetSelector (string; optional):
+            定位当前步骤目标元素的javascript代码字符串.
 
-    - arrow (dict; optional):
-        配置当前步骤箭头 默认值：`True`.
+        - arrow (dict; optional):
+            配置当前步骤箭头 默认值：`True`.
 
-        `arrow` is a boolean
+            `arrow` is a boolean
 
-      Or dict with keys:
+          Or dict with keys:
 
-        - pointAtCenter (boolean; optional):
+            - pointAtCenter (boolean; optional):
 
-            箭头是否指向目标中心.
+                箭头是否指向目标中心.
 
-    - cover (a list of or a singular dash component, string or number; optional):
-        组件型，当前步骤弹框的封面内容.
+        - cover (a list of or a singular dash component, string or number; optional):
+            组件型，当前步骤弹框的封面内容.
 
-    - title (a list of or a singular dash component, string or number; optional):
-        组件型，当前步骤弹框的标题内容.
+        - title (a list of or a singular dash component, string or number; optional):
+            组件型，当前步骤弹框的标题内容.
 
-    - description (a list of or a singular dash component, string or number; optional):
-        组件型，当前步骤弹框的描述内容.
+        - description (a list of or a singular dash component, string or number; optional):
+            组件型，当前步骤弹框的描述内容.
 
-    - placement (a value equal to: 'center', 'left', 'leftTop', 'leftBottom', 'right', 'rightTop', 'rightBottom', 'top', 'topLeft', 'topRight', 'bottom', 'bottomLeft', 'bottomRight'; optional):
-        当前引导步骤弹框相对目标元素的位置，可选项有`'center'`、`'left'`、`'leftTop'`、`'leftBottom'`、`'right'`、`'rightTop'`、`'rightBottom'`、`'top'`、`'topLeft'`、`'topRight'`、`'bottom'`、`'bottomLeft'`、`'bottomRight'`.
+        - placement (a value equal to: 'center', 'left', 'leftTop', 'leftBottom', 'right', 'rightTop', 'rightBottom', 'top', 'topLeft', 'topRight', 'bottom', 'bottomLeft', 'bottomRight'; optional):
+            当前引导步骤弹框相对目标元素的位置，可选项有`'center'`、`'left'`、`'leftTop'`、`'leftBottom'`、`'right'`、`'rightTop'`、`'rightBottom'`、`'top'`、`'topLeft'`、`'topRight'`、`'bottom'`、`'bottomLeft'`、`'bottomRight'`.
 
-    - mask (dict; optional):
-        配置当前步骤蒙版层 默认值：`True`.
+        - mask (dict; optional):
+            配置当前步骤蒙版层 默认值：`True`.
 
-        `mask` is a boolean | dict with keys:
+            `mask` is a boolean | dict with keys:
 
-        - style (dict; optional):
+            - style (dict; optional):
 
-            当前步骤蒙版层css样式.
+                当前步骤蒙版层css样式.
 
-        - color (string; optional):
+            - color (string; optional):
 
-            当前步骤蒙版层颜色.
+                当前步骤蒙版层颜色.
 
-    - type (a value equal to: 'default', 'primary'; optional):
-        当前步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`.
+        - type (a value equal to: 'default', 'primary'; optional):
+            当前步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`.
 
-    - nextButtonProps (dict; optional):
-        配置当前步骤下一步按钮.
+        - nextButtonProps (dict; optional):
+            配置当前步骤下一步按钮.
 
-        `nextButtonProps` is a dict with keys:
+            `nextButtonProps` is a dict with keys:
 
-        - children (a list of or a singular dash component, string or number; optional):
-            组件型，按钮内嵌元素.
+            - children (a list of or a singular dash component, string or number; optional):
+                组件型，按钮内嵌元素.
 
-    - prevButtonProps (dict; optional):
-        配置当前步骤上一步按钮.
+        - prevButtonProps (dict; optional):
+            配置当前步骤上一步按钮.
 
-        `prevButtonProps` is a dict with keys:
+            `prevButtonProps` is a dict with keys:
 
-        - children (a list of or a singular dash component, string or number; optional):
-            组件型，按钮内嵌元素.
+            - children (a list of or a singular dash component, string or number; optional):
+                组件型，按钮内嵌元素.
 
-- arrow (dict; default True):
-    统一配置引导步骤弹框箭头 默认值：`True`.
+    - arrow (dict; default True):
+        统一配置引导步骤弹框箭头 默认值：`True`.
 
-    `arrow` is a boolean | dict with keys:
+        `arrow` is a boolean | dict with keys:
 
-    - pointAtCenter (boolean; optional):
-        箭头是否指向目标中心.
+        - pointAtCenter (boolean; optional):
+            箭头是否指向目标中心.
 
-- placement (a value equal to: 'center', 'left', 'leftTop', 'leftBottom', 'right', 'rightTop', 'rightBottom', 'top', 'topLeft', 'topRight', 'bottom', 'bottomLeft', 'bottomRight'; default 'bottom'):
-    统一配置引导步骤弹框相对于目标元素的展开方向，可选项有`'center'`、`'left'`、`'leftTop'`、`'leftBottom'`、`'right'`、`'rightTop'`、`'rightBottom'`、`'top'`、`'topLeft'`、`'topRight'`、`'bottom'`、`'bottomLeft'`、`'bottomRight'`
-    默认值：`'bottom'`.
+    - placement (a value equal to: 'center', 'left', 'leftTop', 'leftBottom', 'right', 'rightTop', 'rightBottom', 'top', 'topLeft', 'topRight', 'bottom', 'bottomLeft', 'bottomRight'; default 'bottom'):
+        统一配置引导步骤弹框相对于目标元素的展开方向，可选项有`'center'`、`'left'`、`'leftTop'`、`'leftBottom'`、`'right'`、`'rightTop'`、`'rightBottom'`、`'top'`、`'topLeft'`、`'topRight'`、`'bottom'`、`'bottomLeft'`、`'bottomRight'`
+        默认值：`'bottom'`.
 
-- mask (dict; default True):
-    统一配置引导弹框蒙版 默认值：`True`.
+    - mask (dict; default True):
+        统一配置引导弹框蒙版 默认值：`True`.
 
-    `mask` is a boolean | dict with keys:
+        `mask` is a boolean | dict with keys:
 
-    - style (dict; optional):
-        蒙版层css样式.
+        - style (dict; optional):
+            蒙版层css样式.
+
+        - color (string; optional):
+            蒙版层颜色.
 
-    - color (string; optional):
-        蒙版层颜色.
+    - type (a value equal to: 'default', 'primary'; default 'default'):
+        统一设置引导步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`.
 
-- type (a value equal to: 'default', 'primary'; default 'default'):
-    统一设置引导步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`.
+    - open (boolean; default False):
+        监听或设置当前漫游式引导的打开状态 默认值：`False`.
 
-- open (boolean; default False):
-    监听或设置当前漫游式引导的打开状态 默认值：`False`.
+    - current (number; optional):
+        监听或设置当前漫游式引导所在步骤序号.
 
-- current (number; optional):
-    监听或设置当前漫游式引导所在步骤序号.
+    - zIndex (number; default 1001):
+        当前漫游式引导z-index 默认值：`1001`.
 
-- zIndex (number; default 1001):
-    当前漫游式引导z-index 默认值：`1001`.
+    - data-* (string; optional):
+        `data-*`格式属性通配.
 
-- data-* (string; optional):
-    `data-*`格式属性通配.
+    - aria-* (string; optional):
+        `aria-*`格式属性通配."""
 
-- aria-* (string; optional):
-    `aria-*`格式属性通配."""
-    _children_props: typing.List[str] = ['steps[].cover', 'steps[].title', 'steps[].description', 'steps[].nextButtonProps.children', 'steps[].prevButtonProps.children']
+    _children_props: typing.List[str] = [
+        'steps[].cover',
+        'steps[].title',
+        'steps[].description',
+        'steps[].nextButtonProps.children',
+        'steps[].prevButtonProps.children',
+    ]
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdTour'
-    StepsArrow = TypedDict(
-        "StepsArrow",
-            {
-            "pointAtCenter": NotRequired[bool]
-        }
-    )
+    StepsArrow = TypedDict('StepsArrow', {'pointAtCenter': NotRequired[bool]})
 
-    StepsMask = TypedDict(
-        "StepsMask",
-            {
-            "style": NotRequired[dict],
-            "color": NotRequired[str]
-        }
-    )
+    StepsMask = TypedDict('StepsMask', {'style': NotRequired[dict], 'color': NotRequired[str]})
 
     StepsNextButtonProps = TypedDict(
-        "StepsNextButtonProps",
-            {
-            "children": NotRequired[ComponentType]
-        }
+        'StepsNextButtonProps', {'children': NotRequired[ComponentType]}
     )
 
     StepsPrevButtonProps = TypedDict(
-        "StepsPrevButtonProps",
-            {
-            "children": NotRequired[ComponentType]
-        }
+        'StepsPrevButtonProps', {'children': NotRequired[ComponentType]}
     )
 
     Steps = TypedDict(
-        "Steps",
-            {
-            "targetId": NotRequired[str],
-            "targetSelector": NotRequired[str],
-            "arrow": NotRequired[typing.Union[bool, "StepsArrow"]],
-            "cover": NotRequired[ComponentType],
-            "title": NotRequired[ComponentType],
-            "description": NotRequired[ComponentType],
-            "placement": NotRequired[Literal["center", "left", "leftTop", "leftBottom", "right", "rightTop", "rightBottom", "top", "topLeft", "topRight", "bottom", "bottomLeft", "bottomRight"]],
-            "mask": NotRequired[typing.Union[bool, "StepsMask"]],
-            "type": NotRequired[Literal["default", "primary"]],
-            "nextButtonProps": NotRequired["StepsNextButtonProps"],
-            "prevButtonProps": NotRequired["StepsPrevButtonProps"]
-        }
+        'Steps',
+        {
+            'targetId': NotRequired[str],
+            'targetSelector': NotRequired[str],
+            'arrow': NotRequired[typing.Union[bool, 'StepsArrow']],
+            'cover': NotRequired[ComponentType],
+            'title': NotRequired[ComponentType],
+            'description': NotRequired[ComponentType],
+            'placement': NotRequired[
+                Literal[
+                    'center',
+                    'left',
+                    'leftTop',
+                    'leftBottom',
+                    'right',
+                    'rightTop',
+                    'rightBottom',
+                    'top',
+                    'topLeft',
+                    'topRight',
+                    'bottom',
+                    'bottomLeft',
+                    'bottomRight',
+                ]
+            ],
+            'mask': NotRequired[typing.Union[bool, 'StepsMask']],
+            'type': NotRequired[Literal['default', 'primary']],
+            'nextButtonProps': NotRequired['StepsNextButtonProps'],
+            'prevButtonProps': NotRequired['StepsPrevButtonProps'],
+        },
     )
 
-    Arrow = TypedDict(
-        "Arrow",
-            {
-            "pointAtCenter": NotRequired[bool]
-        }
-    )
-
-    Mask = TypedDict(
-        "Mask",
-            {
-            "style": NotRequired[dict],
-            "color": NotRequired[str]
-        }
-    )
+    Arrow = TypedDict('Arrow', {'pointAtCenter': NotRequired[bool]})
 
+    Mask = TypedDict('Mask', {'style': NotRequired[dict], 'color': NotRequired[str]})
 
     def __init__(
         self,
@@ -212,21 +205,69 @@ Keyword arguments:
         key: typing.Optional[str] = None,
         style: typing.Optional[typing.Any] = None,
         className: typing.Optional[typing.Union[str, dict]] = None,
-        locale: typing.Optional[Literal["zh-cn", "en-us", "de-de", "ru-ru"]] = None,
-        steps: typing.Optional[typing.Sequence["Steps"]] = None,
-        arrow: typing.Optional[typing.Union[bool, "Arrow"]] = None,
-        placement: typing.Optional[Literal["center", "left", "leftTop", "leftBottom", "right", "rightTop", "rightBottom", "top", "topLeft", "topRight", "bottom", "bottomLeft", "bottomRight"]] = None,
-        mask: typing.Optional[typing.Union[bool, "Mask"]] = None,
-        type: typing.Optional[Literal["default", "primary"]] = None,
+        locale: typing.Optional[Literal['zh-cn', 'en-us', 'de-de', 'ru-ru', 'fr-fr']] = None,
+        steps: typing.Optional[typing.Sequence['Steps']] = None,
+        arrow: typing.Optional[typing.Union[bool, 'Arrow']] = None,
+        placement: typing.Optional[
+            Literal[
+                'center',
+                'left',
+                'leftTop',
+                'leftBottom',
+                'right',
+                'rightTop',
+                'rightBottom',
+                'top',
+                'topLeft',
+                'topRight',
+                'bottom',
+                'bottomLeft',
+                'bottomRight',
+            ]
+        ] = None,
+        mask: typing.Optional[typing.Union[bool, 'Mask']] = None,
+        type: typing.Optional[Literal['default', 'primary']] = None,
         open: typing.Optional[bool] = None,
         current: typing.Optional[NumberType] = None,
         zIndex: typing.Optional[NumberType] = None,
-        **kwargs
+        **kwargs,
     ):
-        self._prop_names = ['id', 'key', 'style', 'className', 'locale', 'steps', 'arrow', 'placement', 'mask', 'type', 'open', 'current', 'zIndex', 'data-*', 'aria-*']
-        self._valid_wildcard_attributes =            ['data-', 'aria-']
-        self.available_properties = ['id', 'key', 'style', 'className', 'locale', 'steps', 'arrow', 'placement', 'mask', 'type', 'open', 'current', 'zIndex', 'data-*', 'aria-*']
-        self.available_wildcard_properties =            ['data-', 'aria-']
+        self._prop_names = [
+            'id',
+            'key',
+            'style',
+            'className',
+            'locale',
+            'steps',
+            'arrow',
+            'placement',
+            'mask',
+            'type',
+            'open',
+            'current',
+            'zIndex',
+            'data-*',
+            'aria-*',
+        ]
+        self._valid_wildcard_attributes = ['data-', 'aria-']
+        self.available_properties = [
+            'id',
+            'key',
+            'style',
+            'className',
+            'locale',
+            'steps',
+            'arrow',
+            'placement',
+            'mask',
+            'type',
+            'open',
+            'current',
+            'zIndex',
+            'data-*',
+            'aria-*',
+        ]
+        self.available_wildcard_properties = ['data-', 'aria-']
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()
         _locals.update(kwargs)  # For wildcard attrs and excess named props
@@ -234,4 +275,5 @@ Keyword arguments:
 
         super(AntdTour, self).__init__(**args)
 
-setattr(AntdTour, "__init__", _explicitize_args(AntdTour.__init__))
+
+setattr(AntdTour, '__init__', _explicitize_args(AntdTour.__init__))