Skip to content

Commit ffe1cf6

Browse files
kagolkagol
committed
docs: optimize features of guide/image/link and so on
1 parent 7cf5458 commit ffe1cf6

File tree

18 files changed

+1784
-3
lines changed

18 files changed

+1784
-3
lines changed

‎examples/sites/demos/pc/app/guide/webdoc/guide.js‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,113 @@ export default {
117117
},
118118
codeFiles: ['callback.vue']
119119
}
120+
],
121+
features: [
122+
{
123+
id: 'basic',
124+
name: '基础用法',
125+
support: {
126+
value: true
127+
},
128+
description: '通过 dom-data 设置每一个步骤要显示的内容，show-step 设置为 true 即可开启指引。',
129+
cloud: {
130+
value: true
131+
},
132+
apis: ['dom-data', 'show-step'],
133+
demos: ['basic-usage']
134+
},
135+
{
136+
id: 'arrow-position',
137+
name: '箭头位置',
138+
support: {
139+
value: true
140+
},
141+
description:
142+
'通过 pop-position 属性设置箭头位置，若存在多个步骤，可以在 dom-data 里面添加 popPosition 属性并赋值。',
143+
cloud: {
144+
value: true
145+
},
146+
apis: ['pop-position'],
147+
demos: ['arrow-position']
148+
},
149+
{
150+
id: 'content',
151+
name: '内容展示',
152+
support: {
153+
value: true
154+
},
155+
description: '支持纯段落用户引导、图文结合用户引导等多种内容展示方式。',
156+
cloud: {
157+
value: true
158+
},
159+
apis: ['only-content', 'text'],
160+
demos: ['only-content', 'image-text']
161+
},
162+
{
163+
id: 'highlight',
164+
name: '高亮配置',
165+
support: {
166+
value: true
167+
},
168+
description: '通过 hightBox 属性添加需要高亮的元素，支持多处高亮。',
169+
cloud: {
170+
value: true
171+
},
172+
apis: ['hightBox'],
173+
demos: ['highlight-box']
174+
},
175+
{
176+
id: 'offset',
177+
name: '偏移配置',
178+
support: {
179+
value: true
180+
},
181+
description: '通过 main-axis、cross-axis、alignment-axis 设置纵轴、横轴和对齐轴的偏移量。',
182+
cloud: {
183+
value: true
184+
},
185+
apis: ['main-axis', 'cross-axis', 'alignment-axis'],
186+
demos: ['offset']
187+
},
188+
{
189+
id: 'size',
190+
name: '尺寸配置',
191+
support: {
192+
value: true
193+
},
194+
description: '通过 width 和 height 来自定义宽高。',
195+
cloud: {
196+
value: true
197+
},
198+
apis: ['width', 'height'],
199+
demos: ['size']
200+
},
201+
{
202+
id: 'modal',
203+
name: '模态层配置',
204+
support: {
205+
value: true
206+
},
207+
description:
208+
'通过 modal-overlay-opening-padding 和 modal-overlay-opening-radius 配置模态叠加层开口的填充量和边界半径。',
209+
cloud: {
210+
value: true
211+
},
212+
apis: ['modal-overlay-opening-padding', 'modal-overlay-opening-radius'],
213+
demos: ['modal-overlay-opening']
214+
},
215+
{
216+
id: 'events',
217+
name: '事件回调',
218+
support: {
219+
value: true
220+
},
221+
description: '支持在 dom-data 中配置各种事件回调。',
222+
cloud: {
223+
value: true
224+
},
225+
apis: ['events'],
226+
demos: ['callback']
227+
}
120228
]
121229
}

‎examples/sites/demos/pc/app/icon/webdoc/icon.js‎

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
column: '1',
2+
column: '2',
33
owner: '',
44
show: true,
55
cloud: true,
@@ -62,5 +62,85 @@ export default {
6262
},
6363
codeFiles: ['list.vue']
6464
}
65+
],
66+
features: [
67+
{
68+
id: 'basic',
69+
name: '基本用法',
70+
support: {
71+
value: true
72+
},
73+
description: '通过 name 设置图标名称，size 设置图标大小。',
74+
cloud: {
75+
value: true
76+
},
77+
apis: ['name', 'size'],
78+
demos: ['basic-usage']
79+
},
80+
{
81+
id: 'color',
82+
name: '颜色配置',
83+
support: {
84+
value: true
85+
},
86+
description: '通过 color 设置图标颜色。',
87+
cloud: {
88+
value: true
89+
},
90+
apis: ['color'],
91+
demos: ['custom-color']
92+
},
93+
{
94+
id: 'animation',
95+
name: '动画效果',
96+
support: {
97+
value: true
98+
},
99+
description: '通过 animation 设置图标动画效果，可选值：spin、pulse、bounce。',
100+
cloud: {
101+
value: true
102+
},
103+
apis: ['animation'],
104+
demos: ['animation']
105+
},
106+
{
107+
id: 'rotation',
108+
name: '旋转',
109+
support: {
110+
value: true
111+
},
112+
description: '通过 rotation 设置图标旋转角度。',
113+
cloud: {
114+
value: true
115+
},
116+
apis: ['rotation'],
117+
demos: ['rotation']
118+
},
119+
{
120+
id: 'flip',
121+
name: '翻转',
122+
support: {
123+
value: true
124+
},
125+
description: '通过 flip 设置图标翻转方向，可选值：horizontal、vertical。',
126+
cloud: {
127+
value: true
128+
},
129+
apis: ['flip'],
130+
demos: ['flip']
131+
},
132+
{
133+
id: 'events',
134+
name: '事件',
135+
support: {
136+
value: true
137+
},
138+
description: '支持 click 事件。',
139+
cloud: {
140+
value: true
141+
},
142+
apis: ['click'],
143+
demos: ['events']
144+
}
65145
]
66146
}

