feffery_antd_components 0.4.3 → 0.4.5

package/feffery_antd_components/AntdDropdown.py

@@ -1,206 +1,210 @@
 # 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[
-    str,
-    int,
-    float,
-    Component,
-    None,
-    typing.Sequence[typing.Union[str, int, float, Component, None]],
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
 ]
 
-NumberType = typing.Union[
-    typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
-]
+NumberType = typing.Union[typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex]
 
 
 class AntdDropdown(Component):
     """An AntdDropdown component.
-下拉菜单组件AntdDropdown
+    下拉菜单组件AntdDropdown
 
-Keyword arguments:
+    Keyword arguments:
 
-- id (string; optional):
-    组件唯一id.
+    - id (string; optional):
+        组件唯一id.
 
-- key (string; optional):
-    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
+    - key (string; optional):
+        对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
-- 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):
+        组件型，下拉菜单触发锚定元素.
 
-- className (string | dict; optional):
-    当前组件css类名，支持[动态css](/advanced-classname).
+    - className (string | dict; optional):
+        当前组件css类名，支持[动态css](/advanced-classname).
 
-- wrapperStyle (dict; optional):
-    锚定元素父容器css样式.
+    - wrapperStyle (dict; optional):
+        锚定元素父容器css样式.
 
-- wrapperClassName (string | dict; optional):
-    锚定元素父容器css类名.
+    - wrapperClassName (string | dict; optional):
+        锚定元素父容器css类名.
 
-- title (string; optional):
-    下拉菜单触发元素标题内容，children参数未设置时有效.
+    - title (string; optional):
+        下拉菜单触发元素标题内容，children参数未设置时有效.
 
-- buttonMode (boolean; default False):
-    下拉菜单触发元素是否渲染为按钮形式，children参数未设置时有效 默认值：`False`.
+    - buttonMode (boolean; default False):
+        下拉菜单触发元素是否渲染为按钮形式，children参数未设置时有效 默认值：`False`.
 
-- buttonProps (dict; optional):
-    针对下拉菜单触发元素的按钮形式进行进一步配置.
+    - buttonProps (dict; optional):
+        针对下拉菜单触发元素的按钮形式进行进一步配置.
 
-    `buttonProps` is a dict with keys:
+        `buttonProps` is a dict with keys:
 
-    - icon (a list of or a singular dash component, string or number; optional):
-        组件型，按钮图标元素.
+        - icon (a list of or a singular dash component, string or number; optional):
+            组件型，按钮图标元素.
 
-    - size (a value equal to: 'small', 'middle', 'large'; optional):
-        按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`.
+        - size (a value equal to: 'small', 'middle', 'large'; optional):
+            按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`.
 
-    - type (a value equal to: 'default', 'primary', 'ghost', 'dashed', 'link', 'text'; optional):
-        按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'`
-        默认值：`'default'`.
+        - type (a value equal to: 'default', 'primary', 'ghost', 'dashed', 'link', 'text'; optional):
+            按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'`
+            默认值：`'default'`.
 
-    - danger (boolean; optional):
-        按钮是否呈现危险样式 默认值：`False`.
+        - danger (boolean; optional):
+            按钮是否呈现危险样式 默认值：`False`.
 
-    - style (dict; optional):
-        按钮css样式.
+        - style (dict; optional):
+            按钮css样式.
 
-    - className (string; optional):
-        按钮css类名.
+        - className (string; optional):
+            按钮css类名.
 
-- freePosition (boolean; default False):
-    是否开启自由位置模式 默认值：`False`.
+    - freePosition (boolean; default False):
+        是否开启自由位置模式 默认值：`False`.
 
-- freePositionStyle (dict; optional):
-    自由位置模式开启后，控制挂载位置对应css样式.
+    - freePositionStyle (dict; optional):
+        自由位置模式开启后，控制挂载位置对应css样式.
 
-- freePositionClassName (string; optional):
-    自由位置模式开启后，控制挂载位置对应css类名.
+    - freePositionClassName (string; optional):
+        自由位置模式开启后，控制挂载位置对应css类名.
 
-- clickedKey (string; optional):
-    监听被点击的下拉菜单选项key值.
+    - clickedKey (string; optional):
+        监听被点击的下拉菜单选项key值.
 
-- nClicks (number; default 0):
-    监听下拉菜单选项累计被点击次数 默认值：`0`.
+    - nClicks (number; default 0):
+        监听下拉菜单选项累计被点击次数 默认值：`0`.
 
-- menuItems (list of dicts; optional):
-    下拉菜单数据结构.
+    - menuItems (list of dicts; optional):
+        下拉菜单数据结构.
 
-    `menuItems` is a list of dicts with keys:
+        `menuItems` is a list of dicts with keys:
 
-    - 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):
+            组件型，节点标题.
 
-    - extra (a list of or a singular dash component, string or number; optional):
-        组件型，额外内容.
+        - extra (a list of or a singular dash component, string or number; optional):
+            组件型，额外内容.
 
-    - href (string; optional):
-        节点链接地址.
+        - href (string; optional):
+            节点链接地址.
 
-    - target (string; optional):
-        节点链接跳转行为.
+        - target (string; optional):
+            节点链接跳转行为.
 
-    - disabled (boolean; optional):
-        是否禁用节点 默认值：`False`.
+        - disabled (boolean; optional):
+            是否禁用节点 默认值：`False`.
 
-    - icon (string; optional):
-        节点前缀图标名称，与`iconRenderer`方式相关联，`'AntdIcon'`方式下同AntdIcon的icon参数，`'fontawesome'`方式下代表图标的css类名.
+        - icon (string; optional):
+            节点前缀图标名称，与`iconRenderer`方式相关联，`'AntdIcon'`方式下同AntdIcon的icon参数，`'fontawesome'`方式下代表图标的css类名.
 
-    - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional):
-        前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`.
+        - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional):
+            前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`.
 
-    - key (string; optional):
-        节点唯一key值.
+        - key (string; optional):
+            节点唯一key值.
 
-    - isDivider (boolean; optional):
-        节点是否渲染为分割线.
+        - isDivider (boolean; optional):
+            节点是否渲染为分割线.
 
-- selectable (boolean; default False):
-    菜单项是否可选择 默认值：`False`.
+        - children (list; optional):
+            子菜单项，用于构建级联菜单.
 
-- multiple (boolean; default False):
-    菜单项是否可多选 默认值：`False`.
+    - selectable (boolean; default False):
+        菜单项是否可选择 默认值：`False`.
 
-- selectedKeys (list of strings; optional):
-    设置或监听当前已选中菜单项key值.
+    - multiple (boolean; default False):
+        菜单项是否可多选 默认值：`False`.
 
-- nonSelectableKeys (list of strings; optional):
-    设置不可选中项key值数组 默认值：`[]`.
+    - selectedKeys (list of strings; optional):
+        设置或监听当前已选中菜单项key值.
 
-- arrow (boolean; default False):
-    下拉菜单是否渲染指示箭头 默认值：`False`.
+    - nonSelectableKeys (list of strings; optional):
+        设置不可选中项key值数组 默认值：`[]`.
 
-- disabled (boolean; default False):
-    是否禁用组件功能 默认值：`False`.
+    - arrow (boolean; default False):
+        下拉菜单是否渲染指示箭头 默认值：`False`.
 
-- overlayClassName (string | dict; optional):
-    下拉菜单容器css类名，支持[动态css](/advanced-classname).
+    - disabled (boolean; default False):
+        是否禁用组件功能 默认值：`False`.
 
-- overlayStyle (dict; optional):
-    下拉菜单容器css样式.
+    - overlayClassName (string | dict; optional):
+        下拉菜单容器css类名，支持[动态css](/advanced-classname).
 
-- placement (a value equal to: 'bottomLeft', 'bottomCenter', 'bottomRight', 'topLeft', 'topCenter', 'topRight'; optional):
-    下拉菜单弹出方位，可选项有`'bottomLeft'`、`'bottomCenter'`、`'bottomRight'`、`'topLeft'`、`'topCenter'`、`'topRight'`.
+    - overlayStyle (dict; optional):
+        下拉菜单容器css样式.
 
-- trigger (a value equal to: 'click', 'hover'; default 'hover'):
-    下拉菜单显示触发方式，可选项有`'click'`、`'hover'` 默认值：`'hover'`.
+    - placement (a value equal to: 'bottomLeft', 'bottomCenter', 'bottomRight', 'topLeft', 'topCenter', 'topRight'; optional):
+        下拉菜单弹出方位，可选项有`'bottomLeft'`、`'bottomCenter'`、`'bottomRight'`、`'topLeft'`、`'topCenter'`、`'topRight'`.
 
-- autoAdjustOverflow (boolean; default True):
-    下拉菜单是否在被遮挡时自动调整位置 默认值：`True`.
+    - trigger (a value equal to: 'click', 'hover'; default 'hover'):
+        下拉菜单显示触发方式，可选项有`'click'`、`'hover'` 默认值：`'hover'`.
 
-- visible (boolean; default False):
-    监听或设置下拉菜单是否展开 默认值：`False`.
+    - autoAdjustOverflow (boolean; default True):
+        下拉菜单是否在被遮挡时自动调整位置 默认值：`True`.
 
-- popupContainer (a value equal to: 'parent', 'body'; default 'body'):
-    下拉菜单展开层锚定策略，可选项有`'parent'`、`'body'` 默认值：`'body'`.
+    - visible (boolean; default False):
+        监听或设置下拉菜单是否展开 默认值：`False`.
 
-- batchPropsNames (list of strings; optional):
-    需要纳入批属性监听的属性名 默认值：`[]`.
+    - popupContainer (a value equal to: 'parent', 'body'; default 'body'):
+        下拉菜单展开层锚定策略，可选项有`'parent'`、`'body'` 默认值：`'body'`.
 
-- batchPropsValues (dict; optional):
-    批量监听与当前batchPropsNames对应的属性值.
+    - batchPropsNames (list of strings; optional):
+        需要纳入批属性监听的属性名 默认值：`[]`.
 
-- data-* (string; optional):
-    `data-*`格式属性通配.
+    - batchPropsValues (dict; optional):
+        批量监听与当前batchPropsNames对应的属性值.
 
-- aria-* (string; optional):
-    `aria-*`格式属性通配."""
-    _children_props: typing.List[str] = ['buttonProps.icon', 'menuItems[].title', 'menuItems[].extra']
+    - data-* (string; optional):
+        `data-*`格式属性通配.
+
+    - aria-* (string; optional):
+        `aria-*`格式属性通配."""
+
+    _children_props: typing.List[str] = [
+        'buttonProps.icon',
+        'menuItems[].title',
+        'menuItems[].extra',
+    ]
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdDropdown'
     ButtonProps = TypedDict(
-        "ButtonProps",
-            {
-            "icon": NotRequired[ComponentType],
-            "size": NotRequired[Literal["small", "middle", "large"]],
-            "type": NotRequired[Literal["default", "primary", "ghost", "dashed", "link", "text"]],
-            "danger": NotRequired[bool],
-            "style": NotRequired[dict],
-            "className": NotRequired[str]
-        }
+        'ButtonProps',
+        {
+            'icon': NotRequired[ComponentType],
+            'size': NotRequired[Literal['small', 'middle', 'large']],
+            'type': NotRequired[Literal['default', 'primary', 'ghost', 'dashed', 'link', 'text']],
+            'danger': NotRequired[bool],
+            'style': NotRequired[dict],
+            'className': NotRequired[str],
+        },
     )
 
     MenuItems = TypedDict(
-        "MenuItems",
-            {
-            "title": NotRequired[ComponentType],
-            "extra": NotRequired[ComponentType],
-            "href": NotRequired[str],
-            "target": NotRequired[str],
-            "disabled": NotRequired[bool],
-            "icon": NotRequired[str],
-            "iconRenderer": NotRequired[Literal["AntdIcon", "fontawesome"]],
-            "key": NotRequired[str],
-            "isDivider": NotRequired[bool]
-        }
+        'MenuItems',
+        {
+            'title': NotRequired[ComponentType],
+            'extra': NotRequired[ComponentType],
+            'href': NotRequired[str],
+            'target': NotRequired[str],
+            'disabled': NotRequired[bool],
+            'icon': NotRequired[str],
+            'iconRenderer': NotRequired[Literal['AntdIcon', 'fontawesome']],
+            'key': NotRequired[str],
+            'isDivider': NotRequired[bool],
+            'children': NotRequired[typing.Sequence],
+        },
     )
 
-
     def __init__(
         self,
         children: typing.Optional[ComponentType] = None,
@@ -212,13 +216,13 @@ Keyword arguments:
         wrapperClassName: typing.Optional[typing.Union[str, dict]] = None,
         title: typing.Optional[str] = None,
         buttonMode: typing.Optional[bool] = None,
-        buttonProps: typing.Optional["ButtonProps"] = None,
+        buttonProps: typing.Optional['ButtonProps'] = None,
         freePosition: typing.Optional[bool] = None,
         freePositionStyle: typing.Optional[dict] = None,
         freePositionClassName: typing.Optional[str] = None,
         clickedKey: typing.Optional[str] = None,
         nClicks: typing.Optional[NumberType] = None,
-        menuItems: typing.Optional[typing.Sequence["MenuItems"]] = None,
+        menuItems: typing.Optional[typing.Sequence['MenuItems']] = None,
         selectable: typing.Optional[bool] = None,
         multiple: typing.Optional[bool] = None,
         selectedKeys: typing.Optional[typing.Sequence[str]] = None,
@@ -227,19 +231,89 @@ Keyword arguments:
         disabled: typing.Optional[bool] = None,
         overlayClassName: typing.Optional[typing.Union[str, dict]] = None,
         overlayStyle: typing.Optional[dict] = None,
-        placement: typing.Optional[Literal["bottomLeft", "bottomCenter", "bottomRight", "topLeft", "topCenter", "topRight"]] = None,
-        trigger: typing.Optional[Literal["click", "hover"]] = None,
+        placement: typing.Optional[
+            Literal['bottomLeft', 'bottomCenter', 'bottomRight', 'topLeft', 'topCenter', 'topRight']
+        ] = None,
+        trigger: typing.Optional[Literal['click', 'hover']] = None,
         autoAdjustOverflow: typing.Optional[bool] = None,
         visible: typing.Optional[bool] = None,
-        popupContainer: typing.Optional[Literal["parent", "body"]] = None,
+        popupContainer: typing.Optional[Literal['parent', 'body']] = None,
         batchPropsNames: typing.Optional[typing.Sequence[str]] = None,
         batchPropsValues: typing.Optional[dict] = None,
-        **kwargs
+        **kwargs,
     ):
-        self._prop_names = ['id', 'key', 'children', 'style', 'className', 'wrapperStyle', 'wrapperClassName', 'title', 'buttonMode', 'buttonProps', 'freePosition', 'freePositionStyle', 'freePositionClassName', 'clickedKey', 'nClicks', 'menuItems', 'selectable', 'multiple', 'selectedKeys', 'nonSelectableKeys', 'arrow', 'disabled', 'overlayClassName', 'overlayStyle', 'placement', 'trigger', 'autoAdjustOverflow', 'visible', 'popupContainer', 'batchPropsNames', 'batchPropsValues', 'data-*', 'aria-*']
-        self._valid_wildcard_attributes =            ['data-', 'aria-']
-        self.available_properties = ['id', 'key', 'children', 'style', 'className', 'wrapperStyle', 'wrapperClassName', 'title', 'buttonMode', 'buttonProps', 'freePosition', 'freePositionStyle', 'freePositionClassName', 'clickedKey', 'nClicks', 'menuItems', 'selectable', 'multiple', 'selectedKeys', 'nonSelectableKeys', 'arrow', 'disabled', 'overlayClassName', 'overlayStyle', 'placement', 'trigger', 'autoAdjustOverflow', 'visible', 'popupContainer', 'batchPropsNames', 'batchPropsValues', 'data-*', 'aria-*']
-        self.available_wildcard_properties =            ['data-', 'aria-']
+        self._prop_names = [
+            'id',
+            'key',
+            'children',
+            'style',
+            'className',
+            'wrapperStyle',
+            'wrapperClassName',
+            'title',
+            'buttonMode',
+            'buttonProps',
+            'freePosition',
+            'freePositionStyle',
+            'freePositionClassName',
+            'clickedKey',
+            'nClicks',
+            'menuItems',
+            'selectable',
+            'multiple',
+            'selectedKeys',
+            'nonSelectableKeys',
+            'arrow',
+            'disabled',
+            'overlayClassName',
+            'overlayStyle',
+            'placement',
+            'trigger',
+            'autoAdjustOverflow',
+            'visible',
+            'popupContainer',
+            'batchPropsNames',
+            'batchPropsValues',
+            'data-*',
+            'aria-*',
+        ]
+        self._valid_wildcard_attributes = ['data-', 'aria-']
+        self.available_properties = [
+            'id',
+            'key',
+            'children',
+            'style',
+            'className',
+            'wrapperStyle',
+            'wrapperClassName',
+            'title',
+            'buttonMode',
+            'buttonProps',
+            'freePosition',
+            'freePositionStyle',
+            'freePositionClassName',
+            'clickedKey',
+            'nClicks',
+            'menuItems',
+            'selectable',
+            'multiple',
+            'selectedKeys',
+            'nonSelectableKeys',
+            'arrow',
+            'disabled',
+            'overlayClassName',
+            'overlayStyle',
+            'placement',
+            'trigger',
+            'autoAdjustOverflow',
+            'visible',
+            'popupContainer',
+            'batchPropsNames',
+            'batchPropsValues',
+            '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
@@ -247,4 +321,5 @@ Keyword arguments:
 
         super(AntdDropdown, self).__init__(children=children, **args)
 
-setattr(AntdDropdown, "__init__", _explicitize_args(AntdDropdown.__init__))
+
+setattr(AntdDropdown, '__init__', _explicitize_args(AntdDropdown.__init__))