doc: 更新README

CNFeffery · Sep 14, 2024 · d206896 · d206896
1 parent 2d4a099
commit d206896
Show file tree

Hide file tree

Showing 116 changed files with 1,468 additions and 1,469 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: fefferyAntdComponents
 Title: Best implementation of Antd components in Plotly Dash.
-Version: 0.3.5
+Version: 0.3.6
 Description: Best implementation of Antd components in Plotly Dash.
 Depends: R (>= 3.0.2)
 Imports: 

diff --git a/Project.toml b/Project.toml
@@ -2,7 +2,7 @@
 name = "FefferyAntdComponents"
 uuid = "1b08a953-4be3-4667-9a23-674b58f7de79"
 authors = ["CNFeffery <[email protected]>"]
-version = "0.3.5"
+version = "0.3.6"
 
 [deps]
 Dash = "1b08a953-4be3-4667-9a23-3db579824955"

diff --git a/README-en_US.md b/README-en_US.md
@@ -15,7 +15,7 @@
 
 [简体中文](./README.md) | English
 
-Subproject of `feffery-components` projects, third-party components library of `Plotly Dash`, based on the [Antd](https://github.com/ant-design/ant-design), brings many common and powerful components into `Dash`🥳, latest stable version: `0.3.4`
+Subproject of `feffery-components` projects, third-party components library of `Plotly Dash`, based on the [Antd](https://github.com/ant-design/ant-design), brings many common and powerful components into `Dash`🥳, latest stable version: `0.3.6`
 
 ## 1 Install
 

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 
 简体中文 | [English](./README-en_US.md)
 
-`feffery-components`计划子项目，`Plotly Dash`第三方组件库，基于`Antd`，将超多具有丰富功能的通用网页常用交互组件引入`Dash`的生态中 🥳，最新稳定版本：`0.3.4`
+`feffery-components`计划子项目，`Plotly Dash`第三方组件库，基于`Antd`，将超多具有丰富功能的通用网页常用交互组件引入`Dash`的生态中 🥳，最新稳定版本：`0.3.6`
 
 ## 1 最新版本安装方式
 

diff --git a/bug_fix.py b/bug_fix.py
@@ -6,26 +6,25 @@
 
 app.layout = html.Div(
     [
-        fac.AntdAnchor(
-            linkDict=[
-                {
-                    'title': '报告信息',
-                    'href': '#edit_permeate_report_info',
-                },
-                {
-                    'title': '测试范围',
-                    'href': '#edit_permeate_report_test_range',
-                },
-                {
-                    'title': '客户信息',
-                    'href': '#edit_permeate_report_customer_info',
-                },
-                {
-                    'title': '测试方信息',
-                    'href': '#edit_permeate_report_tester_info',
-                },
+        fac.AntdRow(
+            [
+                fac.AntdCol(
+                    fac.AntdCenter(
+                        f'col{i}',
+                        style={
+                            'backgroundColor': '#1677ff'
+                            if i % 2 == 0
+                            else '#1677ffbf',
+                            'color': 'white',
+                            'height': 100,
+                        },
+                    ),
+                    span=6,
+                )
+                for i in range(1, 5)
             ],
-            align='left',
+            gutter=10,
+            align='center',
         )
     ],
     style={'padding': 50},

diff --git a/feffery_antd_components/AntdAccordion.py b/feffery_antd_components/AntdAccordion.py
@@ -32,26 +32,26 @@ class AntdAccordion(Component):
     - className (string | dict; optional):
         当前子项css类名，支持[动态css](/advanced-classname).
 
-    - style (dict; optional):
-        当前子项css样式.
-
-    - key (string | number; required):
-        必填，当前子项唯一key值.
-
     - collapsible (a value equal to: 'header', 'disabled', 'icon'; optional):
         当前子项折叠触发方式，可选项有`'header'`、`'disabled'`、`'icon'`.
 
-    - 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):
         当前子项右上角额外元素.
 
+    - forceRender (boolean; optional):
+        是否强制渲染内部元素  默认值：`False`.
+
+    - key (string | number; required):
+        必填，当前子项唯一key值.
+
     - showArrow (boolean; optional):
         是否展示当前手风琴项的箭头图标  默认值：`True`.
 
-    - forceRender (boolean; optional):
-        是否强制渲染内部元素  默认值：`False`.
+    - style (dict; optional):
+        当前子项css样式.
+
+    - title (a list of or a singular dash component, string or number; optional):
+        当前子项标题元素.
 
 - accordion (boolean; default True):
     是否开启手风琴模式  默认值：`True`.
@@ -84,14 +84,14 @@ class AntdAccordion(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = ['items[].children', 'items[].title', 'items[].extra']
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdAffix.py b/feffery_antd_components/AntdAffix.py
@@ -43,14 +43,14 @@ class AntdAffix(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdAlert.py b/feffery_antd_components/AntdAlert.py
@@ -56,14 +56,14 @@ class AntdAlert(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = ['message', 'description', 'action']
     _base_nodes = ['message', 'description', 'action', 'children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdAnchor.py b/feffery_antd_components/AntdAnchor.py
@@ -55,14 +55,14 @@ class AntdAnchor(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdAvatar.py b/feffery_antd_components/AntdAvatar.py
@@ -57,16 +57,16 @@ class AntdAvatar(Component):
     `size` is a number | a value equal to: 'large', 'small', 'default'
     | dict with keys:
 
-    - xs (number; optional)
-
-    - sm (number; optional)
+    - lg (number; optional)
 
     - md (number; optional)
 
-    - lg (number; optional)
+    - sm (number; optional)
 
     - xl (number; optional)
 
+    - xs (number; optional)
+
     - xxl (number; optional)
 
 - shape (a value equal to: 'circle', 'square'; default 'circle'):
@@ -82,14 +82,14 @@ class AntdAvatar(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdAvatarGroup.py b/feffery_antd_components/AntdAvatarGroup.py
@@ -44,16 +44,16 @@ class AntdAvatarGroup(Component):
     `size` is a number | a value equal to: 'large', 'small', 'default'
     | dict with keys:
 
-    - xs (number; optional)
-
-    - sm (number; optional)
+    - lg (number; optional)
 
     - md (number; optional)
 
-    - lg (number; optional)
+    - sm (number; optional)
 
     - xl (number; optional)
 
+    - xs (number; optional)
+
     - xxl (number; optional)
 
 - data-* (string; optional):
@@ -66,14 +66,14 @@ class AntdAvatarGroup(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdBackTop.py b/feffery_antd_components/AntdBackTop.py
@@ -46,14 +46,14 @@ class AntdBackTop(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'

diff --git a/feffery_antd_components/AntdBadge.py b/feffery_antd_components/AntdBadge.py
@@ -29,23 +29,23 @@ class AntdBadge(Component):
 
     `styles` is a dict with keys:
 
-    - root (dict; optional):
-        控制根元素css样式.
-
     - indicator (dict; optional):
         控制徽标元素css样式.
 
+    - root (dict; optional):
+        控制根元素css样式.
+
 - classNames (dict; optional):
     细分控制子元素css类.
 
     `classNames` is a dict with keys:
 
-    - root (string; optional):
-        控制根元素css类.
-
     - indicator (string; optional):
         控制徽标元素css类.
 
+    - root (string; optional):
+        控制根元素css类.
+
 - color (string; optional):
     徽标颜色.
 
@@ -89,14 +89,14 @@ class AntdBadge(Component):
 
     `loading_state` is a dict with keys:
 
+    - component_name (string; optional):
+        Holds the name of the component that is loading.
+
     - is_loading (boolean; optional):
         Determines if the component is loading or not.
 
     - prop_name (string; optional):
-        Holds which property is loading.
-
-    - component_name (string; optional):
-        Holds the name of the component that is loading."""
+        Holds which property is loading."""
     _children_props = []
     _base_nodes = ['children']
     _namespace = 'feffery_antd_components'