From d206896cfa3d53d068f81d72d32118587be3ef9a Mon Sep 17 00:00:00 2001 From: CNFeffery Date: Sat, 14 Sep 2024 15:59:48 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DESCRIPTION | 2 +- Project.toml | 2 +- README-en_US.md | 2 +- README.md | 2 +- bug_fix.py | 37 +- feffery_antd_components/AntdAccordion.py | 30 +- feffery_antd_components/AntdAffix.py | 8 +- feffery_antd_components/AntdAlert.py | 8 +- feffery_antd_components/AntdAnchor.py | 8 +- feffery_antd_components/AntdAvatar.py | 16 +- feffery_antd_components/AntdAvatarGroup.py | 16 +- feffery_antd_components/AntdBackTop.py | 8 +- feffery_antd_components/AntdBadge.py | 20 +- feffery_antd_components/AntdBreadcrumb.py | 52 +- feffery_antd_components/AntdButton.py | 8 +- feffery_antd_components/AntdCalendar.py | 28 +- feffery_antd_components/AntdCard.py | 26 +- feffery_antd_components/AntdCardGrid.py | 8 +- feffery_antd_components/AntdCardMeta.py | 8 +- feffery_antd_components/AntdCarousel.py | 8 +- feffery_antd_components/AntdCascader.py | 6 +- feffery_antd_components/AntdCenter.py | 8 +- feffery_antd_components/AntdCheckCard.py | 6 +- feffery_antd_components/AntdCheckCardGroup.py | 6 +- feffery_antd_components/AntdCheckableTag.py | 8 +- feffery_antd_components/AntdCheckbox.py | 6 +- feffery_antd_components/AntdCheckboxGroup.py | 14 +- feffery_antd_components/AntdCol.py | 44 +- feffery_antd_components/AntdCollapse.py | 6 +- feffery_antd_components/AntdColorPicker.py | 14 +- feffery_antd_components/AntdComment.py | 14 +- feffery_antd_components/AntdCompact.py | 8 +- feffery_antd_components/AntdConfigProvider.py | 8 +- feffery_antd_components/AntdContent.py | 8 +- feffery_antd_components/AntdCopyText.py | 8 +- feffery_antd_components/AntdCountdown.py | 8 +- feffery_antd_components/AntdCustomSkeleton.py | 8 +- feffery_antd_components/AntdDatePicker.py | 26 +- .../AntdDateRangePicker.py | 26 +- .../AntdDescriptionItem.py | 8 +- feffery_antd_components/AntdDescriptions.py | 38 +- feffery_antd_components/AntdDivider.py | 8 +- feffery_antd_components/AntdDraggablePanel.py | 14 +- feffery_antd_components/AntdDraggerUpload.py | 90 ++-- feffery_antd_components/AntdDrawer.py | 32 +- feffery_antd_components/AntdDropdown.py | 44 +- feffery_antd_components/AntdEditorLayout.py | 124 ++--- feffery_antd_components/AntdEmpty.py | 8 +- feffery_antd_components/AntdFlex.py | 8 +- feffery_antd_components/AntdFloatButton.py | 8 +- .../AntdFloatButtonGroup.py | 8 +- feffery_antd_components/AntdFooter.py | 8 +- feffery_antd_components/AntdForm.py | 24 +- feffery_antd_components/AntdFormItem.py | 24 +- feffery_antd_components/AntdFormRender.py | 484 +++++++++--------- feffery_antd_components/AntdHeader.py | 8 +- feffery_antd_components/AntdIcon.py | 8 +- feffery_antd_components/AntdImage.py | 30 +- feffery_antd_components/AntdImageGroup.py | 30 +- feffery_antd_components/AntdInput.py | 24 +- feffery_antd_components/AntdInputNumber.py | 6 +- feffery_antd_components/AntdLayout.py | 8 +- feffery_antd_components/AntdMentions.py | 14 +- feffery_antd_components/AntdMenu.py | 12 +- feffery_antd_components/AntdMessage.py | 8 +- feffery_antd_components/AntdModal.py | 40 +- feffery_antd_components/AntdNotification.py | 20 +- feffery_antd_components/AntdOTP.py | 6 +- feffery_antd_components/AntdPageHeader.py | 8 +- feffery_antd_components/AntdPagination.py | 6 +- feffery_antd_components/AntdParagraph.py | 8 +- feffery_antd_components/AntdPictureUpload.py | 120 ++--- feffery_antd_components/AntdPopconfirm.py | 40 +- feffery_antd_components/AntdPopover.py | 8 +- feffery_antd_components/AntdPopupCard.py | 8 +- feffery_antd_components/AntdProgress.py | 14 +- feffery_antd_components/AntdQRCode.py | 12 +- feffery_antd_components/AntdRadioGroup.py | 14 +- feffery_antd_components/AntdRate.py | 6 +- feffery_antd_components/AntdResult.py | 8 +- feffery_antd_components/AntdRibbon.py | 8 +- feffery_antd_components/AntdRow.py | 22 +- feffery_antd_components/AntdSegmented.py | 18 +- .../AntdSegmentedColoring.py | 8 +- feffery_antd_components/AntdSelect.py | 36 +- feffery_antd_components/AntdSider.py | 8 +- feffery_antd_components/AntdSkeleton.py | 8 +- feffery_antd_components/AntdSkeletonAvatar.py | 8 +- feffery_antd_components/AntdSkeletonButton.py | 8 +- feffery_antd_components/AntdSkeletonImage.py | 8 +- feffery_antd_components/AntdSkeletonInput.py | 8 +- feffery_antd_components/AntdSlider.py | 18 +- feffery_antd_components/AntdSpace.py | 8 +- feffery_antd_components/AntdSpin.py | 8 +- feffery_antd_components/AntdSpoiler.py | 8 +- feffery_antd_components/AntdStatistic.py | 8 +- feffery_antd_components/AntdSteps.py | 26 +- feffery_antd_components/AntdSwitch.py | 6 +- feffery_antd_components/AntdTable.py | 456 ++++++++--------- feffery_antd_components/AntdTabs.py | 60 +-- feffery_antd_components/AntdTag.py | 8 +- feffery_antd_components/AntdText.py | 8 +- feffery_antd_components/AntdTimePicker.py | 6 +- .../AntdTimeRangePicker.py | 6 +- feffery_antd_components/AntdTimeline.py | 14 +- feffery_antd_components/AntdTitle.py | 8 +- feffery_antd_components/AntdTooltip.py | 8 +- feffery_antd_components/AntdTour.py | 50 +- feffery_antd_components/AntdTransfer.py | 12 +- feffery_antd_components/AntdTree.py | 18 +- feffery_antd_components/AntdTreeSelect.py | 6 +- feffery_antd_components/AntdUpload.py | 108 ++-- feffery_antd_components/AntdWatermark.py | 8 +- feffery_antd_components/Fragment.py | 8 +- package.json | 2 +- webpack.config.js | 4 +- 116 files changed, 1468 insertions(+), 1469 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index c3128cae..8b0ccd00 100644 --- 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 index 96042b98..38d9489e 100644 --- a/Project.toml +++ b/Project.toml @@ -2,7 +2,7 @@ name = "FefferyAntdComponents" uuid = "1b08a953-4be3-4667-9a23-674b58f7de79" authors = ["CNFeffery "] -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 index f35f6d12..ce2d2b87 100644 --- 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 index 73c19471..c30e5da4 100644 --- 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 index 0cd3c15a..43e87af2 100644 --- 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 index bf12d808..1ed7d82e 100644 --- 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 index a4a74bb0..8b62b03b 100644 --- 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 index 311f93b0..539e3c5f 100644 --- 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 index 18976a54..1a49453d 100644 --- 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 index 334a8cf3..ce7548e4 100644 --- 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 index fb8ecd6e..add87e60 100644 --- 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 index 0af6dedc..ba93e422 100644 --- 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 index 60ebf189..89688148 100644 --- 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' diff --git a/feffery_antd_components/AntdBreadcrumb.py b/feffery_antd_components/AntdBreadcrumb.py index 0028bfbc..caca7c8b 100644 --- a/feffery_antd_components/AntdBreadcrumb.py +++ b/feffery_antd_components/AntdBreadcrumb.py @@ -26,45 +26,31 @@ class AntdBreadcrumb(Component): `items` is a list of dicts with keys: - - title (string; optional): - 节点标题. - - - key (string; optional): - 节点唯一key值. - - href (string; optional): 节点链接地址. - - target (string; optional): - 节点链接跳转行为. - - icon (string; optional): 节点前缀图标名称，与`iconRenderer`方式相关联，`'AntdIcon'`方式下同AntdIcon的icon参数，`'fontawesome'`方式下代表图标的css类名. - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`. + - key (string; optional): + 节点唯一key值. + - menuItems (list of dicts; optional): 为当前节点设置下拉菜单生成所需的数据结构. `menuItems` is a list of dicts with keys: - - title (string; optional): + - disabled (boolean; optional): - 下拉菜单节点标题. + 是否禁用当前下拉菜单节点. - href (string; optional): 下拉菜单节点链接地址. - - target (string; optional): - - 下拉菜单节点链接跳转方式. - - - disabled (boolean; optional): - - 是否禁用当前下拉菜单节点. - - icon (string; optional): 下拉菜单节点前缀图标名称，与`iconRenderer`方式相关联，`'AntdIcon'`方式下同AntdIcon的icon参数，`'fontawesome'`方式下代表图标的css类名. @@ -73,6 +59,20 @@ class AntdBreadcrumb(Component): 前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`. + - target (string; optional): + + 下拉菜单节点链接跳转方式. + + - title (string; optional): + + 下拉菜单节点标题. + + - target (string; optional): + 节点链接跳转行为. + + - title (string; optional): + 节点标题. + - separator (a list of or a singular dash component, string or number; default '/'): 组件型，分隔符 默认值：`'/'`. @@ -81,12 +81,12 @@ class AntdBreadcrumb(Component): `clickedItem` is a dict with keys: - - itemTitle (string; optional): - 被点击节点标题. - - itemKey (string; optional): 被点击节点key值. + - itemTitle (string; optional): + 被点击节点标题. + - timestamp (number; optional): 点击事件时间戳. @@ -100,14 +100,14 @@ class AntdBreadcrumb(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 = ['separator'] _base_nodes = ['separator', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdButton.py b/feffery_antd_components/AntdButton.py index ff76c7c3..0c56fbbc 100644 --- a/feffery_antd_components/AntdButton.py +++ b/feffery_antd_components/AntdButton.py @@ -111,14 +111,14 @@ class AntdButton(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 = ['loadingChildren', 'icon'] _base_nodes = ['loadingChildren', 'icon', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCalendar.py b/feffery_antd_components/AntdCalendar.py index def33028..41af5eb6 100644 --- a/feffery_antd_components/AntdCalendar.py +++ b/feffery_antd_components/AntdCalendar.py @@ -46,32 +46,32 @@ class AntdCalendar(Component): `customCells` is a list of dicts with keys: - - type (a value equal to: 'month', 'date'; required): - 必填，当前项对应类型，可选项有`'month'`、`'date'`. + - content (a list of or a singular dash component, string or number; optional): + 自定义内容. - - year (number; optional): - 当前项匹配的年份值. + - date (number; optional): + 当前项匹配的日期值. - month (number; optional): 当前项匹配的月份值. - - date (number; optional): - 当前项匹配的日期值. + - type (a value equal to: 'month', 'date'; required): + 必填，当前项对应类型，可选项有`'month'`、`'date'`. - - content (a list of or a singular dash component, string or number; optional): - 自定义内容. + - year (number; optional): + 当前项匹配的年份值. - cellClickEvent (dict; optional): 监听日期单元格点击事件. `cellClickEvent` is a dict with keys: - - type (string; optional): - 记录面板类型. - - timestamp (number; optional): 事件发生时间戳. + - type (string; optional): + 记录面板类型. + - data-* (string; optional): `data-*`格式属性通配. @@ -82,15 +82,15 @@ class AntdCalendar(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCard.py b/feffery_antd_components/AntdCard.py index ffbf2dca..f3d19829 100644 --- a/feffery_antd_components/AntdCard.py +++ b/feffery_antd_components/AntdCard.py @@ -35,21 +35,21 @@ class AntdCard(Component): `extraLink` is a dict with keys: + - className (string; optional): + 链接css类名. + - content (string; optional): 链接文字内容. - href (string; optional): 链接地址. - - target (string; optional): - 链接跳转行为. - - - className (string; optional): - 链接css类名. - - style (dict; optional): 链接css样式. + - target (string; optional): + 链接跳转行为. + - extra (a list of or a singular dash component, string or number; optional): 组件型，卡片右上角额外元素，优先级高于`extraLink`. @@ -58,15 +58,15 @@ class AntdCard(Component): `coverImg` is a dict with keys: - - src (string; optional): - 图片资源地址. - - alt (string; optional): 图片alt信息. - className (string; optional): 图片css类名. + - src (string; optional): + 图片资源地址. + - style (dict; optional): 图片css样式. @@ -98,14 +98,14 @@ class AntdCard(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 = ['actions', 'title', 'extra'] _base_nodes = ['actions', 'title', 'extra', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCardGrid.py b/feffery_antd_components/AntdCardGrid.py index be6a75c0..6b5036bc 100644 --- a/feffery_antd_components/AntdCardGrid.py +++ b/feffery_antd_components/AntdCardGrid.py @@ -40,14 +40,14 @@ class AntdCardGrid(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/AntdCardMeta.py b/feffery_antd_components/AntdCardMeta.py index c61826a0..917cebaa 100644 --- a/feffery_antd_components/AntdCardMeta.py +++ b/feffery_antd_components/AntdCardMeta.py @@ -40,14 +40,14 @@ class AntdCardMeta(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 = ['avatar', 'description', 'title'] _base_nodes = ['avatar', 'description', 'title', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCarousel.py b/feffery_antd_components/AntdCarousel.py index 6f612569..aefe71fb 100644 --- a/feffery_antd_components/AntdCarousel.py +++ b/feffery_antd_components/AntdCarousel.py @@ -70,14 +70,14 @@ class AntdCarousel(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/AntdCascader.py b/feffery_antd_components/AntdCascader.py index eb47f0cd..7f59d822 100644 --- a/feffery_antd_components/AntdCascader.py +++ b/feffery_antd_components/AntdCascader.py @@ -118,15 +118,15 @@ class AntdCascader(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCenter.py b/feffery_antd_components/AntdCenter.py index e56c10ca..9e8af5fb 100644 --- a/feffery_antd_components/AntdCenter.py +++ b/feffery_antd_components/AntdCenter.py @@ -37,14 +37,14 @@ class AntdCenter(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/AntdCheckCard.py b/feffery_antd_components/AntdCheckCard.py index 735b540a..d304a9b5 100644 --- a/feffery_antd_components/AntdCheckCard.py +++ b/feffery_antd_components/AntdCheckCard.py @@ -58,15 +58,15 @@ class AntdCheckCard(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCheckCardGroup.py b/feffery_antd_components/AntdCheckCardGroup.py index 830c2bdb..ec390014 100644 --- a/feffery_antd_components/AntdCheckCardGroup.py +++ b/feffery_antd_components/AntdCheckCardGroup.py @@ -61,15 +61,15 @@ class AntdCheckCardGroup(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCheckableTag.py b/feffery_antd_components/AntdCheckableTag.py index 82ba9f83..737abf62 100644 --- a/feffery_antd_components/AntdCheckableTag.py +++ b/feffery_antd_components/AntdCheckableTag.py @@ -43,14 +43,14 @@ class AntdCheckableTag(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 = ['content', 'checkedContent', 'unCheckedContent'] _base_nodes = ['content', 'checkedContent', 'unCheckedContent', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCheckbox.py b/feffery_antd_components/AntdCheckbox.py index 4b2a60ac..fe002969 100644 --- a/feffery_antd_components/AntdCheckbox.py +++ b/feffery_antd_components/AntdCheckbox.py @@ -58,15 +58,15 @@ class AntdCheckbox(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCheckboxGroup.py b/feffery_antd_components/AntdCheckboxGroup.py index 6774252c..36df8a15 100644 --- a/feffery_antd_components/AntdCheckboxGroup.py +++ b/feffery_antd_components/AntdCheckboxGroup.py @@ -32,14 +32,14 @@ class AntdCheckboxGroup(Component): `options` is a list of string | number | dict with keys: + - disabled (boolean; optional): + 是否禁用当前选择框 默认值：`False`. + - label (a list of or a singular dash component, string or number; optional): 组件型，当前选择框标签内容. - value (string | number; optional): - 当前选择框对应值. - - - disabled (boolean; optional): - 是否禁用当前选择框 默认值：`False`.s + 当前选择框对应值.s - value (list of string | numbers; optional): 监听或设置已选值. @@ -63,15 +63,15 @@ class AntdCheckboxGroup(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdCol.py b/feffery_antd_components/AntdCol.py index fbad9eee..31f3ab3a 100644 --- a/feffery_antd_components/AntdCol.py +++ b/feffery_antd_components/AntdCol.py @@ -47,9 +47,6 @@ class AntdCol(Component): `xs` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -62,14 +59,14 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - sm (dict; optional): 配置列在页面宽度大于等于567px时的布局参数，传入数值型时代表span参数，传入字典时分别设置各布局参数. `sm` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -82,14 +79,14 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - md (dict; optional): 配置列在页面宽度大于等于768px时的布局参数，传入数值型时代表span参数，传入字典时分别设置各布局参数. `md` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -102,14 +99,14 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - lg (dict; optional): 配置列在页面宽度大于等于992px时的布局参数，传入数值型时代表span参数，传入字典时分别设置各布局参数. `lg` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -122,14 +119,14 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - xl (dict; optional): 配置列在页面宽度大于等于1200px时的布局参数，传入数值型时代表span参数，传入字典时分别设置各布局参数. `xl` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -142,14 +139,14 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - xxl (dict; optional): 配置列在页面宽度大于等于1600px时的布局参数，传入数值型时代表span参数，传入字典时分别设置各布局参数. `xxl` is a number | dict with keys: - - span (number; optional): - 同span参数. - - offset (number; optional): 同offset参数. @@ -162,6 +159,9 @@ class AntdCol(Component): - push (number; optional): 同push参数. + - span (number; optional): + 同span参数. + - data-* (string; optional): `data-*`格式属性通配. @@ -172,14 +172,14 @@ class AntdCol(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/AntdCollapse.py b/feffery_antd_components/AntdCollapse.py index db6e8cca..4327c759 100644 --- a/feffery_antd_components/AntdCollapse.py +++ b/feffery_antd_components/AntdCollapse.py @@ -55,15 +55,15 @@ class AntdCollapse(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdColorPicker.py b/feffery_antd_components/AntdColorPicker.py index 4b8f8376..499818fb 100644 --- a/feffery_antd_components/AntdColorPicker.py +++ b/feffery_antd_components/AntdColorPicker.py @@ -66,15 +66,15 @@ class AntdColorPicker(Component): `presets` is a list of dicts with keys: - - label (a list of or a singular dash component, string or number; optional): - 组件型，当前预设项标签内容. - - colors (list of strings; optional): 当前预设项所包含的颜色值数组. - defaultOpen (boolean; optional): 当前预设项默认是否展开 默认值：`True`. + - label (a list of or a singular dash component, string or number; optional): + 组件型，当前预设项标签内容. + - placement (a value equal to: 'top', 'topLeft', 'topRight', 'bottom', 'bottomLeft', 'bottomRight'; default 'bottomLeft'): 颜色选择面板展开方向，可选项有`'top'`、`'topLeft'`、`'topRight'`、`'bottom'`、`'bottomLeft'`、`'bottomRight'` 默认值：`'bottomRight'`. @@ -98,14 +98,14 @@ class AntdColorPicker(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 = ['presets[].label'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdComment.py b/feffery_antd_components/AntdComment.py index 0f6ea0a0..b9576fa6 100644 --- a/feffery_antd_components/AntdComment.py +++ b/feffery_antd_components/AntdComment.py @@ -42,12 +42,12 @@ class AntdComment(Component): `publishTime` is a dict with keys: - - value (string; required): - 必填，日期时间字符串. - - format (string; optional): 与日期时间字符串匹配的格式. + - value (string; required): + 必填，日期时间字符串. + - fromNow (boolean; default False): 是否以相对时间格式呈现发布日期时间. @@ -104,14 +104,14 @@ class AntdComment(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 = ['commentContent'] _base_nodes = ['commentContent', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCompact.py b/feffery_antd_components/AntdCompact.py index 3dfc52e7..01cde8e1 100644 --- a/feffery_antd_components/AntdCompact.py +++ b/feffery_antd_components/AntdCompact.py @@ -40,14 +40,14 @@ class AntdCompact(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/AntdConfigProvider.py b/feffery_antd_components/AntdConfigProvider.py index e6414eea..150c317a 100644 --- a/feffery_antd_components/AntdConfigProvider.py +++ b/feffery_antd_components/AntdConfigProvider.py @@ -67,14 +67,14 @@ class AntdConfigProvider(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/AntdContent.py b/feffery_antd_components/AntdContent.py index 959a8f9c..f1689a9a 100644 --- a/feffery_antd_components/AntdContent.py +++ b/feffery_antd_components/AntdContent.py @@ -34,14 +34,14 @@ class AntdContent(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/AntdCopyText.py b/feffery_antd_components/AntdCopyText.py index 58ec5c49..122a75d8 100644 --- a/feffery_antd_components/AntdCopyText.py +++ b/feffery_antd_components/AntdCopyText.py @@ -44,14 +44,14 @@ class AntdCopyText(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 = ['beforeIcon', 'afterIcon'] _base_nodes = ['beforeIcon', 'afterIcon', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCountdown.py b/feffery_antd_components/AntdCountdown.py index 1fa42d61..5dae09dd 100644 --- a/feffery_antd_components/AntdCountdown.py +++ b/feffery_antd_components/AntdCountdown.py @@ -56,14 +56,14 @@ class AntdCountdown(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 = ['prefix', 'suffix', 'title'] _base_nodes = ['prefix', 'suffix', 'title', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdCustomSkeleton.py b/feffery_antd_components/AntdCustomSkeleton.py index c25cedd1..028e62a4 100644 --- a/feffery_antd_components/AntdCustomSkeleton.py +++ b/feffery_antd_components/AntdCustomSkeleton.py @@ -60,14 +60,14 @@ class AntdCustomSkeleton(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 = ['skeletonContent'] _base_nodes = ['skeletonContent', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdDatePicker.py b/feffery_antd_components/AntdDatePicker.py index be985d0d..6c34e85e 100644 --- a/feffery_antd_components/AntdDatePicker.py +++ b/feffery_antd_components/AntdDatePicker.py @@ -133,12 +133,12 @@ class AntdDatePicker(Component): `clickedPreset` is a dict with keys: - - value (string | number; optional): - 对应预设项值. - - timestamp (number; optional): 事件对应时间戳信息. + - value (string | number; optional): + 对应预设项值. + - needConfirm (boolean; default False): 是否需要点击按钮确认选值，传入`False`时失去焦点即代表选择 默认值：`False`. @@ -147,20 +147,20 @@ class AntdDatePicker(Component): `customCells` is a list of dicts with keys: - - year (number; optional): - 当前项匹配的年份值. - - - month (number; optional): - 当前项匹配的月份值. + - className (string; optional): + 自定义css类名. - date (number; optional): 当前项匹配的日期值. + - month (number; optional): + 当前项匹配的月份值. + - style (dict; optional): 自定义css样式. - - className (string; optional): - 自定义css类名. + - year (number; optional): + 当前项匹配的年份值. - popupContainer (a value equal to: 'parent', 'body'; default 'body'): 相关展开层锚定策略，可选项有`'parent'`、`'body'` 默认值：`'body'`. @@ -183,15 +183,15 @@ class AntdDatePicker(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdDateRangePicker.py b/feffery_antd_components/AntdDateRangePicker.py index 66a911eb..6cce8c3b 100644 --- a/feffery_antd_components/AntdDateRangePicker.py +++ b/feffery_antd_components/AntdDateRangePicker.py @@ -133,12 +133,12 @@ class AntdDateRangePicker(Component): `clickedPreset` is a dict with keys: - - value (string | number; optional): - 对应预设项值. - - timestamp (number; optional): 事件对应时间戳信息. + - value (string | number; optional): + 对应预设项值. + - needConfirm (boolean; default False): 是否需要点击按钮确认选值，传入`False`时失去焦点即代表选择 默认值：`False`. @@ -147,20 +147,20 @@ class AntdDateRangePicker(Component): `customCells` is a list of dicts with keys: - - year (number; optional): - 当前项匹配的年份值. - - - month (number; optional): - 当前项匹配的月份值. + - className (string; optional): + 自定义css类名. - date (number; optional): 当前项匹配的日期值. + - month (number; optional): + 当前项匹配的月份值. + - style (dict; optional): 自定义css样式. - - className (string; optional): - 自定义css类名. + - year (number; optional): + 当前项匹配的年份值. - popupContainer (a value equal to: 'parent', 'body'; default 'body'): 相关展开层锚定策略，可选项有`'parent'`、`'body'` 默认值：`'body'`. @@ -183,15 +183,15 @@ class AntdDateRangePicker(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdDescriptionItem.py b/feffery_antd_components/AntdDescriptionItem.py index 025dacd3..a6a9a7e1 100644 --- a/feffery_antd_components/AntdDescriptionItem.py +++ b/feffery_antd_components/AntdDescriptionItem.py @@ -46,14 +46,14 @@ class AntdDescriptionItem(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 = ['label'] _base_nodes = ['label', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdDescriptions.py b/feffery_antd_components/AntdDescriptions.py index 828fd236..1185bc6c 100644 --- a/feffery_antd_components/AntdDescriptions.py +++ b/feffery_antd_components/AntdDescriptions.py @@ -29,27 +29,27 @@ class AntdDescriptions(Component): `items` is a list of dicts with keys: - - label (a list of or a singular dash component, string or number; optional): - 组件型，子项标题内容. - - - span (number; optional): - 子项所占宽度份数 默认值：`1`. - - children (a list of or a singular dash component, string or number; optional): 组件型，子项内容. - - labelStyle (dict; optional): - 子项标签css样式. + - className (string; optional): + 子项css类名. - contentStyle (dict; optional): 子项内容css样式. + - label (a list of or a singular dash component, string or number; optional): + 组件型，子项标题内容. + + - labelStyle (dict; optional): + 子项标签css样式. + + - span (number; optional): + 子项所占宽度份数 默认值：`1`. + - style (dict; optional): 子项css样式. - - className (string; optional): - 子项css类名. - - title (a list of or a singular dash component, string or number; optional): 组件型，标题内容. @@ -58,18 +58,18 @@ class AntdDescriptions(Component): `column` is a number | dict with keys: - - xxl (number; optional) - - - xl (number; optional) - - lg (number; optional) - md (number; optional) - sm (number; optional) + - xl (number; optional) + - xs (number; optional) + - xxl (number; optional) + - bordered (boolean; default False): 是否显示边框 默认值：`False`. @@ -98,14 +98,14 @@ class AntdDescriptions(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[].label', 'items[].children', 'title', 'extra'] _base_nodes = ['title', 'extra', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdDivider.py b/feffery_antd_components/AntdDivider.py index d4fb30ed..12f2cbf1 100644 --- a/feffery_antd_components/AntdDivider.py +++ b/feffery_antd_components/AntdDivider.py @@ -65,14 +65,14 @@ class AntdDivider(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/AntdDraggablePanel.py b/feffery_antd_components/AntdDraggablePanel.py index 3f6bee41..a6fdfc11 100644 --- a/feffery_antd_components/AntdDraggablePanel.py +++ b/feffery_antd_components/AntdDraggablePanel.py @@ -32,12 +32,12 @@ class AntdDraggablePanel(Component): `defaultSize` is a dict with keys: - - width (number | string; optional): - 设置像素宽度数值，或css宽度字符串. - - height (number | string; optional): 设置像素高度数值，或css高度字符串. + - width (number | string; optional): + 设置像素宽度数值，或css宽度字符串. + - defaultPosition (dict; optional): 设置当前面板默认位置. @@ -99,14 +99,14 @@ class AntdDraggablePanel(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/AntdDraggerUpload.py b/feffery_antd_components/AntdDraggerUpload.py index 97a4b004..965689a8 100644 --- a/feffery_antd_components/AntdDraggerUpload.py +++ b/feffery_antd_components/AntdDraggerUpload.py @@ -103,6 +103,17 @@ class AntdDraggerUpload(Component): `progressProps` is a dict with keys: + - format (dict; optional): + 进度文字格式. + + `format` is a dict with keys: + + - prefix (string; optional): + 进度文字前缀内容. + + - suffix (string; optional): + 进度文字后缀内容 默认值：`'%'`. + - strokeColor (dict; optional): 进度条颜色. @@ -121,17 +132,6 @@ class AntdDraggerUpload(Component): - strokeWidth (number; optional): 进度条像素宽度. - - format (dict; optional): - 进度文字格式. - - `format` is a dict with keys: - - - prefix (string; optional): - 进度文字前缀内容. - - - suffix (string; optional): - 进度文字后缀内容 默认值：`'%'`. - - showSuccessMessage (boolean; default True): 是否在每个文件上传成功后，分别弹出消息提示 默认值：`True`. @@ -143,26 +143,29 @@ class AntdDraggerUpload(Component): `lastUploadTaskRecord` is a dict with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): - 当前文件的下载链接. + 当前文件的下载链接. | list of dicts with keys: - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. | list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. - fileName (string; optional): 文件名称. @@ -170,76 +173,73 @@ class AntdDraggerUpload(Component): - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): 当前文件的下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. - - listUploadTaskRecord (list of dicts; optional): 监听当前已上传文件列表中上传任务相关信息. `listUploadTaskRecord` is a list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. - - - taskStatus (string; optional): - 上传任务状态，`'success'`表示成功，`'failed'`表示失败. + - originFileObj (boolean | number | string | dict | list; optional): + 当`withOriginFileObj=True`时，监听当前文件上传任务对应的`originFileObj`主要信息. - taskId (string; optional): 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - taskStatus (string; optional): + 上传任务状态，`'success'`表示成功，`'failed'`表示失败. + - uid (string; optional): 当前文件上传唯一识别id，前端自动生成. - - url (string; optional): - 当前文件下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): 上传任务的接口响应信息. - - originFileObj (boolean | number | string | dict | list; optional): - 当`withOriginFileObj=True`时，监听当前文件上传任务对应的`originFileObj`主要信息. + - url (string; optional): + 当前文件下载链接. - defaultFileList (list of dicts; optional): 初始化文件列表展示信息. `defaultFileList` is a list of dicts with keys: + - fileSize (number; optional): + 当前文件大小. + - name (string; optional): 当前文件名称. - status (a value equal to: 'done', 'error', 'removed'; optional): 当前文件展示状态，可选项有`'done'`、`'error'`、`'removed'`. + - taskId (string; optional): + 若传入有效值，将作为当前组件的`uploadId`参数. + - uid (boolean | number | string | dict | list; optional): 当前文件唯一识别id. - url (string; optional): 当前文件下载链接. - - taskId (string; optional): - 若传入有效值，将作为当前组件的`uploadId`参数. - - - fileSize (number; optional): - 当前文件大小. - - disabled (boolean; default False): 是否禁用当前组件 默认值：`False`. @@ -256,14 +256,14 @@ class AntdDraggerUpload(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 = ['icon', 'text', 'hint'] _base_nodes = ['icon', 'text', 'hint', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdDrawer.py b/feffery_antd_components/AntdDrawer.py index 7459c97b..41ef3868 100644 --- a/feffery_antd_components/AntdDrawer.py +++ b/feffery_antd_components/AntdDrawer.py @@ -29,41 +29,41 @@ class AntdDrawer(Component): `classNames` is a dict with keys: - - header (string; optional): - 头部元素css类名. - - body (string; optional): 内容元素css类名. + - content (string; optional): + 抽屉容器元素css类名. + - footer (string; optional): 底部元素css类名. + - header (string; optional): + 头部元素css类名. + - mask (string; optional): 遮罩层元素css类名. - - content (string; optional): - 抽屉容器元素css类名. - - styles (dict; optional): 配置各子元素的css样式. `styles` is a dict with keys: - - header (dict; optional): - 头部元素css样式. - - body (dict; optional): 内容元素css样式. + - content (dict; optional): + 抽屉容器元素css样式. + - footer (dict; optional): 底部元素css样式. + - header (dict; optional): + 头部元素css样式. + - mask (dict; optional): 遮罩层元素css样式. - - content (dict; optional): - 抽屉容器元素css样式. - - rootStyle (dict; optional): 抽屉根节点css样式（包含遮罩层），特殊的，当设置了`containerId`或`containerSelector`时，该参数会自动设置`position`为`absolute`. @@ -125,14 +125,14 @@ class AntdDrawer(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 = ['title', 'extra', 'footer'] _base_nodes = ['title', 'extra', 'footer', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdDropdown.py b/feffery_antd_components/AntdDropdown.py index ffb14d94..602d41eb 100644 --- a/feffery_antd_components/AntdDropdown.py +++ b/feffery_antd_components/AntdDropdown.py @@ -41,21 +41,21 @@ class AntdDropdown(Component): `buttonProps` is a dict with keys: - - 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'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否呈现危险样式 默认值：`False`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'default', 'primary', 'ghost', 'dashed', 'link', 'text'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - freePosition (boolean; default False): 是否开启自由位置模式 默认值：`False`. @@ -77,29 +77,29 @@ class AntdDropdown(Component): `menuItems` is a list of dicts with keys: - - title (a list of or a singular dash component, string or number; optional): - 组件型，节点标题. + - disabled (boolean; optional): + 是否禁用节点 默认值：`False`. - href (string; optional): 节点链接地址. - - target (string; optional): - 节点链接跳转行为. - - - disabled (boolean; optional): - 是否禁用节点 默认值：`False`. - - icon (string; optional): 节点前缀图标名称，与`iconRenderer`方式相关联，`'AntdIcon'`方式下同AntdIcon的icon参数，`'fontawesome'`方式下代表图标的css类名. - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`. + - isDivider (boolean; optional): + 节点是否渲染为分割线. + - key (string; optional): 节点唯一key值. - - isDivider (boolean; optional): - 节点是否渲染为分割线. + - target (string; optional): + 节点链接跳转行为. + + - title (a list of or a singular dash component, string or number; optional): + 组件型，节点标题. - selectable (boolean; default False): 菜单项是否可选择 默认值：`False`. @@ -156,14 +156,14 @@ class AntdDropdown(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 = ['menuItems[].title'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdEditorLayout.py b/feffery_antd_components/AntdEditorLayout.py index a1cfc41d..6bfdb1a0 100644 --- a/feffery_antd_components/AntdEditorLayout.py +++ b/feffery_antd_components/AntdEditorLayout.py @@ -26,8 +26,11 @@ class AntdEditorLayout(Component): `header` is a dict with keys: - - title (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; optional): + 页首css类名. - extra (a list of or a singular dash component, string or number; optional): 页首额外操作区元素. @@ -35,22 +38,22 @@ class AntdEditorLayout(Component): - style (dict; optional): 页首css样式. - - className (string; optional): - 页首css类名. - - - children (a list of or a singular dash component, string or number; optional): - 页首主要区域子元素. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): - 页首主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean + 页首主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. + + - title (a list of or a singular dash component, string or number; optional): + 页首标题元素. | boolean - footer (dict; optional): 配置页脚布局内容，设置为`False`时不显示. `footer` is a dict with keys: - - title (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; optional): + 页脚css类名. - extra (a list of or a singular dash component, string or number; optional): 页脚额外操作区元素. @@ -58,14 +61,11 @@ class AntdEditorLayout(Component): - style (dict; optional): 页脚css样式. - - className (string; optional): - 页脚css类名. - - - children (a list of or a singular dash component, string or number; optional): - 页脚主要区域子元素. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): - 页脚主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean + 页脚主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. + + - title (a list of or a singular dash component, string or number; optional): + 页脚标题元素. | boolean - leftPannel (dict; optional): 配置左侧面板布局内容，设置为`False`时不显示. @@ -75,27 +75,27 @@ class AntdEditorLayout(Component): - children (a list of or a singular dash component, string or number; optional): 面板子元素内容. + - className (string; optional): + 面板css类名. + - direction (a value equal to: 'horizontal', 'vertical'; optional): 面板方向，可选的有`'horizontal'`、`'vertical'`. - - minWidth (number; optional): - 面板最小像素宽度. - - - minHeight (number; optional): - 面板最小像素高度. + - maxHeight (number; optional): + 面板最大像素高度. - maxWidth (number; optional): 面板最大像素宽度. - - maxHeight (number; optional): - 面板最大像素高度. + - minHeight (number; optional): + 面板最小像素高度. + + - minWidth (number; optional): + 面板最小像素宽度. - style (dict; optional): 面板css样式. - - className (string; optional): - 面板css类名. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): 面板主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean @@ -107,27 +107,27 @@ class AntdEditorLayout(Component): - children (a list of or a singular dash component, string or number; optional): 面板子元素内容. + - className (string; optional): + 面板css类名. + - direction (a value equal to: 'horizontal', 'vertical'; optional): 面板方向，可选的有`'horizontal'`、`'vertical'`. - - minWidth (number; optional): - 面板最小像素宽度. - - - minHeight (number; optional): - 面板最小像素高度. + - maxHeight (number; optional): + 面板最大像素高度. - maxWidth (number; optional): 面板最大像素宽度. - - maxHeight (number; optional): - 面板最大像素高度. + - minHeight (number; optional): + 面板最小像素高度. + + - minWidth (number; optional): + 面板最小像素宽度. - style (dict; optional): 面板css样式. - - className (string; optional): - 面板css类名. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): 面板主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean @@ -139,27 +139,27 @@ class AntdEditorLayout(Component): - children (a list of or a singular dash component, string or number; optional): 面板子元素内容. + - className (string; optional): + 面板css类名. + - direction (a value equal to: 'horizontal', 'vertical'; optional): 面板方向，可选的有`'horizontal'`、`'vertical'`. - - minWidth (number; optional): - 面板最小像素宽度. - - - minHeight (number; optional): - 面板最小像素高度. + - maxHeight (number; optional): + 面板最大像素高度. - maxWidth (number; optional): 面板最大像素宽度. - - maxHeight (number; optional): - 面板最大像素高度. + - minHeight (number; optional): + 面板最小像素高度. + + - minWidth (number; optional): + 面板最小像素宽度. - style (dict; optional): 面板css样式. - - className (string; optional): - 面板css类名. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): 面板主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean @@ -171,27 +171,27 @@ class AntdEditorLayout(Component): - children (a list of or a singular dash component, string or number; optional): 面板子元素内容. + - className (string; optional): + 面板css类名. + - direction (a value equal to: 'horizontal', 'vertical'; optional): 面板方向，可选的有`'horizontal'`、`'vertical'`. - - minWidth (number; optional): - 面板最小像素宽度. - - - minHeight (number; optional): - 面板最小像素高度. + - maxHeight (number; optional): + 面板最大像素高度. - maxWidth (number; optional): 面板最大像素宽度. - - maxHeight (number; optional): - 面板最大像素高度. + - minHeight (number; optional): + 面板最小像素高度. + + - minWidth (number; optional): + 面板最小像素宽度. - style (dict; optional): 面板css样式. - - className (string; optional): - 面板css类名. - - themeType (a value equal to: 'ghost', 'block', 'pure'; optional): 面板主题类型，可选的有`'ghost'`、`'block'`、`'pure'`. | boolean @@ -211,14 +211,14 @@ class AntdEditorLayout(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 = ['header.title', 'header.extra', 'header.children', 'footer.title', 'footer.extra', 'footer.children', 'leftPannel.children', 'rightPannel.children', 'bottomPannel.children', 'centerPannel.children'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdEmpty.py b/feffery_antd_components/AntdEmpty.py index 7553b0f0..7dc352a5 100644 --- a/feffery_antd_components/AntdEmpty.py +++ b/feffery_antd_components/AntdEmpty.py @@ -47,14 +47,14 @@ class AntdEmpty(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 = ['description'] _base_nodes = ['description', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdFlex.py b/feffery_antd_components/AntdFlex.py index e7b0cc46..20d88695 100644 --- a/feffery_antd_components/AntdFlex.py +++ b/feffery_antd_components/AntdFlex.py @@ -52,14 +52,14 @@ class AntdFlex(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/AntdFloatButton.py b/feffery_antd_components/AntdFloatButton.py index 52d60b14..d2901207 100644 --- a/feffery_antd_components/AntdFloatButton.py +++ b/feffery_antd_components/AntdFloatButton.py @@ -55,14 +55,14 @@ class AntdFloatButton(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 = ['icon', 'description', 'tooltip'] _base_nodes = ['icon', 'description', 'tooltip', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdFloatButtonGroup.py b/feffery_antd_components/AntdFloatButtonGroup.py index f0c8428d..9d605f8a 100644 --- a/feffery_antd_components/AntdFloatButtonGroup.py +++ b/feffery_antd_components/AntdFloatButtonGroup.py @@ -49,14 +49,14 @@ class AntdFloatButtonGroup(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 = ['icon', 'description', 'tooltip'] _base_nodes = ['icon', 'description', 'tooltip', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdFooter.py b/feffery_antd_components/AntdFooter.py index 9319a767..adf680e4 100644 --- a/feffery_antd_components/AntdFooter.py +++ b/feffery_antd_components/AntdFooter.py @@ -34,14 +34,14 @@ class AntdFooter(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/AntdForm.py b/feffery_antd_components/AntdForm.py index c0181108..4cd5afa5 100644 --- a/feffery_antd_components/AntdForm.py +++ b/feffery_antd_components/AntdForm.py @@ -33,28 +33,28 @@ class AntdForm(Component): `labelCol` is a dict with keys: - - span (number; optional): - 标签部分所占宽度份数（总份数24）. + - flex (string | number; optional): + 同css中的flex属性，用于更灵活的控制标签部分所占宽度. - offset (number; optional): 标签部分向右偏移宽度份数. - - flex (string | number; optional): - 同css中的flex属性，用于更灵活的控制标签部分所占宽度. + - span (number; optional): + 标签部分所占宽度份数（总份数24）. - wrapperCol (dict; optional): 配置表单项控件部分相关参数. `wrapperCol` is a dict with keys: - - span (number; optional): - 控件部分所占宽度份数（总份数24）. + - flex (string | number; optional): + 同css中的flex属性，用于更灵活的控制控件部分所占宽度. - offset (number; optional): 控件部分向右偏移宽度份数. - - flex (string | number; optional): - 同css中的flex属性，用于更灵活的控制控件部分所占宽度. + - span (number; optional): + 控件部分所占宽度份数（总份数24）. - colon (boolean; default True): 当`layput='horizontal'`时，控制是否在表单项标签部分末尾添加冒号. @@ -87,14 +87,14 @@ class AntdForm(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 = ['helps{}'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdFormItem.py b/feffery_antd_components/AntdFormItem.py index ddda4ab0..71b46689 100644 --- a/feffery_antd_components/AntdFormItem.py +++ b/feffery_antd_components/AntdFormItem.py @@ -32,28 +32,28 @@ class AntdFormItem(Component): `labelCol` is a dict with keys: - - span (number; optional): - 标签部分所占宽度份数（总份数24）. + - flex (string | number; optional): + 同css中的flex属性，用于更灵活的控制标签部分所占宽度. - offset (number; optional): 标签部分向右偏移宽度份数. - - flex (string | number; optional): - 同css中的flex属性，用于更灵活的控制标签部分所占宽度. + - span (number; optional): + 标签部分所占宽度份数（总份数24）. - wrapperCol (dict; optional): 配置表单项控件部分相关参数，优先级高于所属`AntdForm`中的`labelCol`参数. `wrapperCol` is a dict with keys: - - span (number; optional): - 控件部分所占宽度份数（总份数24）. + - flex (string | number; optional): + 同css中的flex属性，用于更灵活的控制控件部分所占宽度. - offset (number; optional): 控件部分向右偏移宽度份数. - - flex (string | number; optional): - 同css中的flex属性，用于更灵活的控制控件部分所占宽度. + - span (number; optional): + 控件部分所占宽度份数（总份数24）. - colon (boolean; optional): 当`layput='horizontal'`时，控制是否在表单项标签部分末尾添加冒号，优先级高于所属`AntdForm`中的`colon`参数. @@ -96,14 +96,14 @@ class AntdFormItem(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 = ['label', 'tooltip', 'extra', 'help'] _base_nodes = ['label', 'tooltip', 'extra', 'help', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdFormRender.py b/feffery_antd_components/AntdFormRender.py index 6a80f524..63baba98 100644 --- a/feffery_antd_components/AntdFormRender.py +++ b/feffery_antd_components/AntdFormRender.py @@ -26,14 +26,17 @@ class AntdFormRender(Component): `schema` is a dict with keys: - - type (a value equal to: 'object'; optional): - 固定配置为type: 'object'. + - column (number; optional): + 设置表单布局，一行应该有几列，默认为3. - displayType (a value equal to: 'column', 'row', 'inline'; optional): 设置表单表单项label布局方式，可选的有'column'、'row'与'inline'，默认为'column'. - - column (number; optional): - 设置表单布局，一行应该有几列，默认为3. + - fieldCol (number; optional): + 设置表单控件占位格数. + + - labelCol (number; optional): + 设置表单标签占位格数. - labelWidth (number; optional): 设置表单项标签的宽度. @@ -41,161 +44,97 @@ class AntdFormRender(Component): - maxWidth (number; optional): 设置表单项控件的最大宽度. - - labelCol (number; optional): - 设置表单标签占位格数. - - - fieldCol (number; optional): - 设置表单控件占位格数. - - properties (dict; optional): 设置表单控件. `properties` is a dict with strings as keys and values of type dict with keys: - - type (a value equal to: 'string', 'number', 'boolean', 'array', 'range', 'html', 'block'; optional): - - 设置表单字段的类型，可选的有'string'、'number'、'boolean'、'array'、'range'、'html'、'block'. - - - title (string; optional): - - 设置表单字段的标签. - - - labelWidth (number + - cellSpan (number Or string; optional): - 设置表单项标签的宽度. - - - maxWidth (number - - Or string; optional): - - 设置表单项控件的最大宽度. - - - labelCol (number | string; optional): - - 设置表单标签占位格数. - - - fieldCol (number | string; optional): - - 设置表单控件占位格数. - - - cellSpan (number | string; optional): - 设置表单项跨列展示，目前需配合lableWidth来使用，否则无法与其他表单项在样式上对齐，通过配置单个表单项的labelCol、fieldCol勉强能改善. - - span (number | string; optional): - - 设置表单项列宽度，表单布局会被切割成 24 等份，可以通过设置 span 来自定义表单项所占的宽度. - - - widget (a value equal to: 'input', 'inputNumber', 'select', 'multiSelect', 'radio', 'checkboxes', 'textArea', 'checkbox', 'switch', 'rate', 'slider', 'datePicker', 'dateRange', 'timePicker', 'timeRange', 'cascader', 'treeSelect', 'color', 'imageInput', 'urlInput', 'html'; optional): + - className (string; optional): - 设置指定渲染的控件名称. + 设置自定义控件class名称. - - placeholder (string | list of strings; optional): + - dependencies (list of strings; optional): - 设置输入内容提示. + 设置表单依赖元素，当依赖的元素更新时，会触发本元素的重新渲染，用于复杂的表单联动. - description (string; optional): 设置副标题描述. - - tooltip (dict; optional): - - 设置气泡提示，支持html格式，可传入一个antd的tooltip配置对象支持更多配置. - - `tooltip` is a string | dict with keys: - - - title (boolean | number | string | dict | list; optional): - - 设置显示的文字内容. - - - placement (a value equal to: 'top', 'left', 'right', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional): - - 设置气泡框的位置，可选的有'top'、'left'、'right'、'bottom'、'topLeft' - - 、'topRight'、'bottomLeft'、'bottomRight'、'leftTop'、'leftBottom' - - 、'rightTop'、'rightBottom'，默认为'top'. - - - color (string; optional): - - 设置背景颜色. + - disabled (boolean - - mouseEnterDelay (number; optional): - - 设置鼠标移入后延时多少才显示 Tooltip，单位：秒，默认为0.1. + Or string; optional): - - mouseLeaveDelay (number; optional): + 设置是否禁用，默认为False. - 设置鼠标移出后延时多少才隐藏 Tooltip，单位：秒，默认为0.1. + - extra (string; optional): - - overlayClassName (string | dict; optional): + 设置更多的说明信息，支持html格式，会紧贴在元素下面一行展示. - 设置卡片css类. + - fieldCol (number | string; optional): - - overlayStyle (dict; optional): + 设置表单控件占位格数. - 设置卡片样式. + - format (a value equal to: 'image', 'textarea', 'color', 'email', 'url', 'dateTime', 'date', 'time', 'upload'; optional): - - overlayInnerStyle (dict; optional): + 在已设置的type下，如何处理这个type. - 设置卡片内容区域的样式. + - hidden (boolean | string; optional): - - trigger (a value equal to: 'hover', 'focus', 'click' | list of a value equal to: 'hover', 'focus', 'click's; optional): + 设置是否隐藏，默认为False. - 设置触发行为，可选的有'hover'、'focus'、'click'，或是以上多个组成的数组，默认为'hover'. + - labelCol (number | string; optional): - - zIndex (number; optional): + 设置表单标签占位格数. - 设置悬浮层zIndex. + - labelWidth (number | string; optional): - - arrow (a value equal to: 'show', 'hide', 'center'; optional): + 设置表单项标签的宽度. - 设置修改箭头的显示状态以及修改箭头是否指向目标元素中心，默认为'show'. + - max (number | string; optional): - - fresh (boolean; optional): + 设置string类型为字符串最大长度；number类型时为最大值；array 类型时为数组最大长度. - 用于设置是否始终保持更新内容，默认为False。默认情况下，Tooltip + - maxWidth (number | string; optional): - 在关闭时会缓存内容，设置该属性后会始终保持更新。. + 设置表单项控件的最大宽度. - - open (boolean; optional): + - min (number | string; optional): - 用于监听或控制当前tooltip的显隐，默认为False. + 设置string类型为字符串最小长度；number类型时为最小值；array 类型时为数组最小长度. - - autoAdjustOverflow (boolean; optional): + - placeholder (string | list of strings; optional): - 用于设置气泡被遮挡时自动调整位置,默认为True. + 设置输入内容提示. - - defaultOpen (boolean; optional): + - props (dict; optional): - 设置默认是否显隐，默认为False. + 设置额外属性，如果使用的是antd组件，对应的就是antd组件的其他属性. - - destroyTooltipOnHide (boolean; optional): + - readOnly (boolean | string; optional): - 设置关闭后是否销毁Tooltip，默认为False. + 设置是否为可读模式，默认为False. - - extra (string; optional): + - readOnlyWidget (string; optional): - 设置更多的说明信息，支持html格式，会紧贴在元素下面一行展示. + 指定只读渲染组件名称. - required (boolean | string; optional): 设置是否必填，默认为False. - - min (number | string; optional): - - 设置string类型为字符串最小长度；number类型时为最小值；array 类型时为数组最小长度. - - - max (number | string; optional): - - 设置string类型为字符串最大长度；number类型时为最大值；array 类型时为数组最大长度. + - reserveLabel (boolean | string; optional): - - format (a value equal to: 'image', 'textarea', 'color', 'email', 'url', 'dateTime', 'date', 'time', 'upload'; optional): + 当title未设置时，通过配置reserveLabel: - 在已设置的type下，如何处理这个type. + True可以保留labelWidth占位，使得输入控件和其他控件上下对齐. - rules (list of dicts; optional): @@ -259,73 +198,69 @@ class AntdFormRender(Component): 如果字段仅包含空格则校验不通过，只在 type: 'string' 时生效. - - hidden (boolean | string; optional): - - 设置是否隐藏，默认为False. - - - disabled (boolean | string; optional): + - span (number | string; optional): - 设置是否禁用，默认为False. + 设置表单项列宽度，表单布局会被切割成 24 等份，可以通过设置 span 来自定义表单项所占的宽度. - - readOnly (boolean | string; optional): + - title (string; optional): - 设置是否为可读模式，默认为False. + 设置表单字段的标签. - - readOnlyWidget (string; optional): + - tooltip (dict; optional): - 指定只读渲染组件名称. + 设置气泡提示，支持html格式，可传入一个antd的tooltip配置对象支持更多配置. - - dependencies (list of strings; optional): + `tooltip` is a string | dict with keys: - 设置表单依赖元素，当依赖的元素更新时，会触发本元素的重新渲染，用于复杂的表单联动. + - arrow (a value equal to: 'show', 'hide', 'center'; optional): - - className (string; optional): + 设置修改箭头的显示状态以及修改箭头是否指向目标元素中心，默认为'show'. - 设置自定义控件class名称. + - autoAdjustOverflow (boolean; optional): - - reserveLabel (boolean | string; optional): + 用于设置气泡被遮挡时自动调整位置,默认为True. - 当title未设置时，通过配置reserveLabel: + - color (string; optional): - True可以保留labelWidth占位，使得输入控件和其他控件上下对齐. + 设置背景颜色. - - props (dict; optional): + - defaultOpen (boolean; optional): - 设置额外属性，如果使用的是antd组件，对应的就是antd组件的其他属性. | dict with keys: + 设置默认是否显隐，默认为False. - - type (a value equal to: 'object'; optional): + - destroyTooltipOnHide (boolean; optional): - 固定配置为type: 'object'. + 设置关闭后是否销毁Tooltip，默认为False. - - title (string; optional): + - fresh (boolean; optional): - 设置标题. + 用于设置是否始终保持更新内容，默认为False。默认情况下，Tooltip - - widget (a value equal to: 'collapse', 'card', 'lineTitle', 'subInline'; optional): + 在关闭时会缓存内容，设置该属性后会始终保持更新。. - 设置希望使用的嵌套组件名称，可选的有'collapse'、'card'、'lineTitle'、'subInline'，默认为'card'. + - mouseEnterDelay (number; optional): - - properties (dict; optional): + 设置鼠标移入后延时多少才显示 Tooltip，单位：秒，默认为0.1. - 设置表单元素集合. + - mouseLeaveDelay (number; optional): - - column (number | string; optional): + 设置鼠标移出后延时多少才隐藏 Tooltip，单位：秒，默认为0.1. - 设置表单布局，一行应该有几列，默认为3. + - open (boolean; optional): - - description (string; optional): + 用于监听或控制当前tooltip的显隐，默认为False. - 设置副标题描述. + - overlayClassName (string | dict; optional): - - tooltip (dict; optional): + 设置卡片css类. - 设置气泡提示，支持html格式，可传入一个antd的tooltip配置对象支持更多配置. + - overlayInnerStyle (dict; optional): - `tooltip` is a string | dict with keys: + 设置卡片内容区域的样式. - - title (boolean | number | string | dict | list; optional): + - overlayStyle (dict; optional): - 设置显示的文字内容. + 设置卡片样式. - placement (a value equal to: 'top', 'left', 'right', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional): @@ -335,79 +270,133 @@ class AntdFormRender(Component): 、'rightTop'、'rightBottom'，默认为'top'. - - color (string; optional): + - title (boolean | number | string | dict | list; optional): - 设置背景颜色. + 设置显示的文字内容. - - mouseEnterDelay (number; optional): + - trigger (a value equal to: 'hover', 'focus', 'click' | list of a value equal to: 'hover', 'focus', 'click's; optional): - 设置鼠标移入后延时多少才显示 Tooltip，单位：秒，默认为0.1. + 设置触发行为，可选的有'hover'、'focus'、'click'，或是以上多个组成的数组，默认为'hover'. - - mouseLeaveDelay (number; optional): + - zIndex (number; optional): - 设置鼠标移出后延时多少才隐藏 Tooltip，单位：秒，默认为0.1. + 设置悬浮层zIndex. - - overlayClassName (string | dict; optional): + - type (a value equal to: 'string', 'number', 'boolean', 'array', 'range', 'html', 'block'; optional): - 设置卡片css类. + 设置表单字段的类型，可选的有'string'、'number'、'boolean'、'array'、'range'、'html'、'block'. - - overlayStyle (dict; optional): + - widget (a value equal to: 'input', 'inputNumber', 'select', 'multiSelect', 'radio', 'checkboxes', 'textArea', 'checkbox', 'switch', 'rate', 'slider', 'datePicker', 'dateRange', 'timePicker', 'timeRange', 'cascader', 'treeSelect', 'color', 'imageInput', 'urlInput', 'html'; optional): - 设置卡片样式. + 设置指定渲染的控件名称. | dict with keys: - - overlayInnerStyle (dict; optional): + - column (number | string; optional): - 设置卡片内容区域的样式. + 设置表单布局，一行应该有几列，默认为3. - - trigger (a value equal to: 'hover', 'focus', 'click' | list of a value equal to: 'hover', 'focus', 'click's; optional): + - description (string; optional): - 设置触发行为，可选的有'hover'、'focus'、'click'，或是以上多个组成的数组，默认为'hover'. + 设置副标题描述. - - zIndex (number; optional): + - properties (dict; optional): - 设置悬浮层zIndex. + 设置表单元素集合. + + - props (dict; optional): + + 设置额外属性，透传到对应的嵌套组件中. + + - title (string; optional): + + 设置标题. + + - tooltip (dict; optional): + + 设置气泡提示，支持html格式，可传入一个antd的tooltip配置对象支持更多配置. + + `tooltip` is a string | dict with keys: - arrow (a value equal to: 'show', 'hide', 'center'; optional): 设置修改箭头的显示状态以及修改箭头是否指向目标元素中心，默认为'show'. + - autoAdjustOverflow (boolean; optional): + + 用于设置气泡被遮挡时自动调整位置,默认为True. + + - color (string; optional): + + 设置背景颜色. + + - defaultOpen (boolean; optional): + + 设置默认是否显隐，默认为False. + + - destroyTooltipOnHide (boolean; optional): + + 设置关闭后是否销毁Tooltip，默认为False. + - fresh (boolean; optional): 用于设置是否始终保持更新内容，默认为False。默认情况下，Tooltip 在关闭时会缓存内容，设置该属性后会始终保持更新。. + - mouseEnterDelay (number; optional): + + 设置鼠标移入后延时多少才显示 Tooltip，单位：秒，默认为0.1. + + - mouseLeaveDelay (number; optional): + + 设置鼠标移出后延时多少才隐藏 Tooltip，单位：秒，默认为0.1. + - open (boolean; optional): 用于监听或控制当前tooltip的显隐，默认为False. - - autoAdjustOverflow (boolean; optional): + - overlayClassName (string | dict; optional): - 用于设置气泡被遮挡时自动调整位置,默认为True. + 设置卡片css类. - - defaultOpen (boolean; optional): + - overlayInnerStyle (dict; optional): - 设置默认是否显隐，默认为False. + 设置卡片内容区域的样式. - - destroyTooltipOnHide (boolean; optional): + - overlayStyle (dict; optional): - 设置关闭后是否销毁Tooltip，默认为False. + 设置卡片样式. - - props (dict; optional): + - placement (a value equal to: 'top', 'left', 'right', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional): - 设置额外属性，透传到对应的嵌套组件中. | dict with keys: + 设置气泡框的位置，可选的有'top'、'left'、'right'、'bottom'、'topLeft' - - type (a value equal to: 'array'; optional): + 、'topRight'、'bottomLeft'、'bottomRight'、'leftTop'、'leftBottom' - 固定配置为type: 'array'. + 、'rightTop'、'rightBottom'，默认为'top'. - - title (string; optional): + - title (boolean | number | string | dict | list; optional): - 设置标题. + 设置显示的文字内容. - - widget (a value equal to: 'cardList', 'simpleList', 'tableList', 'drawerList', 'virtualList'; optional): + - trigger (a value equal to: 'hover', 'focus', 'click' | list of a value equal to: 'hover', 'focus', 'click's; optional): - 设置希望使用的列表组件名称，可选的有'cardList'、'simpleList'、'tableList'、'drawerList'、'virtualList'，默认为'cardList'. + 设置触发行为，可选的有'hover'、'focus'、'click'，或是以上多个组成的数组，默认为'hover'. + + - zIndex (number; optional): + + 设置悬浮层zIndex. + + - type (a value equal to: 'object'; optional): + + 固定配置为type: 'object'. + + - widget (a value equal to: 'collapse', 'card', 'lineTitle', 'subInline'; optional): + + 设置希望使用的嵌套组件名称，可选的有'collapse'、'card'、'lineTitle'、'subInline'，默认为'card'. | dict with keys: + + - items (dict; optional): + + 动态项配置，可以是一个嵌套控件. - max (number | string; optional): @@ -423,6 +412,12 @@ class AntdFormRender(Component): `props` is a dict with keys: + - actionColumnProps (dict; optional): + + 设置tableList | drawerList | virtualList 中操作列的属性，参考 Antd + + Table ColumnType。 其中 title 使用 colHeaderText 代替。. + - addBtnProps (dict; optional): 设置添加按钮属性，参考 Antd Button Props(). @@ -431,12 +426,6 @@ class AntdFormRender(Component): 设置删除确认弹窗属性，参考 Antd PopConfirm Props. - - actionColumnProps (dict; optional): - - 设置tableList | drawerList | virtualList 中操作列的属性，参考 Antd - - Table ColumnType。 其中 title 使用 colHeaderText 代替。. - - hideAdd (boolean; optional): 设置是否隐藏添加按钮. @@ -445,17 +434,28 @@ class AntdFormRender(Component): 设置是否隐藏复制按钮. + - hideDelete (boolean; optional): + + 设置是否隐藏删除按钮. + - hideMove (boolean; optional): 设置是否隐藏移动按钮. - - hideDelete (boolean; optional): + - title (string; optional): - 设置是否隐藏删除按钮. + 设置标题. - - items (dict; optional): + - type (a value equal to: 'array'; optional): - 动态项配置，可以是一个嵌套控件. + 固定配置为type: 'array'. + + - widget (a value equal to: 'cardList', 'simpleList', 'tableList', 'drawerList', 'virtualList'; optional): + + 设置希望使用的列表组件名称，可选的有'cardList'、'simpleList'、'tableList'、'drawerList'、'virtualList'，默认为'cardList'. + + - type (a value equal to: 'object'; optional): + 固定配置为type: 'object'. - displayType (a value equal to: 'column', 'row', 'inline'; default 'column'): 设置表单布局模式，表单元素与 label 同行 or 分两行展示, inline 则整个展示自然顺排， @@ -484,9 +484,6 @@ class AntdFormRender(Component): `globalConfig` is a dict with keys: - - mustacheDisabled (boolean; optional): - 设置是否禁用表达式. - - listOperate (dict; optional): 设置列表表单配置. @@ -498,6 +495,9 @@ class AntdFormRender(Component): - hideMove (boolean; optional): 设置是否隐藏移动按钮. + - mustacheDisabled (boolean; optional): + 设置是否禁用表达式. + - watch (dict with strings as keys and values of type string; optional): 监听表单的数据变化，属性值需要是字符串格式的js函数. @@ -524,33 +524,33 @@ class AntdFormRender(Component): `footer` is a boolean | dict with keys: - - submit (dict; optional): - 设置提交按钮. + - reset (dict; optional): + 设置重置按钮. - `submit` is a dict with keys: + `reset` is a dict with keys: - - text (string; optional): - 设置按钮文字. + - btnProps (dict; optional): + 设置其他按钮属性，参考 Antd Button Props(). - hide (boolean; optional): 设置是否显示. - - btnProps (dict; optional): - 设置其他按钮属性，参考 Antd Button Props(). + - text (string; optional): + 设置按钮文字. - - reset (dict; optional): - 设置重置按钮. + - submit (dict; optional): + 设置提交按钮. - `reset` is a dict with keys: + `submit` is a dict with keys: - - text (string; optional): - 设置按钮文字. + - btnProps (dict; optional): + 设置其他按钮属性，参考 Antd Button Props(). - hide (boolean; optional): 设置是否显示. - - btnProps (dict; optional): - 设置其他按钮属性，参考 Antd Button Props(). | a list of or a singular dash component, string or number + - text (string; optional): + 设置按钮文字. | a list of or a singular dash component, string or number - configProvider (dict; optional): 同antd的configProvider. @@ -560,11 +560,17 @@ class AntdFormRender(Component): `validateMessages` is a dict with keys: - - default (string; optional) + - array (dict; optional) - - required (string; optional) + `array` is a dict with keys: - - whitespace (string; optional) + - len (string; optional) + + - max (string; optional) + + - min (string; optional) + + - range (string; optional) - date (dict; optional) @@ -572,39 +578,31 @@ class AntdFormRender(Component): - format (string; optional) - - parse (string; optional) - - invalid (string; optional) - - types (dict; optional) - - `types` is a dict with keys: - - - string (string; optional) - - - method (string; optional) + - parse (string; optional) - - array (string; optional) + - default (string; optional) - - object (string; optional) + - number (dict; optional) - - number (string; optional) + `number` is a dict with keys: - - date (string; optional) + - len (string; optional) - - boolean (string; optional) + - max (string; optional) - - integer (string; optional) + - min (string; optional) - - float (string; optional) + - range (string; optional) - - regexp (string; optional) + - pattern (dict; optional) - - email (string; optional) + `pattern` is a dict with keys: - - url (string; optional) + - mismatch (string; optional) - - hex (string; optional) + - required (string; optional) - string (dict; optional) @@ -612,41 +610,43 @@ class AntdFormRender(Component): - len (string; optional) - - min (string; optional) - - max (string; optional) + - min (string; optional) + - range (string; optional) - - number (dict; optional) + - types (dict; optional) - `number` is a dict with keys: + `types` is a dict with keys: - - len (string; optional) + - array (string; optional) - - min (string; optional) + - boolean (string; optional) - - max (string; optional) + - date (string; optional) - - range (string; optional) + - email (string; optional) - - array (dict; optional) + - float (string; optional) - `array` is a dict with keys: + - hex (string; optional) - - len (string; optional) + - integer (string; optional) - - min (string; optional) + - method (string; optional) - - max (string; optional) + - number (string; optional) - - range (string; optional) + - object (string; optional) - - pattern (dict; optional) + - regexp (string; optional) - `pattern` is a dict with keys: + - string (string; optional) - - mismatch (string; optional) + - url (string; optional) + + - whitespace (string; optional) - values (dict; optional): 设置与监听表单数据. @@ -670,14 +670,14 @@ class AntdFormRender(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 = ['footer'] _base_nodes = ['footer', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdHeader.py b/feffery_antd_components/AntdHeader.py index f33e3998..53180b69 100644 --- a/feffery_antd_components/AntdHeader.py +++ b/feffery_antd_components/AntdHeader.py @@ -34,14 +34,14 @@ class AntdHeader(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/AntdIcon.py b/feffery_antd_components/AntdIcon.py index 42417112..1a6392b1 100644 --- a/feffery_antd_components/AntdIcon.py +++ b/feffery_antd_components/AntdIcon.py @@ -40,14 +40,14 @@ class AntdIcon(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/AntdImage.py b/feffery_antd_components/AntdImage.py index 4d7ef36b..fb58ae58 100644 --- a/feffery_antd_components/AntdImage.py +++ b/feffery_antd_components/AntdImage.py @@ -54,29 +54,29 @@ class AntdImage(Component): `preview` is a boolean | dict with keys: - - src (string; optional): - 自定义预览图链接地址. - - - movable (boolean; optional): - 预览模式下是否可移动图片. - - mask (a list of or a singular dash component, string or number; optional): 组件型，用于自定义缩略图遮罩元素. - maskClassName (string; optional): 缩略图遮罩元素css类名. + - maxScale (number; optional): + 最大缩放倍数 默认值：`50`. + + - minScale (number; optional): + 最小缩放倍数 默认值：`1`. + + - movable (boolean; optional): + 预览模式下是否可移动图片. + - rootClassName (string; optional): 缩略图根节点css类名. - scaleStep (number; optional): `1+scaleStep`值为每一步缩放的倍数 默认值：`0.5`. - - minScale (number; optional): - 最小缩放倍数 默认值：`1`. - - - maxScale (number; optional): - 最大缩放倍数 默认值：`50`. + - src (string; optional): + 自定义预览图链接地址. - toolbarExtra (a list of or a singular dash component, string or number; optional): 针对预览模式下的工具栏，末尾扩充自定义工具图标元素. @@ -91,14 +91,14 @@ class AntdImage(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 = ['preview.mask', 'toolbarExtra'] _base_nodes = ['toolbarExtra', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdImageGroup.py b/feffery_antd_components/AntdImageGroup.py index 71a8489d..061cebd2 100644 --- a/feffery_antd_components/AntdImageGroup.py +++ b/feffery_antd_components/AntdImageGroup.py @@ -39,29 +39,29 @@ class AntdImageGroup(Component): `preview` is a boolean | dict with keys: - - src (string; optional): - 自定义预览图链接地址. - - - movable (boolean; optional): - 预览模式下是否可移动图片. - - mask (a list of or a singular dash component, string or number; optional): 组件型，用于自定义缩略图遮罩元素. - maskClassName (string; optional): 缩略图遮罩元素css类名. + - maxScale (number; optional): + 最大缩放倍数 默认值：`50`. + + - minScale (number; optional): + 最小缩放倍数 默认值：`1`. + + - movable (boolean; optional): + 预览模式下是否可移动图片. + - rootClassName (string; optional): 缩略图根节点css类名. - scaleStep (number; optional): `1+scaleStep`值为每一步缩放的倍数 默认值：`0.5`. - - minScale (number; optional): - 最小缩放倍数 默认值：`1`. - - - maxScale (number; optional): - 最大缩放倍数 默认值：`50`. + - src (string; optional): + 自定义预览图链接地址. - visible (boolean; optional): 监听或设置当前图片组是否处于全屏预览状态. @@ -85,14 +85,14 @@ class AntdImageGroup(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 = ['preview.mask', 'toolbarExtra'] _base_nodes = ['toolbarExtra', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdInput.py b/feffery_antd_components/AntdInput.py index 64a28252..42ed00d3 100644 --- a/feffery_antd_components/AntdInput.py +++ b/feffery_antd_components/AntdInput.py @@ -26,6 +26,9 @@ class AntdInput(Component): `styles` is a dict with keys: + - count (dict; optional): + 控制文字计数元素css样式. + - input (dict; optional): 控制文本框元素css样式. @@ -35,9 +38,6 @@ class AntdInput(Component): - suffix (dict; optional): 控制后缀容器css样式. - - count (dict; optional): - 控制文字计数元素css样式. - - textarea (dict; optional): 控制文本域元素css样式. @@ -46,6 +46,9 @@ class AntdInput(Component): `classNames` is a dict with keys: + - count (string; optional): + 控制文字计数元素css类名. + - input (string; optional): 控制文本框元素css类名. @@ -55,9 +58,6 @@ class AntdInput(Component): - suffix (string; optional): 控制后缀容器css类名. - - count (string; optional): - 控制文字计数元素css类名. - - textarea (string; optional): 控制文本域元素css类名. @@ -130,12 +130,12 @@ class AntdInput(Component): `autoSize` is a boolean | dict with keys: - - minRows (number; optional): - 输入框最小行数. - - maxRows (number; optional): 输入框最大行数. + - minRows (number; optional): + 输入框最小行数. + - nSubmit (number; default 0): 监听输入框聚焦状态下，键盘enter键累计点按次数 默认值：`0`. @@ -176,15 +176,15 @@ class AntdInput(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdInputNumber.py b/feffery_antd_components/AntdInputNumber.py index fe4c4b1a..23f8be61 100644 --- a/feffery_antd_components/AntdInputNumber.py +++ b/feffery_antd_components/AntdInputNumber.py @@ -113,15 +113,15 @@ class AntdInputNumber(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdLayout.py b/feffery_antd_components/AntdLayout.py index af268153..b41792e3 100644 --- a/feffery_antd_components/AntdLayout.py +++ b/feffery_antd_components/AntdLayout.py @@ -34,14 +34,14 @@ class AntdLayout(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/AntdMentions.py b/feffery_antd_components/AntdMentions.py index f165dd1e..07f4959a 100644 --- a/feffery_antd_components/AntdMentions.py +++ b/feffery_antd_components/AntdMentions.py @@ -32,12 +32,12 @@ class AntdMentions(Component): `autoSize` is a boolean | dict with keys: - - minRows (number; optional): - 输入框最小行数. - - maxRows (number; optional): 输入框最大行数. + - minRows (number; optional): + 输入框最小行数. + - prefix (string; default '@'): 触发选择菜单展开的关键字 默认值：`'@'`. @@ -101,14 +101,14 @@ class AntdMentions(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 = ['options[].label'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdMenu.py b/feffery_antd_components/AntdMenu.py index 62457b49..633e7931 100644 --- a/feffery_antd_components/AntdMenu.py +++ b/feffery_antd_components/AntdMenu.py @@ -27,12 +27,12 @@ class AntdMenu(Component): `expandIcon` is a a list of or a singular dash component, string or number | dict with keys: - - expand (a list of or a singular dash component, string or number; optional): - 展开图标. - - collapse (a list of or a singular dash component, string or number; optional): 收起图标. + - expand (a list of or a singular dash component, string or number; optional): + 展开图标. + - menuItems (list; optional): 导航菜单数据结构. @@ -94,15 +94,15 @@ class AntdMenu(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. - - persistence (boolean | string | number; optional): 是否为当前组件开启持久化功能. diff --git a/feffery_antd_components/AntdMessage.py b/feffery_antd_components/AntdMessage.py index 3d523ca1..20352ca9 100644 --- a/feffery_antd_components/AntdMessage.py +++ b/feffery_antd_components/AntdMessage.py @@ -50,14 +50,14 @@ class AntdMessage(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/AntdModal.py b/feffery_antd_components/AntdModal.py index 901a85e4..addddce3 100644 --- a/feffery_antd_components/AntdModal.py +++ b/feffery_antd_components/AntdModal.py @@ -45,12 +45,8 @@ class AntdModal(Component): `okButtonProps` is a dict with keys: - - size (a value equal to: 'small', 'middle', 'large'; optional): - 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. - - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` - 默认值：`'default'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否呈现危险样式 默认值：`False`. @@ -61,11 +57,15 @@ class AntdModal(Component): - shape (a value equal to: 'circle', 'round'; optional): 按钮形状，可选项有`'default'`、`'circle'`、`'round'` 默认值：`'default'`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - cancelText (a list of or a singular dash component, string or number; optional): 组件型，取消按钮内容. @@ -75,12 +75,8 @@ class AntdModal(Component): `cancelButtonProps` is a dict with keys: - - size (a value equal to: 'small', 'middle', 'large'; optional): - 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. - - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` - 默认值：`'default'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否呈现危险样式 默认值：`False`. @@ -91,11 +87,15 @@ class AntdModal(Component): - shape (a value equal to: 'circle', 'round'; optional): 按钮形状，可选项有`'default'`、`'circle'`、`'round'` 默认值：`'default'`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - width (number | string; default 520): 对话框像素宽度 默认值：`520`. @@ -165,14 +165,14 @@ class AntdModal(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 = ['title', 'okText', 'cancelText', 'loadingOkText'] _base_nodes = ['title', 'okText', 'cancelText', 'loadingOkText', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdNotification.py b/feffery_antd_components/AntdNotification.py index 067cc92f..8aea8405 100644 --- a/feffery_antd_components/AntdNotification.py +++ b/feffery_antd_components/AntdNotification.py @@ -52,22 +52,22 @@ class AntdNotification(Component): `closeButton` is a dict with keys: + - className (string; optional): + 按钮css类名. + - content (string; optional): 按钮内容. + - danger (boolean; optional): + 按钮是否呈现危险状态 默认值：`False`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. - - type (a value equal to: 'default', 'primary', 'ghost', 'dashed', 'link', 'text'; optional): 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` 默认值：`'default'`. - - danger (boolean; optional): - 按钮是否呈现危险状态 默认值：`False`. - - underCompatibilityMode (boolean; optional): 当前通知提醒框组件是否位于设置了`compatibilityMode=True`的`AntdConfigProvider`内部. @@ -75,14 +75,14 @@ class AntdNotification(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/AntdOTP.py b/feffery_antd_components/AntdOTP.py index 7e5b70f4..90b5fc73 100644 --- a/feffery_antd_components/AntdOTP.py +++ b/feffery_antd_components/AntdOTP.py @@ -58,15 +58,15 @@ class AntdOTP(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdPageHeader.py b/feffery_antd_components/AntdPageHeader.py index dee3f46d..59871ddd 100644 --- a/feffery_antd_components/AntdPageHeader.py +++ b/feffery_antd_components/AntdPageHeader.py @@ -52,14 +52,14 @@ class AntdPageHeader(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 = ['title', 'subTitle'] _base_nodes = ['title', 'subTitle', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdPagination.py b/feffery_antd_components/AntdPagination.py index 605d057f..639071b8 100644 --- a/feffery_antd_components/AntdPagination.py +++ b/feffery_antd_components/AntdPagination.py @@ -92,15 +92,15 @@ class AntdPagination(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. - - persistence (boolean | string | number; optional): 是否为当前组件开启持久化功能. diff --git a/feffery_antd_components/AntdParagraph.py b/feffery_antd_components/AntdParagraph.py index d9844283..1fcc4f7e 100644 --- a/feffery_antd_components/AntdParagraph.py +++ b/feffery_antd_components/AntdParagraph.py @@ -82,14 +82,14 @@ class AntdParagraph(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 = ['ellipsis.symbol'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdPictureUpload.py b/feffery_antd_components/AntdPictureUpload.py index cc8163aa..9dd753b0 100644 --- a/feffery_antd_components/AntdPictureUpload.py +++ b/feffery_antd_components/AntdPictureUpload.py @@ -60,26 +60,20 @@ class AntdPictureUpload(Component): - aspect (number; optional): 裁切区域宽高比 默认值：`1`. - - shape (a value equal to: 'rect', 'round'; optional): - 裁切区域形状，可选项有`'rect'`、`'round'` 默认值：`'rect'`. - - grid (boolean; optional): 是否显示裁切区域辅助网格线 默认值：`False`. - - quality (number; optional): - 图片质量，取值应在0到1之间 默认值：`0.4`. - - - zoom (boolean; optional): - 是否启用图片缩放功能 默认值：`True`. - - - rotate (boolean; optional): - 是否启用图片旋转功能 默认值：`False`. + - maxZoom (number; optional): + 开启缩放功能时，设置最大缩放倍数 默认值：`3`. - minZoom (number; optional): 开启缩放功能时，设置最小缩放倍数 默认值：`1`. - - maxZoom (number; optional): - 开启缩放功能时，设置最大缩放倍数 默认值：`3`. + - modalCancel (a list of or a singular dash component, string or number; optional): + 组件型，图片编辑模态框取消按钮内容 默认值：`'取消'`. + + - modalOk (a list of or a singular dash component, string or number; optional): + 组件型，图片编辑模态框确认按钮内容 默认值：`'确定'`. - modalTitle (a list of or a singular dash component, string or number; optional): 组件型，图片编辑模态框的标题 默认值：`'编辑图片'`. @@ -87,11 +81,17 @@ class AntdPictureUpload(Component): - modalWidth (number; optional): 图片编辑模态框像素宽度 默认值：`520`. - - modalOk (a list of or a singular dash component, string or number; optional): - 组件型，图片编辑模态框确认按钮内容 默认值：`'确定'`. + - quality (number; optional): + 图片质量，取值应在0到1之间 默认值：`0.4`. - - modalCancel (a list of or a singular dash component, string or number; optional): - 组件型，图片编辑模态框取消按钮内容 默认值：`'取消'`. + - rotate (boolean; optional): + 是否启用图片旋转功能 默认值：`False`. + + - shape (a value equal to: 'rect', 'round'; optional): + 裁切区域形状，可选项有`'rect'`、`'round'` 默认值：`'rect'`. + + - zoom (boolean; optional): + 是否启用图片缩放功能 默认值：`True`. - fileListMaxLength (number; optional): 限制已上传文件列表长度上限. @@ -129,6 +129,17 @@ class AntdPictureUpload(Component): `progressProps` is a dict with keys: + - format (dict; optional): + 进度文字格式. + + `format` is a dict with keys: + + - prefix (string; optional): + 进度文字前缀内容. + + - suffix (string; optional): + 进度文字后缀内容 默认值：`'%'`. + - strokeColor (dict; optional): 进度条颜色. @@ -147,17 +158,6 @@ class AntdPictureUpload(Component): - strokeWidth (number; optional): 进度条像素宽度. - - format (dict; optional): - 进度文字格式. - - `format` is a dict with keys: - - - prefix (string; optional): - 进度文字前缀内容. - - - suffix (string; optional): - 进度文字后缀内容 默认值：`'%'`. - - showSuccessMessage (boolean; default True): 是否在每个文件上传成功后，分别弹出消息提示 默认值：`True`. @@ -169,26 +169,29 @@ class AntdPictureUpload(Component): `lastUploadTaskRecord` is a dict with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): - 当前文件的下载链接. + 当前文件的下载链接. | list of dicts with keys: - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. | list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. - fileName (string; optional): 文件名称. @@ -196,73 +199,70 @@ class AntdPictureUpload(Component): - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): 当前文件的下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. - - listUploadTaskRecord (list of dicts; optional): 监听当前已上传文件列表中上传任务相关信息. `listUploadTaskRecord` is a list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - - uid (string; optional): 当前文件上传唯一识别id，前端自动生成. - - url (string; optional): - 当前文件下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): 上传任务的接口响应信息. + - url (string; optional): + 当前文件下载链接. + - defaultFileList (list of dicts; optional): 初始化文件列表展示信息. `defaultFileList` is a list of dicts with keys: + - fileSize (number; optional): + 当前文件大小. + - name (string; optional): 当前文件名称. - status (a value equal to: 'done', 'error', 'removed'; optional): 当前文件展示状态，可选项有`'done'`、`'error'`、`'removed'`. + - taskId (string; optional): + 若传入有效值，将作为当前组件的`uploadId`参数. + - uid (boolean | number | string | dict | list; optional): 当前文件唯一识别id. - url (string; optional): 当前文件下载链接. - - taskId (string; optional): - 若传入有效值，将作为当前组件的`uploadId`参数. - - - fileSize (number; optional): - 当前文件大小. - - disabled (boolean; default False): 是否禁用当前组件 默认值：`False`. @@ -279,14 +279,14 @@ class AntdPictureUpload(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 = ['editConfig.modalTitle', 'editConfig.modalOk', 'editConfig.modalCancel', 'buttonContent'] _base_nodes = ['buttonContent', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdPopconfirm.py b/feffery_antd_components/AntdPopconfirm.py index 7955dcb9..3e68d50e 100644 --- a/feffery_antd_components/AntdPopconfirm.py +++ b/feffery_antd_components/AntdPopconfirm.py @@ -67,12 +67,8 @@ class AntdPopconfirm(Component): `okButtonProps` is a dict with keys: - - size (a value equal to: 'small', 'middle', 'large'; optional): - 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. - - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` - 默认值：`'default'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否呈现危险样式 默认值：`False`. @@ -83,11 +79,15 @@ class AntdPopconfirm(Component): - shape (a value equal to: 'circle', 'round'; optional): 按钮形状，可选项有`'default'`、`'circle'`、`'round'` 默认值：`'default'`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - cancelText (a list of or a singular dash component, string or number; optional): 组件型，取消按钮内容. @@ -97,12 +97,8 @@ class AntdPopconfirm(Component): `cancelButtonProps` is a dict with keys: - - size (a value equal to: 'small', 'middle', 'large'; optional): - 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. - - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` - 默认值：`'default'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否呈现危险样式 默认值：`False`. @@ -113,11 +109,15 @@ class AntdPopconfirm(Component): - shape (a value equal to: 'circle', 'round'; optional): 按钮形状，可选项有`'default'`、`'circle'`、`'round'` 默认值：`'default'`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 按钮尺寸规格，可选项有`'small'`、`'middle'`、`'large'` 默认值：`'middle'`. + - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - showCancel (boolean; default True): 是否显示取消按钮 默认值：`True`. @@ -159,14 +159,14 @@ class AntdPopconfirm(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 = ['icon', 'title', 'description', 'okText', 'cancelText'] _base_nodes = ['icon', 'title', 'description', 'okText', 'cancelText', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdPopover.py b/feffery_antd_components/AntdPopover.py index 0f310aec..0de15345 100644 --- a/feffery_antd_components/AntdPopover.py +++ b/feffery_antd_components/AntdPopover.py @@ -83,14 +83,14 @@ class AntdPopover(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 = ['title', 'content'] _base_nodes = ['title', 'content', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdPopupCard.py b/feffery_antd_components/AntdPopupCard.py index 9e665519..d18297e7 100644 --- a/feffery_antd_components/AntdPopupCard.py +++ b/feffery_antd_components/AntdPopupCard.py @@ -68,14 +68,14 @@ class AntdPopupCard(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 = ['title'] _base_nodes = ['title', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdProgress.py b/feffery_antd_components/AntdProgress.py index 970cddc6..7e3a427f 100644 --- a/feffery_antd_components/AntdProgress.py +++ b/feffery_antd_components/AntdProgress.py @@ -59,15 +59,15 @@ class AntdProgress(Component): `format` is a dict with keys: + - content (a list of or a singular dash component, string or number; optional): + 组件型，强制设置显示内容. + - prefix (string; optional): 进度提示前缀文字 默认值：`''`. - suffix (string; optional): 进度提示后缀文字 默认值：`'%'`. - - content (a list of or a singular dash component, string or number; optional): - 组件型，强制设置显示内容. - - status (a value equal to: 'success', 'exception', 'normal', 'active'; optional): 进度条状态，可选项有`'success'`、`'exception'`、`'normal'`、`'active'`，其中`'active'`仅在`type='line'`时生效 默认值：`'normal'`. @@ -118,14 +118,14 @@ class AntdProgress(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 = ['format.content'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdQRCode.py b/feffery_antd_components/AntdQRCode.py index fcdc134e..2d811136 100644 --- a/feffery_antd_components/AntdQRCode.py +++ b/feffery_antd_components/AntdQRCode.py @@ -42,10 +42,10 @@ class AntdQRCode(Component): `iconSize` is a number | dict with keys: - - width (number; optional) - - height (number; optional) + - width (number; optional) + - color (string; default '#000'): 二维码颜色 默认值：`'#000'`. @@ -81,14 +81,14 @@ class AntdQRCode(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/AntdRadioGroup.py b/feffery_antd_components/AntdRadioGroup.py index c570640a..866b419c 100644 --- a/feffery_antd_components/AntdRadioGroup.py +++ b/feffery_antd_components/AntdRadioGroup.py @@ -32,14 +32,14 @@ class AntdRadioGroup(Component): `options` is a list of string | number | dict with keys: + - disabled (boolean; optional): + 是否禁用当前选项 默认值：`False`. + - label (a list of or a singular dash component, string or number; optional): 组件型，当前选项标签内容. - value (string | number; optional): - 当前选项值. - - - disabled (boolean; optional): - 是否禁用当前选项 默认值：`False`.s + 当前选项值.s - disabled (boolean; default False): 是否禁用当前组件 默认值：`False`. @@ -80,15 +80,15 @@ class AntdRadioGroup(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdRate.py b/feffery_antd_components/AntdRate.py index 42947ea5..3dd027fe 100644 --- a/feffery_antd_components/AntdRate.py +++ b/feffery_antd_components/AntdRate.py @@ -64,15 +64,15 @@ class AntdRate(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdResult.py b/feffery_antd_components/AntdResult.py index 84a03920..3fad2767 100644 --- a/feffery_antd_components/AntdResult.py +++ b/feffery_antd_components/AntdResult.py @@ -47,14 +47,14 @@ class AntdResult(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 = ['extra', 'title', 'subTitle', 'icon'] _base_nodes = ['extra', 'title', 'subTitle', 'icon', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdRibbon.py b/feffery_antd_components/AntdRibbon.py index 1b9da0e9..6823a863 100644 --- a/feffery_antd_components/AntdRibbon.py +++ b/feffery_antd_components/AntdRibbon.py @@ -43,14 +43,14 @@ class AntdRibbon(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 = ['text'] _base_nodes = ['text', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdRow.py b/feffery_antd_components/AntdRow.py index b25762c3..6c860e52 100644 --- a/feffery_antd_components/AntdRow.py +++ b/feffery_antd_components/AntdRow.py @@ -32,21 +32,21 @@ class AntdRow(Component): `gutter` is a number | list of numbers | dict with keys: - - xs (number; optional): - 页面宽度小于567px时的水平像素间隔. - - - sm (number; optional): - 页面宽度大于等于567px时的水平像素间隔. + - lg (number; optional): + 页面宽度大于等于992px时的水平像素间隔. - md (number; optional): 页面宽度大于等于768px时的水平像素间隔. - - lg (number; optional): - 页面宽度大于等于992px时的水平像素间隔. + - sm (number; optional): + 页面宽度大于等于567px时的水平像素间隔. - xl (number; optional): 页面宽度大于等于1200px时的水平像素间隔. + - xs (number; optional): + 页面宽度小于567px时的水平像素间隔. + - xxl (number; optional): 页面宽度大于等于1600px时的水平像素间隔. @@ -67,14 +67,14 @@ class AntdRow(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/AntdSegmented.py b/feffery_antd_components/AntdSegmented.py index 95fb2f4a..382356ab 100644 --- a/feffery_antd_components/AntdSegmented.py +++ b/feffery_antd_components/AntdSegmented.py @@ -26,12 +26,6 @@ class AntdSegmented(Component): `options` is a list of dicts with keys: - - label (a list of or a singular dash component, string or number; required): - 组件型，必填，选项标题内容. - - - value (string | number; required): - 必填，选项值. - - disabled (boolean; optional): 是否禁用当前选项 默认值：`False`. @@ -41,6 +35,12 @@ class AntdSegmented(Component): - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 选项前缀图标类型，可选项有`'AntdIcon'`、`'fontawesome'` 默认值：`'AntdIcon'`. + - label (a list of or a singular dash component, string or number; required): + 组件型，必填，选项标题内容. + + - value (string | number; required): + 必填，选项值. + - value (string | number; optional): 监听或设置当前选中值. @@ -72,15 +72,15 @@ class AntdSegmented(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdSegmentedColoring.py b/feffery_antd_components/AntdSegmentedColoring.py index 6e8a500a..324e36ce 100644 --- a/feffery_antd_components/AntdSegmentedColoring.py +++ b/feffery_antd_components/AntdSegmentedColoring.py @@ -108,14 +108,14 @@ class AntdSegmentedColoring(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/AntdSelect.py b/feffery_antd_components/AntdSelect.py index 85635bd3..0834096a 100644 --- a/feffery_antd_components/AntdSelect.py +++ b/feffery_antd_components/AntdSelect.py @@ -36,19 +36,19 @@ class AntdSelect(Component): `options` is a list of string | number | dict with keys: + - colors (list of strings; optional): + 针对色带特殊渲染模式，设置生成渐变色带所需的色彩值数组. + + - disabled (boolean; optional): + 是否禁用当前选项 默认值：`False`. + - label (a list of or a singular dash component, string or number; required): 组件型，当前选项标签内容. - value (string Or number; required): - 当前选项值. - - - disabled (boolean; optional): - 是否禁用当前选项 默认值：`False`. - - - colors (list of strings; optional): - 针对色带特殊渲染模式，设置生成渐变色带所需的色彩值数组. | dict with keys: + 当前选项值. | dict with keys: - group (a list of or a singular dash component, string or number; optional): 组件型，当前分组标签内容. @@ -58,21 +58,21 @@ class AntdSelect(Component): `options` is a list of dicts with keys: - - label (a list of or a singular dash component, string or number; required): - - 组件型，当前选项标签内容. - - - value (string | number; required): + - colors (list of strings; optional): - 当前选项值. + 针对色带特殊渲染模式，设置生成渐变色带所需的色彩值数组. - disabled (boolean; optional): 是否禁用当前选项 默认值：`False`. - - colors (list of strings; optional): + - label (a list of or a singular dash component, string or number; required): + + 组件型，当前选项标签内容. + + - value (string | number; required): - 针对色带特殊渲染模式，设置生成渐变色带所需的色彩值数组.s + 当前选项值.s - listHeight (number; default 256): 下拉菜单最大像素高度. @@ -182,15 +182,15 @@ class AntdSelect(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdSider.py b/feffery_antd_components/AntdSider.py index a73d6d24..fd165b48 100644 --- a/feffery_antd_components/AntdSider.py +++ b/feffery_antd_components/AntdSider.py @@ -58,14 +58,14 @@ class AntdSider(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 = ['trigger'] _base_nodes = ['trigger', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdSkeleton.py b/feffery_antd_components/AntdSkeleton.py index 8878bd68..236bccd4 100644 --- a/feffery_antd_components/AntdSkeleton.py +++ b/feffery_antd_components/AntdSkeleton.py @@ -97,14 +97,14 @@ class AntdSkeleton(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/AntdSkeletonAvatar.py b/feffery_antd_components/AntdSkeletonAvatar.py index 0cf3a02e..a82eb56b 100644 --- a/feffery_antd_components/AntdSkeletonAvatar.py +++ b/feffery_antd_components/AntdSkeletonAvatar.py @@ -41,14 +41,14 @@ class AntdSkeletonAvatar(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/AntdSkeletonButton.py b/feffery_antd_components/AntdSkeletonButton.py index f7f7e8f3..fc99d151 100644 --- a/feffery_antd_components/AntdSkeletonButton.py +++ b/feffery_antd_components/AntdSkeletonButton.py @@ -43,14 +43,14 @@ class AntdSkeletonButton(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/AntdSkeletonImage.py b/feffery_antd_components/AntdSkeletonImage.py index dad3946a..304d3268 100644 --- a/feffery_antd_components/AntdSkeletonImage.py +++ b/feffery_antd_components/AntdSkeletonImage.py @@ -31,14 +31,14 @@ class AntdSkeletonImage(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/AntdSkeletonInput.py b/feffery_antd_components/AntdSkeletonInput.py index bf71ed9d..04b20abd 100644 --- a/feffery_antd_components/AntdSkeletonInput.py +++ b/feffery_antd_components/AntdSkeletonInput.py @@ -37,14 +37,14 @@ class AntdSkeletonInput(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/AntdSlider.py b/feffery_antd_components/AntdSlider.py index 42fecf6e..3226594e 100644 --- a/feffery_antd_components/AntdSlider.py +++ b/feffery_antd_components/AntdSlider.py @@ -29,23 +29,23 @@ class AntdSlider(Component): `styles` is a dict with keys: - - track (dict; optional): - 选择条css样式. - - rail (dict; optional): 背景条css样式. + - track (dict; optional): + 选择条css样式. + - classNames (dict; optional): 细分控制子元素css类名. `classNames` is a dict with keys: - - track (string; optional): - 选择条css类名. - - rail (string; optional): 背景条css类名. + - track (string; optional): + 选择条css类名. + - name (string; optional): 配合`AntdForm`表单批量值搜集/控制功能使用，充当当前表单项的字段名，以`id`作为缺省值. @@ -110,15 +110,15 @@ class AntdSlider(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdSpace.py b/feffery_antd_components/AntdSpace.py index 3d5543d6..1cfc18b6 100644 --- a/feffery_antd_components/AntdSpace.py +++ b/feffery_antd_components/AntdSpace.py @@ -69,14 +69,14 @@ class AntdSpace(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 = ['customSplit'] _base_nodes = ['customSplit', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdSpin.py b/feffery_antd_components/AntdSpin.py index ddead040..8d1c492c 100644 --- a/feffery_antd_components/AntdSpin.py +++ b/feffery_antd_components/AntdSpin.py @@ -76,14 +76,14 @@ class AntdSpin(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 = ['indicator'] _base_nodes = ['indicator', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdSpoiler.py b/feffery_antd_components/AntdSpoiler.py index 8af07eb6..96b664df 100644 --- a/feffery_antd_components/AntdSpoiler.py +++ b/feffery_antd_components/AntdSpoiler.py @@ -62,14 +62,14 @@ class AntdSpoiler(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 = ['hideLabel', 'showLabel'] _base_nodes = ['hideLabel', 'showLabel', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdStatistic.py b/feffery_antd_components/AntdStatistic.py index ce500e8f..22f35bc0 100644 --- a/feffery_antd_components/AntdStatistic.py +++ b/feffery_antd_components/AntdStatistic.py @@ -55,14 +55,14 @@ class AntdStatistic(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 = ['value', 'prefix', 'suffix', 'title'] _base_nodes = ['value', 'prefix', 'suffix', 'title', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdSteps.py b/feffery_antd_components/AntdSteps.py index 416a80ec..d8bb228d 100644 --- a/feffery_antd_components/AntdSteps.py +++ b/feffery_antd_components/AntdSteps.py @@ -26,24 +26,24 @@ class AntdSteps(Component): `steps` is a list of dicts with keys: - - title (a list of or a singular dash component, string or number; required): - 步骤标题. - - - subTitle (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): 步骤描述内容. - - icon (a list of or a singular dash component, string or number; optional): - 步骤自定义图标. - - disabled (boolean; optional): 是否禁用当前步骤. + - icon (a list of or a singular dash component, string or number; optional): + 步骤自定义图标. + - status (a value equal to: 'wait', 'process', 'finish', 'error'; optional): 强制设置当前步骤状态，同参数status. + - subTitle (a list of or a singular dash component, string or number; optional): + 步骤子标题. + + - title (a list of or a singular dash component, string or number; required): + 步骤标题. + - current (number; default 0): 当前所处的步骤序号 默认值：`0`. @@ -85,14 +85,14 @@ class AntdSteps(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 = ['steps[].title', 'steps[].subTitle', 'steps[].description', 'steps[].icon'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdSwitch.py b/feffery_antd_components/AntdSwitch.py index b5426c3b..f4a41ce6 100644 --- a/feffery_antd_components/AntdSwitch.py +++ b/feffery_antd_components/AntdSwitch.py @@ -64,15 +64,15 @@ class AntdSwitch(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTable.py b/feffery_antd_components/AntdTable.py index 95f82acb..f40cd0e6 100644 --- a/feffery_antd_components/AntdTable.py +++ b/feffery_antd_components/AntdTable.py @@ -33,64 +33,67 @@ class AntdTable(Component): `columns` is a list of dicts with keys: - - title (a list of or a singular dash component, string or number; required): - 必填，当前字段标题. + - align (a value equal to: 'left', 'center', 'right'; optional): + 当前字段对齐方式，可选项有`'left'`、`'center'`、`'right'` 默认值：`'center'`. + + - className (string; optional): + 当前字段css类名. - dataIndex (string; required): 必填，当前字段唯一识别id. - - group (string | list of strings; optional): - 当前字段所属分组信息，用于渲染多级表头. + - editOptions (dict; optional): + 配置可编辑模式下输入框相关参数. - - renderOptions (dict; optional): - 配置字段[再渲染模式](/AntdTable-rerender)相关参数. + `editOptions` is a dict with keys: - `renderOptions` is a dict with keys: + - autoSize (dict; optional): + 当`mode='textarea'`时，配置文本框自适应高度相关功能，同`AntdInput` + 默认值：`False`. - - renderType (a value equal to: 'link', 'ellipsis', 'copyable', 'ellipsis-copyable', 'tags', 'status-badge', 'image', 'custom-format', 'corner-mark', 'row-merge', 'dropdown', 'dropdown-links', 'image-avatar', 'mini-line', 'mini-bar', 'mini-progress', 'mini-ring-progress', 'mini-area', 'button', 'checkbox', 'switch', 'select'; optional): - 再渲染类型，可选项有`'link'`、`'ellipsis'`、`'copyable'`、`'ellipsis-copyable'`、`'tags'`、`'status-badge'`、`'image'` - 、`'custom-format'`、`'corner-mark'`、`'row-merge'`、`'dropdown'`、`'dropdown-links'`、`'image-avatar'` - 、`'mini-line'`、`'mini-bar'`、`'mini-progress'`、`'mini-ring-progress'`、`'mini-area'` - 、`'button'`、`'checkbox'`、`'switch'`、`'select'`. + `autoSize` is a boolean - - renderLinkText (string; optional): - 当`renderType='link'`时，统一设置渲染链接文本内容. + Or dict with keys: - - renderButtonSplit (boolean; optional): - 当`renderType='button'`时，控制多个按钮之间是否添加分割线. + - maxRows (number; optional) - - renderButtonPopConfirmProps (dict; optional): - 当`renderType='button'`时，配置气泡确认框相关参数. + - minRows (number; optional) - `renderButtonPopConfirmProps` is a dict with keys: + - maxLength (number; optional): + 限制当前字段可编辑模式下，输入框内最多可输入的字符数量，默认无限制. - - title (string; optional): - 气泡确认框标题. + - mode (a value equal to: 'default', 'text-area'; optional): + 编辑框模式，可选项有`'default'`、`'text-area'` 默认值：`'default'`. - - okText (string; optional): - 气泡确认框确认按钮文案. + - placeholder (string; optional): + 输入框无输入值时的占位提示信息. - - cancelText (string; optional): - 气泡确认框取消按钮文案. + - editable (boolean; optional): + 当前字段是否可编辑 默认值：`False`. - - tooltipCustomContent (string; optional): - 当`renderType`为`'mini-line'`、`'mini-area'`、`'mini-bar'`时，设置用于渲染信息卡片的`javascript`函数字符串. + - filterResetToDefaultFilteredValue (boolean; optional): + 若当前字段通过参数`defaultFilteredValues`设置了初始化默认选中的筛选值，用于设置是否在用户点击重置按钮后恢复默认选中筛选项 + 默认值：`False`. - - progressOneHundredPercentColor (string; optional): - 当`renderType`为`'mini-progress'`、`'mini-ring-progress'`时，设置进度完成状态下的填充色 - 默认值：`'#52c41a'`. + - fixed (a value equal to: 'left', 'right'; optional): + 当前字段冻结方向，可选项有`'left'`、`'right'`. - - ringProgressFontSize (number; optional): - 当`renderType='mini-ring-progress'`时，设置进度数值像素大小. + - group (string | list of strings; optional): + 当前字段所属分组信息，用于渲染多级表头. + + - hidden (boolean; optional): + 是否隐藏当前字段 默认值：`False`. + + - renderOptions (dict; optional): + 配置字段[再渲染模式](/AntdTable-rerender)相关参数. + + `renderOptions` is a dict with keys: - dropdownProps (dict; optional): 当`renderType`为`'dropdown'`、`'dropdown-links'`时，配置下拉菜单相关参数. `dropdownProps` is a dict with keys: - - title (string; optional): - 下拉菜单锚点标题内容. - - arrow (boolean; optional): 下拉菜单是否显示指示箭头 默认值：`False`. @@ -106,54 +109,51 @@ class AntdTable(Component): - placement (a value equal to: 'bottomLeft', 'bottomCenter', 'bottomRight', 'topLeft', 'topCenter', 'topRight'; optional): 下拉菜单展开方向，可选项有`'bottomLeft'`、`'bottomCenter'`、`'bottomRight'`、`'topLeft'`、`'topCenter'`、`'topRight'`. - - fixed (a value equal to: 'left', 'right'; optional): - 当前字段冻结方向，可选项有`'left'`、`'right'`. + - title (string; optional): + 下拉菜单锚点标题内容. - - editable (boolean; optional): - 当前字段是否可编辑 默认值：`False`. + - progressOneHundredPercentColor (string; optional): + 当`renderType`为`'mini-progress'`、`'mini-ring-progress'`时，设置进度完成状态下的填充色 + 默认值：`'#52c41a'`. - - editOptions (dict; optional): - 配置可编辑模式下输入框相关参数. + - renderButtonPopConfirmProps (dict; optional): + 当`renderType='button'`时，配置气泡确认框相关参数. - `editOptions` is a dict with keys: + `renderButtonPopConfirmProps` is a dict with keys: - - mode (a value equal to: 'default', 'text-area'; optional): - 编辑框模式，可选项有`'default'`、`'text-area'` 默认值：`'default'`. + - cancelText (string; optional): + 气泡确认框取消按钮文案. - - autoSize (dict; optional): - 当`mode='textarea'`时，配置文本框自适应高度相关功能，同`AntdInput` - 默认值：`False`. + - okText (string; optional): + 气泡确认框确认按钮文案. - `autoSize` is a boolean + - title (string; optional): + 气泡确认框标题. - Or dict with keys: + - renderButtonSplit (boolean; optional): + 当`renderType='button'`时，控制多个按钮之间是否添加分割线. - - minRows (number; optional) + - renderLinkText (string; optional): + 当`renderType='link'`时，统一设置渲染链接文本内容. - - maxRows (number; optional) + - renderType (a value equal to: 'link', 'ellipsis', 'copyable', 'ellipsis-copyable', 'tags', 'status-badge', 'image', 'custom-format', 'corner-mark', 'row-merge', 'dropdown', 'dropdown-links', 'image-avatar', 'mini-line', 'mini-bar', 'mini-progress', 'mini-ring-progress', 'mini-area', 'button', 'checkbox', 'switch', 'select'; optional): + 再渲染类型，可选项有`'link'`、`'ellipsis'`、`'copyable'`、`'ellipsis-copyable'`、`'tags'`、`'status-badge'`、`'image'` + 、`'custom-format'`、`'corner-mark'`、`'row-merge'`、`'dropdown'`、`'dropdown-links'`、`'image-avatar'` + 、`'mini-line'`、`'mini-bar'`、`'mini-progress'`、`'mini-ring-progress'`、`'mini-area'` + 、`'button'`、`'checkbox'`、`'switch'`、`'select'`. - - maxLength (number; optional): - 限制当前字段可编辑模式下，输入框内最多可输入的字符数量，默认无限制. + - ringProgressFontSize (number; optional): + 当`renderType='mini-ring-progress'`时，设置进度数值像素大小. - - placeholder (string; optional): - 输入框无输入值时的占位提示信息. + - tooltipCustomContent (string; optional): + 当`renderType`为`'mini-line'`、`'mini-area'`、`'mini-bar'`时，设置用于渲染信息卡片的`javascript`函数字符串. - - align (a value equal to: 'left', 'center', 'right'; optional): - 当前字段对齐方式，可选项有`'left'`、`'center'`、`'right'` 默认值：`'center'`. + - title (a list of or a singular dash component, string or number; required): + 必填，当前字段标题. - width (number | string; optional): 当前字段宽度. - - hidden (boolean; optional): - 是否隐藏当前字段 默认值：`False`. - - - className (string; optional): - 当前字段css类名. - - - filterResetToDefaultFilteredValue (boolean; optional): - 若当前字段通过参数`defaultFilteredValues`设置了初始化默认选中的筛选值，用于设置是否在用户点击重置按钮后恢复默认选中筛选项 - 默认值：`False`. - - showHeader (boolean; default True): 是否显示表头 默认值：`True`. @@ -174,15 +174,15 @@ class AntdTable(Component): - content (string; optional): 适用于`'link'`模式，链接显示的文字内容，优先级高于字段配置信息中的`renderLinkText`参数. + - disabled (boolean; optional): + 适用于`'link'`模式，是否禁用当前链接 默认值：`False`. + - href (string; optional): 适用于`'link'`模式，链接地址. - target (string; optional): 适用于`'link'`模式，链接跳转行为 默认值：`'_blank'`. - - disabled (boolean; optional): - 适用于`'link'`模式，是否禁用当前链接 默认值：`False`. - Or list of numbers | dict with keys: - color (string; optional): @@ -197,65 +197,65 @@ class AntdTable(Component): - tag (string | number; optional): 适用于`'tags'`模式，当前标签内容. | dict with keys: - - disabled (boolean; optional): - 适用于`'button'`模式，同`AntdButton`中的同名参数. + - content (string; optional): + 适用于`'button'`模式，按钮内容. - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 适用于`'button'`模式，同`AntdButton`中的同名参数. + - custom (boolean | number | string | dict | list; optional): + 适用于`'button'`模式，额外补充信息. - danger (boolean; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - style (dict; optional): + - disabled (boolean; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - content (string; optional): - 适用于`'button'`模式，按钮内容. - - href (string; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - target (string; optional): - 适用于`'button'`模式，同`AntdButton`中的同名参数. - - icon (string; optional): 适用于`'button'`模式，按钮前缀图标类型，`iconRenderer`为`'AntdIcon'`时同`AntdIcon`同名参数，`iconRenderer`为`'fontawesome'`时为css类名. - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 适用于`'button'`模式，按钮前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. - - custom (boolean | number | string | dict | list; optional): - 适用于`'button'`模式，额外补充信息. | list of dicts with keys: + - style (dict; optional): + 适用于`'button'`模式，同`AntdButton`中的同名参数. - - disabled (boolean; optional): + - target (string; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 适用于`'button'`模式，同`AntdButton`中的同名参数. + 适用于`'button'`模式，同`AntdButton`中的同名参数. | list of dicts with keys: + + - content (string; optional): + 适用于`'button'`模式，按钮内容. + + - custom (boolean | number | string | dict | list; optional): + 适用于`'button'`模式，额外补充信息. - danger (boolean; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - style (dict; optional): + - disabled (boolean; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - content (string; optional): - 适用于`'button'`模式，按钮内容. - - href (string; optional): 适用于`'button'`模式，同`AntdButton`中的同名参数. - - target (string; optional): - 适用于`'button'`模式，同`AntdButton`中的同名参数. - - icon (string; optional): 适用于`'button'`模式，当前按钮前缀图标类型，`iconRenderer`为`'AntdIcon'`时同`AntdIcon`同名参数，`iconRenderer`为`'fontawesome'`时为css类名. - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 适用于`'button'`模式，当前按钮前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. - - custom (boolean | number | string | dict | list; optional): - 适用于`'button'`模式，额外补充信息. | dict with keys: + - style (dict; optional): + 适用于`'button'`模式，同`AntdButton`中的同名参数. + + - target (string; optional): + 适用于`'button'`模式，同`AntdButton`中的同名参数. + + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 适用于`'button'`模式，同`AntdButton`中的同名参数. | dict with keys: - status (a value equal to: 'success', 'processing', 'default', 'error', 'warning'; optional): 适用于`'status-badge'`模式，状态徽标状态，可选项有`'success'`、`'processing'`、`'default'`、`'error'`、`'warning'`. @@ -263,17 +263,14 @@ class AntdTable(Component): - text (string | number; optional): 适用于`'status-badge'`模式，状态徽标标签内容. | dict with keys: - - src (string; optional): - 适用于`'image'`模式，图片资源地址. - - height (string | number; optional): 适用于`'image'`模式，图片高度. - preview (boolean; optional): - 适用于`'image'`模式，图片是否可交互预览 默认值：`True`. | dict with keys: + 适用于`'image'`模式，图片是否可交互预览 默认值：`True`. - - placement (a value equal to: 'top-left', 'top-right', 'bottom-left', 'bottom-right'; optional): - 适用于`'corner-mark'`模式，角标显示方位，可选项有`'top-left'`、`'top-right'`、`'bottom-left'`、`'bottom-right'`. + - src (string; optional): + 适用于`'image'`模式，图片资源地址. | dict with keys: - color (string; optional): 适用于`'corner-mark'`模式，角标颜色 默认值：`'#1890ff'`. @@ -281,41 +278,44 @@ class AntdTable(Component): - content (number | string; optional): 适用于`'corner-mark'`模式，单元格数值内容. + - hide (boolean; optional): + 适用于`'corner-mark'`模式，是否隐藏当前角标 默认值：`False`. + - offsetX (number; optional): 适用于`'corner-mark'`模式，角标水平方向像素偏移量. - offsetY (number; optional): 适用于`'corner-mark'`模式，角标竖直方向像素偏移量. - - hide (boolean; optional): - 适用于`'corner-mark'`模式，是否隐藏当前角标 默认值：`False`. | dict with keys: + - placement (a value equal to: 'top-left', 'top-right', 'bottom-left', 'bottom-right'; optional): + 适用于`'corner-mark'`模式，角标显示方位，可选项有`'top-left'`、`'top-right'`、`'bottom-left'`、`'bottom-right'`. | dict with keys: - checked (boolean; optional): 适用于`'checkbox'`模式，当前勾选框状态. + - custom (boolean | number | string | dict | list; optional): + 适用于`'checkbox'`模式，额外补充信息. + - disabled (boolean; optional): 适用于`'checkbox'`模式，是否禁用当前勾选框. - label (string; optional): - 适用于`'checkbox'`模式，当前勾选框标签内容. - - - custom (boolean | number | string | dict | list; optional): - 适用于`'checkbox'`模式，额外补充信息. | dict with keys: + 适用于`'checkbox'`模式，当前勾选框标签内容. | dict with keys: - checked (boolean; optional): 适用于`'switch'`模式，当前开关状态. - - disabled (boolean; optional): - 适用于`'switch'`模式，是否禁用当前开关. - - checkedChildren (string; optional): 适用于`'switch'`模式，“开”状态标签内容. - - unCheckedChildren (string; optional): - 适用于`'switch'`模式，“关”状态标签内容. - - custom (boolean | number | string | dict | list; optional): - 适用于`'switch'`模式，额外补充信息. | dict with keys: + 适用于`'switch'`模式，额外补充信息. + + - disabled (boolean; optional): + 适用于`'switch'`模式，是否禁用当前开关. + + - unCheckedChildren (string; optional): + 适用于`'switch'`模式，“关”状态标签内容. | dict with keys: - content (number | string; optional): 适用于`'row-merge'`模式，单元格数值内容. @@ -323,8 +323,8 @@ class AntdTable(Component): - rowSpan (number; optional): 适用于`'row-merge'`模式，从当前单元格开始，向后合并的其他单元格数量. | list of dicts with keys: - - title (string; optional): - 适用于`'dropdown'`模式，当前下拉菜单项锚点内容. + - custom (boolean | number | string | dict | list; optional): + 适用于`'dropdown'`模式，额外补充信息. - disabled (boolean; optional): 适用于`'dropdown'`模式，是否禁用当前下拉菜单项. @@ -335,21 +335,18 @@ class AntdTable(Component): - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): 适用于`'dropdown'`模式，当前按钮前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. - - custom (boolean | number | string | dict | list; optional): - 适用于`'dropdown'`模式，额外补充信息. - - isDivider (boolean; optional): - 适用于`'dropdown'`模式，当前项是否渲染为分割线 默认值：`False`. | list of dicts with keys: + 适用于`'dropdown'`模式，当前项是否渲染为分割线 默认值：`False`. - title (string; optional): - 适用于`'dropdown-links'`模式，当前下拉菜单项锚点内容. - - - href (string; optional): - 适用于`'dropdown-links'`模式，当前下拉菜单项链接地址. + 适用于`'dropdown'`模式，当前下拉菜单项锚点内容. | list of dicts with keys: - disabled (boolean; optional): 适用于`'dropdown-links'`模式，是否禁用当前下拉菜单项. + - href (string; optional): + 适用于`'dropdown-links'`模式，当前下拉菜单项链接地址. + - icon (string; optional): 适用于`'dropdown-links'`模式，当前按钮前缀图标类型，`iconRenderer`为`'AntdIcon'`时同`AntdIcon`同名参数，`iconRenderer`为`'fontawesome'`时为css类名. @@ -357,10 +354,14 @@ class AntdTable(Component): 适用于`'dropdown-links'`模式，当前按钮前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. - isDivider (boolean; optional): - 适用于`'dropdown-links'`模式，当前项是否渲染为分割线 默认值：`False`. | dict with keys: + 适用于`'dropdown-links'`模式，当前项是否渲染为分割线 默认值：`False`. - - src (string; optional): - 适用于`'image-avatar'`模式，头像图片资源链接. + - title (string; optional): + 适用于`'dropdown-links'`模式，当前下拉菜单项锚点内容. | dict with keys: + + - shape (a value equal to: 'circle', 'square'; optional): + 适用于`'image-avatar'`模式，头像形状，可选项有`'circle'`、`'square'` + 默认值：`'circle'`. - size (dict; optional): 适用于`'image-avatar'`模式，头像尺寸规格，传入数值型时表示像素大小，传入字符型时可使用内置尺寸规格，可选项有`'small'`、`'default'`、`'large'`，支持响应式 @@ -369,27 +370,45 @@ class AntdTable(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'; optional): - 适用于`'image-avatar'`模式，头像形状，可选项有`'circle'`、`'square'` - 默认值：`'circle'`. | dict with keys: + - src (string; optional): + 适用于`'image-avatar'`模式，头像图片资源链接. | dict with keys: + + - allowClear (boolean; optional): + 适用于`'select'`模式，是否允许快捷清空已选项 默认值：`True`. + + - bordered (boolean; optional): + 适用于`'select'`模式，是否渲染边框 默认值：`True`. - className (string; optional): 适用于`'select'`模式，下拉选择css类名. - - style (dict; optional): - 适用于`'select'`模式，下拉选择css样式，其中`width`默认为`'100%'`. + - disabled (boolean; optional): + 适用于`'select'`模式，是否禁用当前下拉选择. + + - listHeight (number; optional): + 适用于`'select'`模式，下拉选择菜单像素高度 默认值：`256`. + + - maxTagCount (number | a value equal to: 'responsive'; optional): + 适用于`'select'`模式，最多显示的已选中选项数量，超出部分将会自动省略 默认值：`5`. + + - mode (a value equal to: 'multiple', 'tags'; optional): + 适用于`'select'`模式，选择模式，可选项有`'multiple'`、`'tags'`，默认为单选模式. + + - optionFilterProp (a value equal to: 'value', 'label'; optional): + 适用于`'select'`模式，选择框内搜索对应的目标字段，可选项有`'value'`、`'label'` + 默认值：`'value'`. - options (list of dicts; optional): 适用于`'select'`模式，定义下拉选择选项. @@ -404,22 +423,6 @@ class AntdTable(Component): 当前选项值. - - listHeight (number; optional): - 适用于`'select'`模式，下拉选择菜单像素高度 默认值：`256`. - - - mode (a value equal to: 'multiple', 'tags'; optional): - 适用于`'select'`模式，选择模式，可选项有`'multiple'`、`'tags'`，默认为单选模式. - - - disabled (boolean; optional): - 适用于`'select'`模式，是否禁用当前下拉选择. - - - size (a value equal to: 'small', 'middle', 'large'; optional): - 适用于`'select'`模式，下拉选择尺寸规格，可选项有`'small'`、`'middle'`、`'large'` - 默认值：`'middle'`. - - - bordered (boolean; optional): - 适用于`'select'`模式，是否渲染边框 默认值：`True`. - - placeholder (string; optional): 适用于`'select'`模式，选择框占位内容. @@ -427,18 +430,15 @@ class AntdTable(Component): 适用于`'select'`模式，下拉菜单展开方向，可选项有`'bottomLeft'`、`'bottomRight'`、`'topLeft'`、`'topRight'` 默认值：`'bottomLeft'`. - - value (string | number | list of string | numbers; optional): - 适用于`'select'`模式，下拉选择已选中值. - - - maxTagCount (number | a value equal to: 'responsive'; optional): - 适用于`'select'`模式，最多显示的已选中选项数量，超出部分将会自动省略 默认值：`5`. + - size (a value equal to: 'small', 'middle', 'large'; optional): + 适用于`'select'`模式，下拉选择尺寸规格，可选项有`'small'`、`'middle'`、`'large'` + 默认值：`'middle'`. - - optionFilterProp (a value equal to: 'value', 'label'; optional): - 适用于`'select'`模式，选择框内搜索对应的目标字段，可选项有`'value'`、`'label'` - 默认值：`'value'`. + - style (dict; optional): + 适用于`'select'`模式，下拉选择css样式，其中`width`默认为`'100%'`. - - allowClear (boolean; optional): - 适用于`'select'`模式，是否允许快捷清空已选项 默认值：`True`. | dict + - value (string | number | list of string | numbers; optional): + 适用于`'select'`模式，下拉选择已选中值. | dict - bordered (boolean; default False): 是否渲染框线 默认值：`False`. @@ -506,18 +506,18 @@ class AntdTable(Component): `titlePopoverInfo` is a dict with strings as keys and values of type dict with keys: - - title (string; optional): - 气泡卡片标题. - - content (string; optional): 气泡卡片内容. + - overlayStyle (dict; optional): + 气泡卡片展开层css样式. + - placement (a value equal to: 'top', 'left', 'right', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight', 'leftTop', 'leftBottom', 'rightTop', 'rightBottom'; optional): 气泡卡片弹出方位，可选项有`'top'`、`'left'`、`'right'`、`'bottom'`、`'topLeft'`、`'topRight'`、`'bottomLeft'`、`'bottomRight'`、`'leftTop'`、`'leftBottom'`、`'rightTop'`、`'rightBottom'` 默认值：`'bottom'`. - - overlayStyle (dict; optional): - 气泡卡片展开层css样式. + - title (string; optional): + 气泡卡片标题. - columnsFormatConstraint (dict; optional): 针对开启了可编辑模式的字段，配置基于正则表达式的输入内容格式校验约束规则. @@ -525,29 +525,29 @@ class AntdTable(Component): `columnsFormatConstraint` is a dict with strings as keys and values of type dict with keys: - - rule (string; optional): - 正则表达式，用于校验输入内容是否符合格式要求. - - content (string; optional): 用户输入内容校验失败时的提示说明信息. + - rule (string; optional): + 正则表达式，用于校验输入内容是否符合格式要求. + - sortOptions (dict; optional): 配置表格字段排序相关功能. `sortOptions` is a dict with keys: - - sortDataIndexes (list of strings; optional): - 参与排序的若干字段`dataIndex`数组，多字段组合排序时，数组顺序即为组合排序优先级顺序，由高到低. + - customOrders (dict with strings as keys and values of type list; optional): + 当`forceCompareModes`为`'custom'`时，用于为相应字段设置自定义排序对应的元素顺序. + + - forceCompareModes (dict with strings as keys and values of type a value equal to: 'number', 'custom'; optional): + 为各字段指定排序比较模式，可选项有`'number'`（强制数值型排序）、`'custom'`（自定义排序）. - multiple (boolean | a value equal to: 'auto'; optional): 是否启用多字段组合排序，当设置为`'auto'`时表示自动组合排序，此时组合排序的字段优先级顺序与用户依次点击排序字段的顺序对应 默认值：`False``. - - forceCompareModes (dict with strings as keys and values of type a value equal to: 'number', 'custom'; optional): - 为各字段指定排序比较模式，可选项有`'number'`（强制数值型排序）、`'custom'`（自定义排序）. - - - customOrders (dict with strings as keys and values of type list; optional): - 当`forceCompareModes`为`'custom'`时，用于为相应字段设置自定义排序对应的元素顺序. + - sortDataIndexes (list of strings; optional): + 参与排序的若干字段`dataIndex`数组，多字段组合排序时，数组顺序即为组合排序优先级顺序，由高到低. - showSorterTooltip (boolean; default True): 针对可排序字段是否在鼠标移入表头后展示额外信息提示 默认值：`True`. @@ -562,16 +562,16 @@ class AntdTable(Component): `filterOptions` is a dict with strings as keys and values of type dict with keys: - - filterMode (a value equal to: 'checkbox', 'keyword', 'tree'; optional): - 筛选模式，可选项有`'checkbox'`、`'keyword'`、`'tree'`，其中`'tree'`模式需要依赖相应的`'filterCustomTreeItems'`参数进行自定义树形菜单结构的构造 - 默认值：`'checkbox'`. - - filterCustomItems (list | boolean | number | string | dict | list; optional): `filterMode`为`'checkbox'`时，用于自定义筛选菜单项. - filterCustomTreeItems (list of dicts; optional): `filterMode`为`'tree'`时，用于构造自定义树形菜单结构. + - filterMode (a value equal to: 'checkbox', 'keyword', 'tree'; optional): + 筛选模式，可选项有`'checkbox'`、`'keyword'`、`'tree'`，其中`'tree'`模式需要依赖相应的`'filterCustomTreeItems'`参数进行自定义树形菜单结构的构造 + 默认值：`'checkbox'`. + - filterMultiple (boolean; optional): `filterMode`为`'checkbox'`时，是否开启多选模式 默认值：`True`. @@ -586,51 +586,51 @@ class AntdTable(Component): `pagination` is a dict with keys: + - current (number; optional): + 监听或设置当前页码. + + - disabled (boolean; optional): + 是否禁用分页相关控件 默认值：`False`. + + - hideOnSinglePage (boolean; optional): + 是否在数据行数量不足一页时，自动隐藏分页相关控件 默认值：`False`. + + - pageSize (number; optional): + 监听或设置每页允许显示的最大行记录数量. + + - pageSizeOptions (list of numbers; optional): + `pageSize`切换控件的可选项. + - position (a value equal to: 'topLeft', 'topCenter', 'topRight', 'bottomLeft', 'bottomCenter', 'bottomRight'; optional): 分页组件渲染方位，可选项有`'topLeft'`、`'topCenter'`、`'topRight'`、`'bottomLeft'`、`'bottomCenter'`、`'bottomRight'` 默认值：`'bottomRight'`. - - pageSize (number; optional): - 监听或设置每页允许显示的最大行记录数量. + - showLessItems (boolean; optional): + 是否优先展示较少的跳页项 默认值：`False`. - - current (number; optional): - 监听或设置当前页码. + - showQuickJumper (boolean; optional): + 是否渲染快捷跳页控件 默认值：`False`. - showSizeChanger (boolean; optional): 是否显示`pageSize`切换控件，当表格总记录数量大于50时默认为`True`. - - pageSizeOptions (list of numbers; optional): - `pageSize`切换控件的可选项. - - showTitle (boolean; optional): 各页码在鼠标移入时，是否显示浏览器原生提示信息 默认值：`True`. - - showQuickJumper (boolean; optional): - 是否渲染快捷跳页控件 默认值：`False`. - - showTotalPrefix (string; optional): 总记录描述文案前缀文字. - showTotalSuffix (string; optional): 总记录描述文案后缀文字. - - hideOnSinglePage (boolean; optional): - 是否在数据行数量不足一页时，自动隐藏分页相关控件 默认值：`False`. - - simple (boolean; optional): 是否开启简洁模式 默认值：`False`. - - disabled (boolean; optional): - 是否禁用分页相关控件 默认值：`False`. - - size (a value equal to: 'default', 'small'; optional): 分页控件尺寸规格，可选项有`'small'`、`'default'` 默认值：`'default'`. - total (number; optional): - 手动设置总记录数量，通常配合[服务端数据加载模式](/AntdTable-server-side-mode)使用. - - - showLessItems (boolean; optional): - 是否优先展示较少的跳页项 默认值：`False`. | boolean + 手动设置总记录数量，通常配合[服务端数据加载模式](/AntdTable-server-side-mode)使用. | boolean - currentData (list; optional): 监听经过编辑修改操作后，最新状态下的表格数据源. @@ -664,14 +664,14 @@ class AntdTable(Component): `summaryRowContents` is a list of dicts with keys: - - content (a list of or a singular dash component, string or number; optional): - 组件型，当前总结栏单元格内容. + - align (a value equal to: 'left', 'center', 'right'; optional): + 当前总结栏列对齐方式，可选项有`'left'`、`'center'`、`'right'`. - colSpan (number; optional): 当前总结栏单元格横跨占据的字段数量 默认值：`1`. - - align (a value equal to: 'left', 'center', 'right'; optional): - 当前总结栏列对齐方式，可选项有`'left'`、`'center'`、`'right'`. + - content (a list of or a singular dash component, string or number; optional): + 组件型，当前总结栏单元格内容. - summaryRowBlankColumns (number; default 0): 总结栏每行用于占位的列数，适用于同时使用行选择等功能的场景 默认值：`0`. @@ -687,10 +687,10 @@ class AntdTable(Component): `expandedRowKeyToContent` is a list of dicts with keys: - - key (string | number; required) - - content (a list of or a singular dash component, string or number; optional) + - key (string | number; required) + - expandedRowWidth (string | number; optional): 行展开控件所在列宽度. @@ -720,18 +720,18 @@ class AntdTable(Component): `cellClickEvent` is a dict with keys: - - pageX (number; optional): - 以页面整体左上角为原点，记录x坐标. - - - pageY (number; optional): - 以页面整体左上角为原点，记录y坐标. - - clientX (number; optional): 以浏览器窗口左上角为原点，记录x坐标. - clientY (number; optional): 以浏览器窗口左上角为原点，记录y坐标. + - pageX (number; optional): + 以页面整体左上角为原点，记录x坐标. + + - pageY (number; optional): + 以页面整体左上角为原点，记录y坐标. + - screenX (number; optional): 以屏幕左上角为原点，记录x坐标. @@ -755,18 +755,18 @@ class AntdTable(Component): `cellDoubleClickEvent` is a dict with keys: - - pageX (number; optional): - 以页面整体左上角为原点，记录x坐标. - - - pageY (number; optional): - 以页面整体左上角为原点，记录y坐标. - - clientX (number; optional): 以浏览器窗口左上角为原点，记录x坐标. - clientY (number; optional): 以浏览器窗口左上角为原点，记录y坐标. + - pageX (number; optional): + 以页面整体左上角为原点，记录x坐标. + + - pageY (number; optional): + 以页面整体左上角为原点，记录y坐标. + - screenX (number; optional): 以屏幕左上角为原点，记录x坐标. @@ -790,18 +790,18 @@ class AntdTable(Component): `cellContextMenuClickEvent` is a dict with keys: - - pageX (number; optional): - 以页面整体左上角为原点，记录x坐标. - - - pageY (number; optional): - 以页面整体左上角为原点，记录y坐标. - - clientX (number; optional): 以浏览器窗口左上角为原点，记录x坐标. - clientY (number; optional): 以浏览器窗口左上角为原点，记录y坐标. + - pageX (number; optional): + 以页面整体左上角为原点，记录x坐标. + + - pageY (number; optional): + 以页面整体左上角为原点，记录y坐标. + - screenX (number; optional): 以屏幕左上角为原点，记录x坐标. @@ -909,14 +909,14 @@ class AntdTable(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 = ['columns[].title', 'data[]{}', 'summaryRowContents[].content', 'expandedRowKeyToContent[].content', 'emptyContent', 'title', 'footer'] _base_nodes = ['emptyContent', 'title', 'footer', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdTabs.py b/feffery_antd_components/AntdTabs.py index 898db4dc..3e7e07f9 100644 --- a/feffery_antd_components/AntdTabs.py +++ b/feffery_antd_components/AntdTabs.py @@ -29,34 +29,27 @@ class AntdTabs(Component): `items` is a list of dicts with keys: - - label (a list of or a singular dash component, string or number; optional): - 组件型，标签页标题. - - - key (string; optional): - 标签页唯一识别id. - - children (a list of or a singular dash component, string or number; optional): 组件型，标签页内部元素. + - closable (boolean; optional): + `'editable-card'`型标签页可用，控制当前标签页是否可被关闭 默认值：`True`. + - closeIcon (boolean | a list of or a singular dash component, string or number; optional): `'editable-card'`型标签页可用，用于自定义关闭按钮，设置为`None`或`False`时会隐藏默认的关闭按钮. - - destroyInactiveTabPane (boolean; optional): - 是否在当前标签页隐藏时，自动销毁当前标签页内部元素 默认值：`False`. + - contextMenu (list of dicts; optional): + 为当前标签页标题配置右键菜单相关参数. - - disabled (boolean; optional): - 是否禁用当前标签页 默认值：`False`. + `contextMenu` is a list of dicts with keys: - - forceRender (boolean; optional): - 初始化是否强制渲染当前标签页内部元素 默认值：`False`. + - icon (string; optional): - - closable (boolean; optional): - `'editable-card'`型标签页可用，控制当前标签页是否可被关闭 默认值：`True`. + 当前右键菜单项前缀图标类型，`iconRenderer`为`'AntdIcon'`时同`AntdIcon`同名参数，`iconRenderer`为`'fontawesome'`时为css类名. - - contextMenu (list of dicts; optional): - 为当前标签页标题配置右键菜单相关参数. + - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): - `contextMenu` is a list of dicts with keys: + 当前右键菜单项前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. - key (string; optional): @@ -66,13 +59,20 @@ class AntdTabs(Component): 当前右键菜单项标题. - - icon (string; optional): + - destroyInactiveTabPane (boolean; optional): + 是否在当前标签页隐藏时，自动销毁当前标签页内部元素 默认值：`False`. - 当前右键菜单项前缀图标类型，`iconRenderer`为`'AntdIcon'`时同`AntdIcon`同名参数，`iconRenderer`为`'fontawesome'`时为css类名. + - disabled (boolean; optional): + 是否禁用当前标签页 默认值：`False`. - - iconRenderer (a value equal to: 'AntdIcon', 'fontawesome'; optional): + - forceRender (boolean; optional): + 初始化是否强制渲染当前标签页内部元素 默认值：`False`. - 当前右键菜单项前缀图标渲染方式，可选项有`'AntdIcon'`、`'fontawesome'`. + - key (string; optional): + 标签页唯一识别id. + + - label (a list of or a singular dash component, string or number; optional): + 组件型，标签页标题. - itemKeys (list of strings; optional): 监听当前各标签页`key`值，顺序与`items`一致. @@ -101,12 +101,12 @@ class AntdTabs(Component): `indicator` is a dict with keys: - - size (number; optional): - 指示条像素宽度，当传入负数时，表示在完整宽度基础上应减去的像素宽度，默认与标签卡片同宽. - - align (a value equal to: 'start', 'center', 'end'; optional): 指示条对齐方式，可选项有`'start'`、`'center'`、`'end'`. + - size (number; optional): + 指示条像素宽度，当传入负数时，表示在完整宽度基础上应减去的像素宽度，默认与标签卡片同宽. + - tabBarGutter (number; optional): 标签卡片之间的像素间距. @@ -139,12 +139,12 @@ class AntdTabs(Component): `clickedContextMenu` is a dict with keys: - - tabKey (string; optional): - 被点击的右键菜单项对应标签页`key`值. - - menuKey (string; optional): 被点击的右键菜单项对应`key`值. + - tabKey (string; optional): + 被点击的右键菜单项对应标签页`key`值. + - timestamp (number; optional): 事件对应时间戳信息. @@ -158,15 +158,15 @@ class AntdTabs(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTag.py b/feffery_antd_components/AntdTag.py index c8369df0..e4b48e14 100644 --- a/feffery_antd_components/AntdTag.py +++ b/feffery_antd_components/AntdTag.py @@ -55,14 +55,14 @@ class AntdTag(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 = ['content', 'icon'] _base_nodes = ['content', 'icon', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdText.py b/feffery_antd_components/AntdText.py index 0cb28f12..c5d626d9 100644 --- a/feffery_antd_components/AntdText.py +++ b/feffery_antd_components/AntdText.py @@ -76,14 +76,14 @@ class AntdText(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/AntdTimePicker.py b/feffery_antd_components/AntdTimePicker.py index ab13d401..2db57e6d 100644 --- a/feffery_antd_components/AntdTimePicker.py +++ b/feffery_antd_components/AntdTimePicker.py @@ -114,15 +114,15 @@ class AntdTimePicker(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTimeRangePicker.py b/feffery_antd_components/AntdTimeRangePicker.py index bf5e6e96..563c3287 100644 --- a/feffery_antd_components/AntdTimeRangePicker.py +++ b/feffery_antd_components/AntdTimeRangePicker.py @@ -114,15 +114,15 @@ class AntdTimeRangePicker(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTimeline.py b/feffery_antd_components/AntdTimeline.py index 40787d39..f4061c28 100644 --- a/feffery_antd_components/AntdTimeline.py +++ b/feffery_antd_components/AntdTimeline.py @@ -26,12 +26,12 @@ class AntdTimeline(Component): `items` is a list of dicts with keys: - - content (a list of or a singular dash component, string or number; optional): - 组件型，当前节点正文内容. - - color (string; optional): 当前节点颜色，可用于表达节点状态，常用方案有`'blue'`（进行中或默认状态）、`'green'`（已完成状态）、`'red'`（警告或错误状态）、`'grey'`（未完成或失效状态）. + - content (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): 组件型，自定义作为图标的元素. @@ -63,14 +63,14 @@ class AntdTimeline(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[].content', 'items[].icon', 'items[].label', 'pending', 'pendingDot'] _base_nodes = ['pending', 'pendingDot', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdTitle.py b/feffery_antd_components/AntdTitle.py index 13186afa..f0ecea6a 100644 --- a/feffery_antd_components/AntdTitle.py +++ b/feffery_antd_components/AntdTitle.py @@ -71,14 +71,14 @@ class AntdTitle(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/AntdTooltip.py b/feffery_antd_components/AntdTooltip.py index 886ca7a4..86c21f28 100644 --- a/feffery_antd_components/AntdTooltip.py +++ b/feffery_antd_components/AntdTooltip.py @@ -80,14 +80,14 @@ class AntdTooltip(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 = ['title'] _base_nodes = ['title', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdTour.py b/feffery_antd_components/AntdTour.py index 05198eaa..a17ae94b 100644 --- a/feffery_antd_components/AntdTour.py +++ b/feffery_antd_components/AntdTour.py @@ -30,12 +30,6 @@ class AntdTour(Component): `steps` is a list of dicts with keys: - - targetId (string; optional): - 当前步骤目标元素id，优先级高于`targetSelector`. - - - targetSelector (string; optional): - 定位当前步骤目标元素的javascript代码字符串. - - arrow (dict; optional): 配置当前步骤箭头 默认值：`True`. @@ -50,30 +44,21 @@ class AntdTour(Component): - 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): - 组件型，当前步骤弹框的标题内容. - - 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'`. - - mask (dict; optional): 配置当前步骤蒙版层 默认值：`True`. `mask` is a boolean | dict with keys: - - style (dict; optional): - - 当前步骤蒙版层css样式. - - color (string; optional): 当前步骤蒙版层颜色. - - type (a value equal to: 'default', 'primary'; optional): - 当前步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`. + - style (dict; optional): + + 当前步骤蒙版层css样式. - nextButtonProps (dict; optional): 配置当前步骤下一步按钮. @@ -83,6 +68,9 @@ class AntdTour(Component): - children (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'`. + - prevButtonProps (dict; optional): 配置当前步骤上一步按钮. @@ -91,6 +79,18 @@ class AntdTour(Component): - children (a list of or a singular dash component, string or number; optional): 组件型，按钮内嵌元素. + - targetId (string; optional): + 当前步骤目标元素id，优先级高于`targetSelector`. + + - targetSelector (string; optional): + 定位当前步骤目标元素的javascript代码字符串. + + - title (a list of or a singular dash component, string or number; optional): + 组件型，当前步骤弹框的标题内容. + + - type (a value equal to: 'default', 'primary'; optional): + 当前步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`. + - arrow (dict; default True): 统一配置引导步骤弹框箭头 默认值：`True`. @@ -108,12 +108,12 @@ class AntdTour(Component): `mask` is a boolean | dict with keys: - - style (dict; optional): - 蒙版层css样式. - - color (string; optional): 蒙版层颜色. + - style (dict; optional): + 蒙版层css样式. + - type (a value equal to: 'default', 'primary'; default 'default'): 统一设置引导步骤弹框类型，可选项有`'default'`、`'primary'` 默认值：`'default'`. @@ -136,14 +136,14 @@ class AntdTour(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 = ['steps[].cover', 'steps[].title', 'steps[].description', 'steps[].nextButtonProps.children', 'steps[].prevButtonProps.children'] _base_nodes = ['children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdTransfer.py b/feffery_antd_components/AntdTransfer.py index 11b8b4e8..de333942 100644 --- a/feffery_antd_components/AntdTransfer.py +++ b/feffery_antd_components/AntdTransfer.py @@ -33,15 +33,15 @@ class AntdTransfer(Component): `dataSource` is a list of dicts with keys: + - disabled (boolean; optional): + 是否禁用当前选项 默认值：`False`. + - key (string | number; optional): 当前选项唯一识别id. - title (a list of or a singular dash component, string or number; optional): 组件型，当前选项标题内容. - - disabled (boolean; optional): - 是否禁用当前选项 默认值：`False`. - - selectionsIcon (a list of or a singular dash component, string or number; optional): 组件型，自定义下拉菜单图标. @@ -109,15 +109,15 @@ class AntdTransfer(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTree.py b/feffery_antd_components/AntdTree.py index 1fff8923..8d3df582 100644 --- a/feffery_antd_components/AntdTree.py +++ b/feffery_antd_components/AntdTree.py @@ -110,12 +110,12 @@ class AntdTree(Component): `clickedContextMenu` is a dict with keys: - - nodeKey (string; optional): - 事件对应节点`key`值. - - menuKey (string; optional): 事件对应右键菜单项`key`值. + - nodeKey (string; optional): + 事件对应节点`key`值. + - timestamp (number; optional): 事件对应时间戳信息. @@ -130,12 +130,12 @@ class AntdTree(Component): `scrollTarget` is a dict with keys: - - key (string; required): - 滚动目标节点`key`值. - - align (a value equal to: 'top', 'bottom', 'auto'; optional): 滚动目标节点对齐位置，可选项有`'top'`、`'bottom'`、`'auto'` 默认值：`'auto'`. + - key (string; required): + 滚动目标节点`key`值. + - offset (number; optional): 滚动后的像素偏移量. @@ -183,15 +183,15 @@ class AntdTree(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdTreeSelect.py b/feffery_antd_components/AntdTreeSelect.py index 9dd75391..fc970eaf 100644 --- a/feffery_antd_components/AntdTreeSelect.py +++ b/feffery_antd_components/AntdTreeSelect.py @@ -164,15 +164,15 @@ class AntdTreeSelect(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. - - persistence (boolean | string | number; optional): 是否开启[属性持久化](/prop-persistence). diff --git a/feffery_antd_components/AntdUpload.py b/feffery_antd_components/AntdUpload.py index b25c1302..7f27af60 100644 --- a/feffery_antd_components/AntdUpload.py +++ b/feffery_antd_components/AntdUpload.py @@ -70,24 +70,24 @@ class AntdUpload(Component): `buttonProps` is a dict with keys: - - size (a value equal to: 'default', 'small', 'large'; optional): - 按钮尺寸规格，可选项有`'default'`、`'small'`、`'large'` 默认值：`'default'`. + - block (boolean; optional): + 按钮是否撑满父元素 默认值：`False`. - - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): - 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` - 默认值：`'default'`. + - className (string; optional): + 按钮css类名. - danger (boolean; optional): 按钮是否渲染危险状态 默认值：`False`. - - block (boolean; optional): - 按钮是否撑满父元素 默认值：`False`. + - size (a value equal to: 'default', 'small', 'large'; optional): + 按钮尺寸规格，可选项有`'default'`、`'small'`、`'large'` 默认值：`'default'`. - style (dict; optional): 按钮css样式. - - className (string; optional): - 按钮css类名. + - type (a value equal to: 'primary', 'ghost', 'dashed', 'link', 'text', 'default'; optional): + 按钮类型，可选项有`'default'`、`'primary'`、`'ghost'`、`'dashed'`、`'link'`、`'text'` + 默认值：`'default'`. - uploadId (string; optional): 自定义当前组件发起文件上传请求时携带的`uploadId`参数，可用于辅助后端创建文件上传所在文件夹. @@ -118,6 +118,17 @@ class AntdUpload(Component): `progressProps` is a dict with keys: + - format (dict; optional): + 进度文字格式. + + `format` is a dict with keys: + + - prefix (string; optional): + 进度文字前缀内容. + + - suffix (string; optional): + 进度文字后缀内容 默认值：`'%'`. + - strokeColor (dict; optional): 进度条颜色. @@ -136,17 +147,6 @@ class AntdUpload(Component): - strokeWidth (number; optional): 进度条像素宽度. - - format (dict; optional): - 进度文字格式. - - `format` is a dict with keys: - - - prefix (string; optional): - 进度文字前缀内容. - - - suffix (string; optional): - 进度文字后缀内容 默认值：`'%'`. - - showSuccessMessage (boolean; default True): 是否在每个文件上传成功后，分别弹出消息提示 默认值：`True`. @@ -158,26 +158,29 @@ class AntdUpload(Component): `lastUploadTaskRecord` is a dict with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): - 当前文件的下载链接. + 当前文件的下载链接. | list of dicts with keys: - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. | list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. - fileName (string; optional): 文件名称. @@ -185,76 +188,73 @@ class AntdUpload(Component): - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. + - taskId (string; optional): + 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. - taskStatus (string; optional): 上传任务状态，`'success'`表示成功，`'failed'`表示失败. - - taskId (string; optional): - 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - uploadResponse (boolean | number | string | dict | list; optional): + 上传任务的接口响应信息. - url (string; optional): 当前文件的下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): - 上传任务的接口响应信息. - - listUploadTaskRecord (list of dicts; optional): 监听当前已上传文件列表中上传任务相关信息. `listUploadTaskRecord` is a list of dicts with keys: + - completeTimestamp (number; optional): + 上传完成时间戳. + - fileName (string; optional): 文件名称. - fileSize (number; optional): 文件大小. - - completeTimestamp (number; optional): - 上传完成时间戳. - - - taskStatus (string; optional): - 上传任务状态，`'success'`表示成功，`'failed'`表示失败. + - originFileObj (boolean | number | string | dict | list; optional): + 当`withOriginFileObj=True`时，监听当前文件上传任务对应的`originFileObj`主要信息. - taskId (string; optional): 上传任务唯一识别id，当任务状态为`'failed'`时不会携带此信息. + - taskStatus (string; optional): + 上传任务状态，`'success'`表示成功，`'failed'`表示失败. + - uid (string; optional): 当前文件上传唯一识别id，前端自动生成. - - url (string; optional): - 当前文件下载链接. - - uploadResponse (boolean | number | string | dict | list; optional): 上传任务的接口响应信息. - - originFileObj (boolean | number | string | dict | list; optional): - 当`withOriginFileObj=True`时，监听当前文件上传任务对应的`originFileObj`主要信息. + - url (string; optional): + 当前文件下载链接. - defaultFileList (list of dicts; optional): 初始化文件列表展示信息. `defaultFileList` is a list of dicts with keys: + - fileSize (number; optional): + 当前文件大小. + - name (string; optional): 当前文件名称. - status (a value equal to: 'done', 'error', 'removed'; optional): 当前文件展示状态，可选项有`'done'`、`'error'`、`'removed'`. + - taskId (string; optional): + 若传入有效值，将作为当前组件的`uploadId`参数. + - uid (boolean | number | string | dict | list; optional): 当前文件唯一识别id. - url (string; optional): 当前文件下载链接. - - taskId (string; optional): - 若传入有效值，将作为当前组件的`uploadId`参数. - - - fileSize (number; optional): - 当前文件大小. - - disabled (boolean; default False): 是否禁用当前组件 默认值：`False`. @@ -271,14 +271,14 @@ class AntdUpload(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 = ['buttonContent', 'buttonIcon'] _base_nodes = ['buttonContent', 'buttonIcon', 'children'] _namespace = 'feffery_antd_components' diff --git a/feffery_antd_components/AntdWatermark.py b/feffery_antd_components/AntdWatermark.py index c9c93088..80e16c3b 100644 --- a/feffery_antd_components/AntdWatermark.py +++ b/feffery_antd_components/AntdWatermark.py @@ -70,14 +70,14 @@ class AntdWatermark(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/Fragment.py b/feffery_antd_components/Fragment.py index b8d49561..68e28910 100644 --- a/feffery_antd_components/Fragment.py +++ b/feffery_antd_components/Fragment.py @@ -22,14 +22,14 @@ class Fragment(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/package.json b/package.json index 9a958a0f..2a72e811 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "feffery_antd_components", - "version": "0.3.5", + "version": "0.3.7", "description": "Best implementation of Antd components in Plotly Dash.", "repository": { "type": "git", diff --git a/webpack.config.js b/webpack.config.js index fbd57bc0..66786f45 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -55,8 +55,8 @@ module.exports = (env, argv) => { library: dashLibraryName, libraryTarget: 'window', }, - devtool: false, // 开发阶段使用，生成全量source-map - // devtool, // 发布阶段使用，生成最小化source-map + // devtool: false, // 开发阶段使用，生成全量source-map + devtool, // 发布阶段使用，生成最小化source-map externals, module: { rules: [