Skip to content

docs: optimize features of popconfirm/popeditor/rate and so on #3150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

docs: optimize features of popconfirm/popeditor/rate and so on #3150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions examples/sites/demos/pc/app/popconfirm/webdoc/popconfirm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,98 @@ export default {
},
codeFiles: ['event.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '通过 title 设置标题内容，message 设置正文内容，通过 reference 插槽自定义触发显示的元素。',
cloud: {
value: true
},
apis: ['title', 'message', 'reference'],
demos: ['basic-usage']
},
{
id: 'trigger',
name: '触发方式',
support: {
value: true
},
description: '通过 trigger 设置触发显示气泡确认框的方式。',
cloud: {
value: true
},
apis: ['trigger'],
demos: ['trigger']
},
{
id: 'type',
name: '图标类型',
support: {
value: true
},
description: '通过 type 设置提示的图标类型，或者传入自定义图标。',
cloud: {
value: true
},
apis: ['type'],
demos: ['type']
},
{
id: 'placement',
name: '显示位置',
support: {
value: true
},
description: '通过 placement 设置提示框显示位置。',
cloud: {
value: true
},
apis: ['placement'],
demos: ['placement']
},
{
id: 'custom',
name: '自定义配置',
support: {
value: true
},
description: '支持自定义类名、宽度、取消按钮显示等配置。',
cloud: {
value: true
},
apis: ['custom-class', 'width', 'cancel-button'],
demos: ['custom-class', 'width', 'cancel-button']
},
{
id: 'slots',
name: '插槽',
support: {
value: true
},
description: '通过 footer 插槽自定义底部内容。',
cloud: {
value: true
},
apis: ['footer'],
demos: ['slot-footer']
},
{
id: 'events',
name: '事件',
support: {
value: true
},
description: '支持 show、hide、confirm 等事件。',
cloud: {
value: true
},
apis: ['show', 'hide', 'confirm'],
demos: ['event']
}
]
}
54 changes: 54 additions & 0 deletions examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,5 +503,59 @@ export default {
},
codeFiles: ['events.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '通过 v-model 绑定变量，变量值对应 label 属性的值。',
cloud: {
value: true
},
apis: ['v-model'],
demos: ['basic-usage']
},
{
id: 'disabled',
name: '禁用状态',
support: {
value: true
},
description: '通过 disabled 设置是否禁用单选框。',
cloud: {
value: true
},
apis: ['disabled'],
demos: ['dynamic-disable']
},
{
id: 'vertical',
name: '垂直布局',
support: {
value: true
},
description: '可在 radio-group 组件上设置 vertical 属性，使单选框垂直布局。',
cloud: {
value: true
},
apis: ['vertical'],
demos: ['vertical']
},
{
id: 'size',
name: '尺寸',
support: {
value: true
},
description: '可对按钮形式的 radio 设置 size 属性，以改变其尺寸，可选值有：medium、small、mini。',
cloud: {
value: true
},
apis: ['size'],
demos: ['radio-size']
}
Comment on lines +507 to +559
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Feature documentation added with a potential demo reference issue.

The features array provides good structure and documentation for the popeditor component. However, there appears to be an inconsistency in the "disabled" feature (ID: disabled) which references a demo called "dynamic-disable" that doesn't exist in the demos array at the top of the file. You should verify this reference or update it to point to the correct demo (possibly "disabled").

🏁 Script executed:

#!/bin/bash
# Check if the dynamic-disable demo actually exists in the codebase

echo "Searching for dynamic-disable.vue in the popeditor demos directory..."
find examples/sites/demos/pc/app/popeditor/ -name "dynamic-disable.vue" -o -name "disabled.vue"

Length of output: 293

Action Required: Update Demo Reference for "disabled" Feature

  • The "disabled" feature in examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js currently references a demo called dynamic-disable in its demos array.
  • Our search found only disabled.vue in the directory, indicating that the intended demo reference should likely be updated to disabled.