‎examples/sites/demos/pc/app/image/webdoc/image.js‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,98 @@ export default {
160160
},
161161
codeFiles: ['events.vue']
162162
}
163+
],
164+
features: [
165+
{
166+
id: 'basic',
167+
name: '基本用法',
168+
support: {
169+
value: true
170+
},
171+
description: '通过 src 设置图片路径，通过 fit 属性确定图片如何适应到容器框。',
172+
cloud: {
173+
value: false
174+
},
175+
apis: ['src', 'fit'],
176+
demos: ['basic-usage']
177+
},
178+
{
179+
id: 'placeholder',
180+
name: '占位内容',
181+
support: {
182+
value: true
183+
},
184+
description: '通过 slot = placeholder 自定义占位内容。',
185+
cloud: {
186+
value: false
187+
},
188+
apis: ['placeholder-slot'],
189+
demos: ['custom-placeholder']
190+
},
191+
{
192+
id: 'lazy',
193+
name: '懒加载',
194+
support: {
195+
value: true
196+
},
197+
description: '通过 lazy 开启懒加载功能，当图片滚动到可视范围内才会加载。',
198+
cloud: {
199+
value: false
200+
},
201+
apis: ['lazy', 'scroll-container'],
202+
demos: ['lazy']
203+
},
204+
{
205+
id: 'preview',
206+
name: '预览功能',
207+
support: {
208+
value: true
209+
},
210+
description: '通过 preview-src-list 属性，传入一组图片 url 的数组，点击图片后进入预览大图模式。',
211+
cloud: {
212+
value: false
213+
},
214+
apis: ['preview-src-list', 'z-index', 'show-index'],
215+
demos: ['preview']
216+
},
217+
{
218+
id: 'style',
219+
name: '样式保持',
220+
support: {
221+
value: true
222+
},
223+
description: '通过 keep-style 属性可以让图片切换时样式保持一致。',
224+
cloud: {
225+
value: false
226+
},
227+
apis: ['keep-style'],
228+
demos: ['keep-style']
229+
},
230+
{
231+
id: 'events',
232+
name: '事件处理',
233+
support: {
234+
value: true
235+
},
236+
description: '支持 change-index、load、error 等事件。',
237+
cloud: {
238+
value: false
239+
},
240+
apis: ['change-index', 'load', 'error'],
241+
demos: ['index-change', 'events']
242+
},
243+
{
244+
id: 'slots',
245+
name: '插槽',
246+
support: {
247+
value: true
248+
},
249+
description: '支持 placeholder、error、count 等插槽。',
250+
cloud: {
251+
value: false
252+
},
253+
apis: ['placeholder-slot', 'error-slot', 'count-slot'],
254+
demos: ['slot', 'count-slot']
255+
}
163256
]
164257
}

‎examples/sites/demos/pc/app/infinite-scroll/webdoc/infinite-scroll.js‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,33 @@ export default {
3131
},
3232
codeFiles: ['disabled.vue']
3333
}
34+
],
35+
features: [
36+
{
37+
id: 'basic',
38+
name: '基本用法',
39+
support: {
40+
value: true
41+
},
42+
description: '在列表上添加指令 v-infinite-scroll 并指定加载方法，实现滚动加载。',
43+
cloud: {
44+
value: false
45+
},
46+
apis: ['v-infinite-scroll'],
47+
demos: ['basic-usage']
48+
},
49+
{
50+
id: 'disabled',
51+
name: '禁用加载',
52+
support: {
53+
value: true
54+
},
55+
description: '通过 infinite-scroll-disabled 属性控制是否禁用加载。',
56+
cloud: {
57+
value: false
58+
},
59+
apis: ['infinite-scroll-disabled'],
60+
demos: ['disabled']
61+
}
3462
]
3563
}

0 commit comments

Comments
 (0)