From 1f612a2caaa13056526bea41b72adf3152faf8a3 Mon Sep 17 00:00:00 2001
From: gimmyhehe <975402925@qq.com>
Date: Thu, 7 Mar 2024 14:49:21 +0800
Subject: [PATCH] docs(sites): change apis doc and hidden form menu (#1472)
---
examples/sites/demos/apis/float-button.js | 211 ++++++++++++++++++
.../app/float-button/webdoc/float-button.js | 191 ----------------
examples/sites/demos/pc/menus.js | 3 +-
3 files changed, 212 insertions(+), 193 deletions(-)
create mode 100644 examples/sites/demos/apis/float-button.js
diff --git a/examples/sites/demos/apis/float-button.js b/examples/sites/demos/apis/float-button.js
new file mode 100644
index 000000000..20aae89d4
--- /dev/null
+++ b/examples/sites/demos/apis/float-button.js
@@ -0,0 +1,211 @@
+export default {
+ mode: ['pc'],
+ apis: [
+ {
+ 'name': 'button',
+ 'type': 'component',
+ 'props': [
+ {
+ 'name': 'type',
+ 'type': 'IButtonType',
+ 'typeAnchorName': 'IButtonType',
+ 'defaultValue': '--',
+ 'desc': {
+ 'zh-CN': '展示按钮不同的状态，设置为text则展示为文本按钮',
+ 'en-US': 'Display different states of buttons, set to text to display as text buttons'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'description',
+ 'type': 'string',
+ 'defaultValue': '--',
+ 'desc': {
+ 'zh-CN': '按钮显示的文本',
+ 'en-US': 'Set the text displayed by the button'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'icon',
+ 'type': 'Component',
+ 'defaultValue': '--',
+ 'desc': {
+ 'zh-CN': '按钮展示的图标，接收为Icon组件',
+ 'en-US': 'The icon displayed by the button is received as an Icon component'
+ },
+ mode: ['pc'],
+ pcDemo: 'icon'
+ },
+ {
+ 'name': 'reset-time',
+ 'type': 'number',
+ 'defaultValue': '1000',
+ 'desc': {
+ 'zh-CN': '设置按钮禁用时间，防止重复提交，单位毫秒',
+ 'en-US': 'Set the button disable time, in milliseconds, to prevent repeated submission'
+ },
+ mode: ['pc'],
+ pcDemo: 'reset-time'
+ },
+ {
+ 'name': 'trigger',
+ 'type': 'string',
+ 'defaultValue': 'click',
+ 'desc': {
+ 'zh-CN': '设置菜单触发模式。',
+ 'en-US': 'Set the menu trigger mode.'
+ },
+ mode: ['pc'],
+ pcDemo: 'trigger'
+ },
+ {
+ 'name': 'open',
+ 'type': 'boolean',
+ 'defaultValue': false,
+ 'desc': {
+ 'zh-CN': '设置菜单是否打开。',
+ 'en-US': 'Whether the settings menu opens.'
+ },
+ mode: ['pc'],
+ pcDemo: 'trigger'
+ },
+ {
+ 'name': 'shape',
+ 'type': "'circle'|'square'",
+ 'defaultValue': 'circle',
+ 'desc': {
+ 'zh-CN': '设置按钮形状。',
+ 'en-US': 'Set Button shape.'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'backTop',
+ 'type': 'boolean',
+ 'defaultValue': false,
+ 'desc': {
+ 'zh-CN': '设置是否是回到顶部按钮。',
+ 'en-US': 'Set whether it is a back-to-top button.'
+ },
+ mode: ['pc'],
+ pcDemo: 'backTop'
+ },
+
+ {
+ 'name': 'element',
+ 'type': 'HTMLElement',
+ 'defaultValue': 'document.body',
+ 'desc': {
+ 'zh-CN': '当backTop设置为true时，此属性设置滚动元素。',
+ 'en-US': 'When backTop is set to true, this property sets the scrolling element.'
+ },
+ mode: ['pc'],
+ pcDemo: 'backTop'
+ },
+ {
+ 'name': 'top',
+ 'type': 'string',
+ 'defaultValue': '',
+ 'desc': {
+ 'zh-CN': '按钮与顶部的距离。',
+ 'en-US': 'The distance of the button from the top.'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'bottom',
+ 'type': 'string',
+ 'defaultValue': '20px',
+ 'desc': {
+ 'zh-CN': '按钮与底部的距离。',
+ 'en-US': 'The distance of the button from the bottom.'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'left',
+ 'type': 'string',
+ 'defaultValue': '',
+ 'desc': {
+ 'zh-CN': '按钮与左边的距离。',
+ 'en-US': 'The distance of the button from the left.'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'right',
+ 'type': 'string',
+ 'defaultValue': '20px',
+ 'desc': {
+ 'zh-CN': '按钮与右边的距离。',
+ 'en-US': 'The distance of the button from the right.'
+ },
+ mode: ['pc'],
+ pcDemo: 'basic-usage'
+ },
+ {
+ 'name': 'href',
+ 'type': 'string',
+ 'defaultValue': '',
+ 'desc': {
+ 'zh-CN': '按钮点击后跳转的页面。',
+ 'en-US': 'button to jump to the page.'
+ },
+ mode: ['pc'],
+ pcDemo: 'jump'
+ },
+ {
+ 'name': 'target',
+ 'type': 'string',
+ 'defaultValue': '',
+ 'desc': {
+ 'zh-CN': '相当于a 标签的 target 属性，href 存在时生效。',
+ 'en-US': 'The target attribute equivalent to the A tag, which takes effect when the href exists.'
+ },
+ mode: ['pc'],
+ pcDemo: 'jump'
+ }
+ ],
+ 'events': [
+ {
+ 'name': 'click',
+ 'type': '(event: PointEvent) => void',
+ 'defaultValue': '--',
+ 'desc': {
+ 'zh-CN': '当按钮被点击时触发的回调函数',
+ 'en-US': 'Sets the callback function triggered when a button is clicked'
+ },
+ mode: ['pc'],
+ pcDemo: 'click'
+ }
+ ],
+ 'slots': [
+ {
+ 'name': 'default',
+ 'type': '',
+ 'defaultValue': '--',
+ 'desc': {
+ 'zh-CN': '默认插槽，自定义按钮展开时的内容',
+ 'en-US': 'Default slot, customize what the button is when expanded'
+ },
+ mode: ['pc'],
+ pcDemo: 'open'
+ }
+ ]
+ }
+ ],
+ types: [
+ {
+ name: 'IButtonType',
+ type: 'interface',
+ code: `type IButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'`
+ }
+ ]
+}
diff --git a/examples/sites/demos/pc/app/float-button/webdoc/float-button.js b/examples/sites/demos/pc/app/float-button/webdoc/float-button.js
index 16b624660..63ff0d582 100644
--- a/examples/sites/demos/pc/app/float-button/webdoc/float-button.js
+++ b/examples/sites/demos/pc/app/float-button/webdoc/float-button.js
@@ -64,196 +64,5 @@ export default {
},
'codeFiles': ['jump.vue']
}
- ],
- apis: [
- {
- 'name': 'button',
- 'type': 'component',
- 'props': [
- {
- 'name': 'type',
- 'type': 'IButtonType',
- 'typeAnchorName': 'IButtonType',
- 'defaultValue': '--',
- 'desc': {
- 'zh-CN': '展示按钮不同的状态，设置为text则展示为文本按钮',
- 'en-US': 'Display different states of buttons, set to text to display as text buttons'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'description',
- 'type': 'string',
- 'defaultValue': '--',
- 'desc': {
- 'zh-CN': '按钮显示的文本',
- 'en-US': 'Set the text displayed by the button'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'icon',
- 'type': 'Component',
- 'defaultValue': '--',
- 'desc': {
- 'zh-CN': '按钮展示的图标，接收为Icon组件',
- 'en-US': 'The icon displayed by the button is received as an Icon component'
- },
- 'demoId': 'icon'
- },
- {
- 'name': 'reset-time',
- 'type': 'number',
- 'defaultValue': '1000',
- 'desc': {
- 'zh-CN': '设置按钮禁用时间，防止重复提交，单位毫秒',
- 'en-US': 'Set the button disable time, in milliseconds, to prevent repeated submission'
- },
- 'demoId': 'reset-time'
- },
- {
- 'name': 'trigger',
- 'type': 'string',
- 'defaultValue': 'click',
- 'desc': {
- 'zh-CN': '设置菜单触发模式。',
- 'en-US': 'Set the menu trigger mode.'
- },
- 'demoId': 'trigger'
- },
- {
- 'name': 'open',
- 'type': 'boolean',
- 'defaultValue': false,
- 'desc': {
- 'zh-CN': '设置菜单是否打开。',
- 'en-US': 'Whether the settings menu opens.'
- },
- 'demoId': 'trigger'
- },
- {
- 'name': 'shape',
- 'type': "'circle'|'square'",
- 'defaultValue': 'circle',
- 'desc': {
- 'zh-CN': '设置按钮形状。',
- 'en-US': 'Set Button shape.'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'backTop',
- 'type': 'boolean',
- 'defaultValue': false,
- 'desc': {
- 'zh-CN': '设置是否是回到顶部按钮。',
- 'en-US': 'Set whether it is a back-to-top button.'
- },
- 'demoId': 'backTop'
- },
-
- {
- 'name': 'element',
- 'type': 'HTMLElement',
- 'defaultValue': 'document.body',
- 'desc': {
- 'zh-CN': '当backTop设置为true时，此属性设置滚动元素。',
- 'en-US': 'When backTop is set to true, this property sets the scrolling element.'
- },
- 'demoId': 'backTop'
- },
- {
- 'name': 'top',
- 'type': 'string',
- 'defaultValue': '',
- 'desc': {
- 'zh-CN': '按钮与顶部的距离。',
- 'en-US': 'The distance of the button from the top.'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'bottom',
- 'type': 'string',
- 'defaultValue': '20px',
- 'desc': {
- 'zh-CN': '按钮与底部的距离。',
- 'en-US': 'The distance of the button from the bottom.'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'left',
- 'type': 'string',
- 'defaultValue': '',
- 'desc': {
- 'zh-CN': '按钮与左边的距离。',
- 'en-US': 'The distance of the button from the left.'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'right',
- 'type': 'string',
- 'defaultValue': '20px',
- 'desc': {
- 'zh-CN': '按钮与右边的距离。',
- 'en-US': 'The distance of the button from the right.'
- },
- 'demoId': 'basic-usage'
- },
- {
- 'name': 'href',
- 'type': 'string',
- 'defaultValue': '',
- 'desc': {
- 'zh-CN': '按钮点击后跳转的页面。',
- 'en-US': 'button to jump to the page.'
- },
- 'demoId': 'jump'
- },
- {
- 'name': 'target',
- 'type': 'string',
- 'defaultValue': '',
- 'desc': {
- 'zh-CN': '相当于a 标签的 target 属性，href 存在时生效。',
- 'en-US': 'The target attribute equivalent to the A tag, which takes effect when the href exists.'
- },
- 'demoId': 'jump'
- }
- ],
- 'events': [
- {
- 'name': 'click',
- 'type': '(event: PointEvent) => void',
- 'defaultValue': '--',
- 'desc': {
- 'zh-CN': '当按钮被点击时触发的回调函数',
- 'en-US': 'Sets the callback function triggered when a button is clicked'
- },
- 'demoId': 'click'
- }
- ],
- 'slots': [
- {
- 'name': 'default',
- 'type': '',
- 'defaultValue': '--',
- 'desc': {
- 'zh-CN': '默认插槽，自定义按钮展开时的内容',
- 'en-US': 'Default slot, customize what the button is when expanded'
- },
- 'demoId': 'open'
- }
- ]
- }
- ],
- types: [
- {
- name: 'IButtonType',
- type: 'interface',
- code: `type IButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'`
- }
]
}
diff --git a/examples/sites/demos/pc/menus.js b/examples/sites/demos/pc/menus.js
index b820812ad..3f4fdb121 100644
--- a/examples/sites/demos/pc/menus.js
+++ b/examples/sites/demos/pc/menus.js
@@ -226,8 +226,7 @@ export const cmpMenus = [
{ 'nameCn': '弹出框', 'name': 'Popover', 'key': 'popover' },
{ 'nameCn': '气泡确认框组件', 'name': 'Popconfirm', 'key': 'popconfirm' },
{ 'nameCn': '模态框', 'name': 'Modal', 'key': 'modal' },
- { 'nameCn': '通知', 'name': 'Notify', 'key': 'notify' },
- { 'name': 'FloatButton', 'nameCn': '悬浮按钮', 'key': 'float-button' }
+ { 'nameCn': '通知', 'name': 'Notify', 'key': 'notify' }
]
},
{