Please update the demos entry for the "disabled" feature accordingly.

]
}
54 changes: 54 additions & 0 deletions examples/sites/demos/pc/app/radio/webdoc/radio.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,5 +151,59 @@ export default {
},
codeFiles: ['display-only.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '通过 v-model 绑定变量，变量值对应 label 属性的值。',
cloud: {
value: true
},
apis: ['v-model', 'label'],
demos: ['basic-usage']
},
{
id: 'group',
name: '单选框组',
support: {
value: true
},
description: 'radio-group 可以将 radio 或者 radio-button 组合起来，通过 v-model 绑定选中的值。',
cloud: {
value: true
},
apis: ['radio-group', 'v-model'],
demos: ['radio-group']
},
{
id: 'options',
name: '单选组',
support: {
value: true
},
description: '通过 options 配置式渲染单选组，type 属性可以配置为 button，配置后单选组将以按钮的形式展示。',
cloud: {
value: true
},
apis: ['options', 'type'],
demos: ['group-options']
},
{
id: 'disabled',
name: '禁用状态',
support: {
value: true
},
description: '通过 disabled 设置是否禁用单选框。',
cloud: {
value: true
},
apis: ['disabled'],
demos: ['dynamic-disable']
}
]
}
54 changes: 54 additions & 0 deletions examples/sites/demos/pc/app/rate/webdoc/rate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,5 +215,59 @@ export default {
},
codeFiles: ['rate-events.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '通过 v-model 绑定变量，变量值对应评分值。',
cloud: {
value: true
},
apis: ['v-model'],
demos: ['basic-usage']
},
{
id: 'disabled',
name: '禁用状态',
support: {
value: true
},
description: '通过 disabled 设置是否禁用评分组件。',
cloud: {
value: true
},
apis: ['disabled'],
demos: ['disabled']
},
{
id: 'size',
name: '尺寸',
support: {
value: true
},
description: '通过 size 设置评分组件的尺寸大小。',
cloud: {
value: true
},
apis: ['size'],
demos: ['size']
},
{
id: 'max',
name: '最大值',
support: {
value: true
},
description: '通过 max 设置评分组件的最大值。',
cloud: {
value: true
},
apis: ['max'],
demos: ['max']
}
]
}
54 changes: 54 additions & 0 deletions examples/sites/demos/pc/app/scroll-text/webdoc/scroll-text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,59 @@ export default {
},
codeFiles: ['slots.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '可通过 text 自定义文本内容。',
cloud: {
value: true
},
apis: ['text'],
demos: ['basic-usage']
},
{
id: 'direction',
name: '滚动方向',
support: {
value: true
},
description: '可通过 direction 设置文字滚动方向。',
cloud: {
value: true
},
apis: ['direction'],
demos: ['scroll-direction']
},
{
id: 'hover-stop',
name: '悬停停止',
support: {
value: true
},
description: '可通过 hover-stop 设鼠标悬停时文本是否停止滚动。',
cloud: {
value: true
},
apis: ['hover-stop'],
demos: ['hover-stop']
},
{
id: 'time',
name: '滚动时间',
support: {
value: true
},
description: '可通过 time 设置滚动时间间隔。',
cloud: {
value: true
},
apis: ['time'],
demos: ['scroll-time']
}
]
}
54 changes: 54 additions & 0 deletions examples/sites/demos/pc/app/search/webdoc/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,59 @@ export default {
},
codeFiles: ['events.vue']
}
],
features: [
{
id: 'basic',
name: '基本用法',
support: {
value: true
},
description: '通过 v-model 设置双向绑定搜索值，placeholder 设置默认占位符文本。',
cloud: {
value: true
},
apis: ['v-model', 'placeholder'],
demos: ['basic-usage']
},
{
id: 'clearable',
name: '可清除',
support: {
value: true
},
description: '通过 clearable 设置显示清空图标按钮。',
cloud: {
value: true
},
apis: ['clearable'],
demos: ['clearable']
},
{
id: 'mini',
name: '迷你模式',
support: {
value: true
},
description: '通过 mini 设置为 mini 模式。',
cloud: {
value: true
},
apis: ['mini'],
demos: ['mini-mode']
},
{
id: 'search-types',
name: '搜索类型',
support: {
value: true
},
description: '通过 search-types 设置可选的搜索类型，type-value 设置搜索类型的默认值。',
cloud: {
value: true
},
apis: ['search-types', 'type-value'],
demos: ['search-types']
}
]
}
Loading
Loading