feffery_antd_components 0.3.0-rc8 → 0.3.0

package/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: fefferyAntdComponents
 Title: Best implementation of Antd components in Plotly Dash.
-Version: 0.3.0-rc8
+Version: 0.3.0
 Description: Best implementation of Antd components in Plotly Dash.
 Depends: R (>= 3.0.2)
 Imports: 

package/MANIFEST.in

@@ -1,7 +1,6 @@
-include feffery_antd_components/feffery_antd_components.min.js
-exclude feffery_antd_components/feffery_antd_components.min.js.map
-include feffery_antd_components/metadata.json
-include feffery_antd_components/package-info.json
+include feffery_antd_components/*.js
+exclude feffery_antd_components/*.map
+include *.json
 include README.md
 include LICENSE
 include package.json

package/NAMESPACE

@@ -39,6 +39,7 @@ export('feffery'AntdDateRangePicker)
 export('feffery'AntdInput)
 export('feffery'AntdInputNumber)
 export('feffery'AntdMentions)
+export('feffery'AntdOTP)
 export('feffery'AntdRadioGroup)
 export('feffery'AntdRate)
 export('feffery'AntdSegmentedColoring)
@@ -72,6 +73,7 @@ export('feffery'AntdSkeletonAvatar)
 export('feffery'AntdSkeletonButton)
 export('feffery'AntdSkeletonImage)
 export('feffery'AntdSkeletonInput)
+export('feffery'AntdFormRender)
 export('feffery'AntdButton)
 export('feffery'AntdFloatButton)
 export('feffery'AntdFloatButtonGroup)
@@ -91,14 +93,14 @@ export('feffery'AntdSider)
 export('feffery'AntdSpace)
 export('feffery'AntdCol)
 export('feffery'AntdRow)
-export('feffery'AntdAffix)
+export('feffery'AntdAnchor)
 export('feffery'AntdBreadcrumb)
 export('feffery'AntdDropdown)
 export('feffery'AntdMenu)
 export('feffery'AntdPageHeader)
 export('feffery'AntdPagination)
 export('feffery'AntdSteps)
-export('feffery'AntdAnchor)
+export('feffery'AntdAffix)
 export('feffery'AntdBackTop)
 export('feffery'AntdConfigProvider)
 export('feffery'AntdCopyText)

package/Project.toml

@@ -2,7 +2,7 @@
 name = "FefferyAntdComponents"
 uuid = "1b08a953-4be3-4667-9a23-baf51bd2b26e"
 authors = ["CNFeffery <fefferypzy@gmail.com>"]
-version = "0.3.0-rc8"
+version = "0.3.0"
 
 [deps]
 Dash = "1b08a953-4be3-4667-9a23-3db579824955"

package/README-en_US.md

@@ -26,7 +26,7 @@ pip install feffery-antd-components -U
 ## 2 Install the latest preview release version
 
 > [!NOTE]  
-> The latest preview release version (2024-03-11): `0.3.0rc7`
+> The latest preview release version (2024-08-09): `0.3.0rc31`
 
 ```bash
 pip install feffery-antd-components --pre -U

package/README.md

@@ -1,3 +1,6 @@
+> [!IMPORTANT]  
+> `0.3.x`[新版文档网站预览版](https://fac-next.feffery.tech/)正在快速更新建设中，欢迎[参与官网建设](https://github.com/CNFeffery/feffery-antd-docs/issues/9)
+
 <p align="center">
 	<img src="./fac-logo.svg" height=300></img>
 </p>
@@ -26,7 +29,7 @@ pip install feffery-antd-components -U
 ## 2 最新预发布版本安装方式
 
 > [!NOTE]  
-> 最新预发布版本（2024-03-11）：`0.3.0rc7`
+> 最新预发布版本（2024-08-09）：`0.3.0rc31`
 
 ```bash
 pip install feffery-antd-components --pre -U

package/bug_fix.py

@@ -1,5 +1,4 @@
 import dash
-import numpy as np
 from dash import html
 import feffery_antd_components as fac
 
@@ -7,11 +6,44 @@ app = dash.Dash(__name__)
 
 app.layout = html.Div(
     [
+        fac.AntdImageGroup(
+            fac.AntdSpace(
+                [
+                    fac.AntdSpace(
+                        [
+                            fac.AntdImage(
+                                src=f'/assets/示例图片{i}.png',
+                                height=100,
+                            )
+                            for i in range(2, 5)
+                        ]
+                    ),
+                    fac.AntdSpace(
+                        [
+                            fac.AntdImage(
+                                src=f'/assets/示例图片{i}.png',
+                                height=100,
+                            )
+                            for i in range(5, 7)
+                        ]
+                    ),
+                    fac.AntdSpace(
+                        [
+                            fac.AntdImage(
+                                src=f'/assets/示例图片{i}.png',
+                                height=100,
+                            )
+                            for i in range(7, 9)
+                        ]
+                    ),
+                ],
+                direction='vertical',
+                style={'width': '100%'},
+            )
+        )
     ],
-    style={
-        'padding': 30
-    }
+    style={'padding': 50},
 )
 
 if __name__ == '__main__':
-    app.run(debug=True)
+    app.run(debug=True, dev_tools_serve_dev_bundles=True)

package/feffery_antd_components/AntdAccordion.py

@@ -5,53 +5,77 @@ from dash.development.base_component import Component, _explicitize_args
 
 class AntdAccordion(Component):
     """An AntdAccordion component.
-
+手风琴组件AntdAccordion
 
 Keyword arguments:
 
-- children (a list of or a singular dash component, string or number; optional)
+- id (string; optional):
+    组件唯一id.
+
+- accordion (boolean; default True):
+    是否开启手风琴模式  默认值：`True`.
 
-- id (string; optional)
+- activeKey (string | list of strings | number | list of numbers; optional):
+    监听或设置当前处于展开状态的手风琴项key值.
 
-- accordion (boolean; default True)
+- aria-* (string; optional):
+    `aria-*`格式属性通配.
 
-- activeKey (string | list of strings | number | list of numbers; optional)
+- bordered (boolean; default True):
+    是否渲染边框  默认值：`True`.
 
-- bordered (boolean; default True)
+- className (string | dict; optional):
+    当前组件css类名，支持[动态css](/advanced-classname).
 
-- className (string | dict; optional)
+- collapsible (a value equal to: 'header', 'disabled', 'icon'; optional):
+    设置所有子项折叠触发方式，可选项有`'header'`、`'disabled'`、`'icon'`.
 
-- collapsible (a value equal to: 'header', 'disabled', 'icon'; optional)
+- data-* (string; optional):
+    `data-*`格式属性通配.
 
-- defaultActiveKey (string | list of strings | number | list of numbers; optional)
+- defaultActiveKey (string | list of strings | number | list of numbers; optional):
+    设置初始化处于展开状态的手风琴项key值.
 
-- expandIconPosition (a value equal to: 'left', 'right'; default 'left')
+- expandIconPosition (a value equal to: 'left', 'right'; default 'left'):
+    设置折叠图标位置，可选项有`'left'`、`'right'`.
 
-- ghost (boolean; default False)
+- ghost (boolean; default False):
+    是否开启透明无边框模式  默认值：`False`.
 
-- items (list of dicts; optional)
+- items (list of dicts; optional):
+    定义手风琴子项.
 
     `items` is a list of dicts 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):
+        当前子项内部元素.
 
-    - className (string | dict; optional)
+    - className (string | dict; optional):
+        当前子项css类名，支持[动态css](/advanced-classname).
 
-    - collapsible (a value equal to: 'header', 'disabled', 'icon'; optional)
+    - collapsible (a value equal to: 'header', 'disabled', 'icon'; optional):
+        当前子项折叠触发方式，可选项有`'header'`、`'disabled'`、`'icon'`.
 
-    - 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):
+        当前子项右上角额外元素.
 
-    - forceRender (boolean; optional)
+    - forceRender (boolean; optional):
+        是否强制渲染内部元素  默认值：`False`.
 
-    - key (string | number; required)
+    - key (string | number; required):
+        必填，当前子项唯一key值.
 
-    - showArrow (boolean; optional)
+    - showArrow (boolean; optional):
+        是否展示当前手风琴项的箭头图标  默认值：`True`.
 
-    - style (dict; optional)
+    - style (dict; optional):
+        当前子项css样式.
 
-    - 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):
+        当前子项标题元素.
 
-- key (string; optional)
+- key (string; optional):
+    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
 - loading_state (dict; optional)
 
@@ -66,20 +90,21 @@ Keyword arguments:
     - prop_name (string; optional):
         Holds which property is loading.
 
-- style (dict; optional)"""
+- style (dict; optional):
+    当前组件css样式."""
     _children_props = ['items[].children', 'items[].title', 'items[].extra']
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdAccordion'
     @_explicitize_args
-    def __init__(self, children=None, id=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, items=Component.UNDEFINED, accordion=Component.UNDEFINED, activeKey=Component.UNDEFINED, defaultActiveKey=Component.UNDEFINED, bordered=Component.UNDEFINED, collapsible=Component.UNDEFINED, expandIconPosition=Component.UNDEFINED, ghost=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['children', 'id', 'accordion', 'activeKey', 'bordered', 'className', 'collapsible', 'defaultActiveKey', 'expandIconPosition', 'ghost', 'items', 'key', 'loading_state', 'style']
-        self._valid_wildcard_attributes =            []
-        self.available_properties = ['children', 'id', 'accordion', 'activeKey', 'bordered', 'className', 'collapsible', 'defaultActiveKey', 'expandIconPosition', 'ghost', 'items', 'key', 'loading_state', 'style']
-        self.available_wildcard_properties =            []
+    def __init__(self, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, items=Component.UNDEFINED, accordion=Component.UNDEFINED, activeKey=Component.UNDEFINED, defaultActiveKey=Component.UNDEFINED, bordered=Component.UNDEFINED, collapsible=Component.UNDEFINED, expandIconPosition=Component.UNDEFINED, ghost=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['id', 'accordion', 'activeKey', 'aria-*', 'bordered', 'className', 'collapsible', 'data-*', 'defaultActiveKey', 'expandIconPosition', 'ghost', 'items', 'key', 'loading_state', 'style']
+        self._valid_wildcard_attributes =            ['data-', 'aria-']
+        self.available_properties = ['id', 'accordion', 'activeKey', 'aria-*', 'bordered', 'className', 'collapsible', 'data-*', 'defaultActiveKey', 'expandIconPosition', 'ghost', 'items', 'key', 'loading_state', 'style']
+        self.available_wildcard_properties =            ['data-', 'aria-']
         _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 if k != 'children'}
+        args = {k: _locals[k] for k in _explicit_args}
 
-        super(AntdAccordion, self).__init__(children=children, **args)
+        super(AntdAccordion, self).__init__(**args)

package/feffery_antd_components/AntdAffix.py

@@ -5,17 +5,27 @@ from dash.development.base_component import Component, _explicitize_args
 
 class AntdAffix(Component):
     """An AntdAffix component.
-
+固钉组件AntdAffix
 
 Keyword arguments:
 
-- 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):
+    组件型，内嵌元素.
+
+- id (string; optional):
+    组件唯一id.
+
+- aria-* (string; optional):
+    `aria-*`格式属性通配.
 
-- id (string; optional)
+- className (string | dict; optional):
+    当前组件css类名，支持[动态css](/advanced-classname).
 
-- className (string | dict; optional)
+- data-* (string; optional):
+    `data-*`格式属性通配.
 
-- key (string; optional)
+- key (string; optional):
+    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
 - loading_state (dict; optional)
 
@@ -30,23 +40,27 @@ Keyword arguments:
     - prop_name (string; optional):
         Holds which property is loading.
 
-- offsetBottom (number; optional)
+- offsetBottom (number; optional):
+    触发固钉效果的视窗底部距离像素阈值.
 
-- offsetTop (number; default 0)
+- offsetTop (number; default 0):
+    触发固钉效果的视窗顶部距离像素阈值  默认值：`0`.
 
-- style (dict; optional)
+- style (dict; optional):
+    当前组件css样式.
 
-- target (string; optional)"""
+- target (string; optional):
+    滚动事件监听的特定目标容器id."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdAffix'
     @_explicitize_args
-    def __init__(self, children=None, id=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, offsetBottom=Component.UNDEFINED, offsetTop=Component.UNDEFINED, target=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['children', 'id', 'className', 'key', 'loading_state', 'offsetBottom', 'offsetTop', 'style', 'target']
-        self._valid_wildcard_attributes =            []
-        self.available_properties = ['children', 'id', 'className', 'key', 'loading_state', 'offsetBottom', 'offsetTop', 'style', 'target']
-        self.available_wildcard_properties =            []
+    def __init__(self, children=None, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, offsetBottom=Component.UNDEFINED, offsetTop=Component.UNDEFINED, target=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['children', 'id', 'aria-*', 'className', 'data-*', 'key', 'loading_state', 'offsetBottom', 'offsetTop', 'style', 'target']
+        self._valid_wildcard_attributes =            ['data-', 'aria-']
+        self.available_properties = ['children', 'id', 'aria-*', 'className', 'data-*', 'key', 'loading_state', 'offsetBottom', 'offsetTop', 'style', 'target']
+        self.available_wildcard_properties =            ['data-', 'aria-']
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()
         _locals.update(kwargs)  # For wildcard attrs and excess named props

package/feffery_antd_components/AntdAlert.py

@@ -5,23 +5,36 @@ from dash.development.base_component import Component, _explicitize_args
 
 class AntdAlert(Component):
     """An AntdAlert component.
-
+警告提示组件AntdAlert
 
 Keyword arguments:
 
-- id (string; optional)
+- id (string; optional):
+    组件唯一id.
+
+- action (a list of or a singular dash component, string or number; optional):
+    组件型，定义右上角额外操作区元素.
+
+- aria-* (string; optional):
+    `aria-*`格式属性通配.
 
-- action (a list of or a singular dash component, string or number; optional)
+- banner (boolean; default False):
+    是否用作顶部公告  默认值：`False`.
 
-- banner (boolean; default False)
+- className (string | dict; optional):
+    当前组件css类名，支持[动态css](/advanced-classname).
 
-- className (string | dict; optional)
+- closable (boolean; default False):
+    是否可关闭  默认值：`False`.
 
-- closable (boolean; default False)
+- data-* (string; optional):
+    `data-*`格式属性通配.
 
-- 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):
+    额外提示信息内容.
 
-- key (string; optional)
+- key (string; optional):
+    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
 - loading_state (dict; optional)
 
@@ -36,25 +49,31 @@ Keyword arguments:
     - prop_name (string; optional):
         Holds which property is loading.
 
-- message (a list of or a singular dash component, string or number; optional)
+- message (a list of or a singular dash component, string or number; optional):
+    主要提示信息内容.
 
-- messageRenderMode (a value equal to: 'default', 'loop-text', 'marquee'; default 'default')
+- messageRenderMode (a value equal to: 'default', 'loop-text', 'marquee'; default 'default'):
+    渲染模式，可选项有`'default'`、`'loop-text'`、`'marquee'`  默认值：`'default'`.
 
-- showIcon (boolean; default False)
+- showIcon (boolean; default False):
+    是否显示额外图标  默认值：`False`.
 
-- style (dict; optional)
+- style (dict; optional):
+    当前组件css样式.
 
-- type (a value equal to: 'success', 'info', 'warning', 'error'; default 'info')"""
+- type (a value equal to: 'success', 'info', 'warning', 'error'; default 'info'):
+    提示信息类型，可选项有`'success'`、`'info'`、`'warning'`、`'error'`
+    默认值：`'info'`."""
     _children_props = ['message', 'description', 'action']
     _base_nodes = ['message', 'description', 'action', 'children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdAlert'
     @_explicitize_args
-    def __init__(self, id=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, message=Component.UNDEFINED, description=Component.UNDEFINED, type=Component.UNDEFINED, showIcon=Component.UNDEFINED, closable=Component.UNDEFINED, messageRenderMode=Component.UNDEFINED, action=Component.UNDEFINED, banner=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['id', 'action', 'banner', 'className', 'closable', 'description', 'key', 'loading_state', 'message', 'messageRenderMode', 'showIcon', 'style', 'type']
-        self._valid_wildcard_attributes =            []
-        self.available_properties = ['id', 'action', 'banner', 'className', 'closable', 'description', 'key', 'loading_state', 'message', 'messageRenderMode', 'showIcon', 'style', 'type']
-        self.available_wildcard_properties =            []
+    def __init__(self, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, message=Component.UNDEFINED, description=Component.UNDEFINED, type=Component.UNDEFINED, showIcon=Component.UNDEFINED, closable=Component.UNDEFINED, messageRenderMode=Component.UNDEFINED, action=Component.UNDEFINED, banner=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['id', 'action', 'aria-*', 'banner', 'className', 'closable', 'data-*', 'description', 'key', 'loading_state', 'message', 'messageRenderMode', 'showIcon', 'style', 'type']
+        self._valid_wildcard_attributes =            ['data-', 'aria-']
+        self.available_properties = ['id', 'action', 'aria-*', 'banner', 'className', 'closable', 'data-*', 'description', 'key', 'loading_state', 'message', 'messageRenderMode', 'showIcon', 'style', 'type']
+        self.available_wildcard_properties =            ['data-', 'aria-']
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()
         _locals.update(kwargs)  # For wildcard attrs and excess named props

package/feffery_antd_components/AntdAnchor.py

@@ -5,27 +5,42 @@ from dash.development.base_component import Component, _explicitize_args
 
 class AntdAnchor(Component):
     """An AntdAnchor component.
-
+锚点组件AntdAnchor
 
 Keyword arguments:
 
-- id (string; optional)
+- id (string; optional):
+    组件唯一id.
+
+- affix (boolean; default True):
+    是否开启固定模式  默认值：`True`.
+
+- align (a value equal to: 'left', 'right'; default 'right'):
+    锚点位置，可选项有`'left'`、`'right'`  默认值：`'right'`.
 
-- affix (boolean; default True)
+- aria-* (string; optional):
+    `aria-*`格式属性通配.
 
-- align (a value equal to: 'left', 'right'; default 'right')
+- bounds (number; default 5):
+    锚点像素边距  默认值：`5`.
 
-- bounds (number; default 5)
+- className (string | dict; optional):
+    当前组件css类名，支持[动态css](/advanced-classname).
 
-- className (string | dict; optional)
+- clickedLink (dict; optional):
+    监听锚点节点点击事件.
 
-- clickedLink (dict; optional)
+- containerId (string; optional):
+    锚点目标容器id.
 
-- containerId (string; optional)
+- data-* (string; optional):
+    `data-*`格式属性通配.
 
-- key (string; optional)
+- key (string; optional):
+    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
-- linkDict (optional)
+- linkDict (optional):
+    目录层次数据结构.
 
 - loading_state (dict; optional)
 
@@ -40,21 +55,24 @@ Keyword arguments:
     - prop_name (string; optional):
         Holds which property is loading.
 
-- offsetTop (number; optional)
+- offsetTop (number; optional):
+    设置距离窗口顶部触发锚定效果的指定像素偏移量.
 
-- style (dict; optional)
+- style (dict; optional):
+    当前组件css样式.
 
-- targetOffset (number; optional)"""
+- targetOffset (number; optional):
+    锚点位移偏移量，默认同参数offsetTop."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdAnchor'
     @_explicitize_args
-    def __init__(self, id=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, linkDict=Component.UNDEFINED, align=Component.UNDEFINED, containerId=Component.UNDEFINED, targetOffset=Component.UNDEFINED, affix=Component.UNDEFINED, bounds=Component.UNDEFINED, offsetTop=Component.UNDEFINED, clickedLink=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['id', 'affix', 'align', 'bounds', 'className', 'clickedLink', 'containerId', 'key', 'linkDict', 'loading_state', 'offsetTop', 'style', 'targetOffset']
-        self._valid_wildcard_attributes =            []
-        self.available_properties = ['id', 'affix', 'align', 'bounds', 'className', 'clickedLink', 'containerId', 'key', 'linkDict', 'loading_state', 'offsetTop', 'style', 'targetOffset']
-        self.available_wildcard_properties =            []
+    def __init__(self, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, linkDict=Component.UNDEFINED, align=Component.UNDEFINED, containerId=Component.UNDEFINED, targetOffset=Component.UNDEFINED, affix=Component.UNDEFINED, bounds=Component.UNDEFINED, offsetTop=Component.UNDEFINED, clickedLink=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['id', 'affix', 'align', 'aria-*', 'bounds', 'className', 'clickedLink', 'containerId', 'data-*', 'key', 'linkDict', 'loading_state', 'offsetTop', 'style', 'targetOffset']
+        self._valid_wildcard_attributes =            ['data-', 'aria-']
+        self.available_properties = ['id', 'affix', 'align', 'aria-*', 'bounds', 'className', 'clickedLink', 'containerId', 'data-*', 'key', 'linkDict', 'loading_state', 'offsetTop', 'style', 'targetOffset']
+        self.available_wildcard_properties =            ['data-', 'aria-']
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()
         _locals.update(kwargs)  # For wildcard attrs and excess named props

package/feffery_antd_components/AntdAvatar.py

@@ -5,27 +5,42 @@ from dash.development.base_component import Component, _explicitize_args
 
 class AntdAvatar(Component):
     """An AntdAvatar component.
-
+头像组件AntdAvatar
 
 Keyword arguments:
 
-- id (string; optional)
+- id (string; optional):
+    组件唯一id.
+
+- alt (string; optional):
+    `mode='image'`时，设置图像无法显示时的占位文字.
+
+- aria-* (string; optional):
+    `aria-*`格式属性通配.
 
-- alt (string; optional)
+- className (string | dict; optional):
+    当前组件css类名，支持[动态css](/advanced-classname).
 
-- className (string | dict; optional)
+- crossOrigin (a value equal to: 'anonymous', 'use-credentials', ''; optional):
+    `mode='image'`时，设置图片的CORS属性，可选项有`'anonymous'`、`'use-credentials'`、`''`.
 
-- crossOrigin (a value equal to: 'anonymous', 'use-credentials', ''; optional)
+- data-* (string; optional):
+    `data-*`格式属性通配.
 
-- draggable (boolean | a value equal to: 'true', 'false'; optional)
+- draggable (boolean | a value equal to: 'true', 'false'; optional):
+    `mode='image'`时，设置图片是否允许拖拽.
 
-- gap (number; default 4)
+- gap (number; default 4):
+    `mode='text'`时，设置字符距离左右两侧边界的像素距离  默认值：`4`.
 
-- icon (string; optional)
+- icon (string; optional):
+    `mode='icon'`时，设置图标，同**AntdIcon**的`icon`参数.
 
-- iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; default 'AntdIcon')
+- iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; default 'AntdIcon'):
+    `mode='icon'`时，设置图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`.
 
-- key (string; optional)
+- key (string; optional):
+    对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果.
 
 - loading_state (dict; optional)
 
@@ -40,11 +55,14 @@ Keyword arguments:
     - prop_name (string; optional):
         Holds which property is loading.
 
-- mode (a value equal to: 'text', 'icon', 'image'; default 'icon')
+- mode (a value equal to: 'text', 'icon', 'image'; default 'icon'):
+    头像模式，可选项有`'text'`、`'icon'`、`'image'`  默认值：`'icon'`.
 
-- shape (a value equal to: 'circle', 'square'; default 'circle')
+- shape (a value equal to: 'circle', 'square'; default 'circle'):
+    头像形状，可选项有`'circle'`、`'square'`  默认值：`'circle'`.
 
-- size (dict; default 'default')
+- size (dict; optional):
+    配置头像尺寸，可传入数值型代表像素尺寸（支持响应式），或传入字符型使用预设尺寸规格，可选项有`'large'`、`'small'`、`'default'`.
 
     `size` is a number | a value equal to: 'large', 'small', 'default'
     | dict with keys:
@@ -61,23 +79,27 @@ Keyword arguments:
 
     - xxl (number; optional)
 
-- src (string; optional)
+- src (string; optional):
+    `mode='image'`时，设置图片地址.
 
-- srcSet (string; optional)
+- srcSet (string; optional):
+    `mode='image'`时，设置图片base64地址.
 
-- style (dict; optional)
+- style (dict; optional):
+    当前组件css样式.
 
-- text (string; optional)"""
+- text (string; optional):
+    `mode='text'`时，设置文字内容."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'
     _type = 'AntdAvatar'
     @_explicitize_args
-    def __init__(self, id=Component.UNDEFINED, className=Component.UNDEFINED, style=Component.UNDEFINED, key=Component.UNDEFINED, mode=Component.UNDEFINED, gap=Component.UNDEFINED, text=Component.UNDEFINED, icon=Component.UNDEFINED, iconRenderer=Component.UNDEFINED, alt=Component.UNDEFINED, src=Component.UNDEFINED, srcSet=Component.UNDEFINED, draggable=Component.UNDEFINED, crossOrigin=Component.UNDEFINED, size=Component.UNDEFINED, shape=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['id', 'alt', 'className', 'crossOrigin', 'draggable', 'gap', 'icon', 'iconRenderer', 'key', 'loading_state', 'mode', 'shape', 'size', 'src', 'srcSet', 'style', 'text']
-        self._valid_wildcard_attributes =            []
-        self.available_properties = ['id', 'alt', 'className', 'crossOrigin', 'draggable', 'gap', 'icon', 'iconRenderer', 'key', 'loading_state', 'mode', 'shape', 'size', 'src', 'srcSet', 'style', 'text']
-        self.available_wildcard_properties =            []
+    def __init__(self, id=Component.UNDEFINED, key=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, mode=Component.UNDEFINED, gap=Component.UNDEFINED, text=Component.UNDEFINED, icon=Component.UNDEFINED, iconRenderer=Component.UNDEFINED, alt=Component.UNDEFINED, src=Component.UNDEFINED, srcSet=Component.UNDEFINED, draggable=Component.UNDEFINED, crossOrigin=Component.UNDEFINED, size=Component.UNDEFINED, shape=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['id', 'alt', 'aria-*', 'className', 'crossOrigin', 'data-*', 'draggable', 'gap', 'icon', 'iconRenderer', 'key', 'loading_state', 'mode', 'shape', 'size', 'src', 'srcSet', 'style', 'text']
+        self._valid_wildcard_attributes =            ['data-', 'aria-']
+        self.available_properties = ['id', 'alt', 'aria-*', 'className', 'crossOrigin', 'data-*', 'draggable', 'gap', 'icon', 'iconRenderer', 'key', 'loading_state', 'mode', 'shape', 'size', 'src', 'srcSet', 'style', 'text']
+        self.available_wildcard_properties =            ['data-', 'aria-']
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()
         _locals.update(kwargs)  # For wildcard attrs and excess named props