1 | {
|
2 | "name": "Pagination",
|
3 | "props": {
|
4 | "locale": {
|
5 | "type": {
|
6 | "name": "object"
|
7 | },
|
8 | "required": false,
|
9 | "description": "自定义国际化文案对象",
|
10 | "defaultValue": {
|
11 | "value": "zhCN.Pagination",
|
12 | "computed": true
|
13 | },
|
14 | "docblock": "自定义国际化文案对象",
|
15 | "properties": []
|
16 | },
|
17 | "type": {
|
18 | "type": {
|
19 | "name": "enum",
|
20 | "value": [
|
21 | {
|
22 | "value": "'normal'",
|
23 | "computed": false
|
24 | },
|
25 | {
|
26 | "value": "'simple'",
|
27 | "computed": false
|
28 | },
|
29 | {
|
30 | "value": "'mini'",
|
31 | "computed": false
|
32 | }
|
33 | ]
|
34 | },
|
35 | "required": false,
|
36 | "description": "分页组件类型",
|
37 | "defaultValue": {
|
38 | "value": "'normal'",
|
39 | "computed": false
|
40 | },
|
41 | "docblock": "分页组件类型"
|
42 | },
|
43 | "shape": {
|
44 | "type": {
|
45 | "name": "enum",
|
46 | "value": [
|
47 | {
|
48 | "value": "'normal'",
|
49 | "computed": false
|
50 | },
|
51 | {
|
52 | "value": "'arrow-only'",
|
53 | "computed": false
|
54 | },
|
55 | {
|
56 | "value": "'arrow-prev-only'",
|
57 | "computed": false
|
58 | },
|
59 | {
|
60 | "value": "'no-border'",
|
61 | "computed": false
|
62 | }
|
63 | ]
|
64 | },
|
65 | "required": false,
|
66 | "description": "前进后退按钮样式",
|
67 | "defaultValue": {
|
68 | "value": "'normal'",
|
69 | "computed": false
|
70 | },
|
71 | "docblock": "前进后退按钮样式"
|
72 | },
|
73 | "size": {
|
74 | "type": {
|
75 | "name": "enum",
|
76 | "value": [
|
77 | {
|
78 | "value": "'small'",
|
79 | "computed": false
|
80 | },
|
81 | {
|
82 | "value": "'medium'",
|
83 | "computed": false
|
84 | },
|
85 | {
|
86 | "value": "'large'",
|
87 | "computed": false
|
88 | }
|
89 | ]
|
90 | },
|
91 | "required": false,
|
92 | "description": "分页组件大小",
|
93 | "defaultValue": {
|
94 | "value": "'medium'",
|
95 | "computed": false
|
96 | },
|
97 | "docblock": "分页组件大小"
|
98 | },
|
99 | "current": {
|
100 | "type": {
|
101 | "name": "number"
|
102 | },
|
103 | "required": false,
|
104 | "description": "(受控)当前页码",
|
105 | "docblock": "(受控)当前页码"
|
106 | },
|
107 | "defaultCurrent": {
|
108 | "type": {
|
109 | "name": "number"
|
110 | },
|
111 | "required": false,
|
112 | "description": "(非受控)初始页码",
|
113 | "defaultValue": {
|
114 | "value": "1",
|
115 | "computed": false
|
116 | },
|
117 | "docblock": "(非受控)初始页码"
|
118 | },
|
119 | "onChange": {
|
120 | "type": {
|
121 | "name": "func"
|
122 | },
|
123 | "required": false,
|
124 | "description": "页码发生改变时的回调函数",
|
125 | "defaultValue": {
|
126 | "value": "() => {}",
|
127 | "computed": false
|
128 | },
|
129 | "docblock": "页码发生改变时的回调函数\n@param {Number} current 改变后的页码数\n@param {Object} e 点击事件对象",
|
130 | "params": [
|
131 | {
|
132 | "name": "current",
|
133 | "description": "改变后的页码数",
|
134 | "type": {
|
135 | "name": "Number"
|
136 | }
|
137 | },
|
138 | {
|
139 | "name": "e",
|
140 | "description": "点击事件对象",
|
141 | "type": {
|
142 | "name": "Object"
|
143 | }
|
144 | }
|
145 | ],
|
146 | "returns": null
|
147 | },
|
148 | "total": {
|
149 | "type": {
|
150 | "name": "number"
|
151 | },
|
152 | "required": false,
|
153 | "description": "总记录数",
|
154 | "defaultValue": {
|
155 | "value": "100",
|
156 | "computed": false
|
157 | },
|
158 | "docblock": "总记录数"
|
159 | },
|
160 | "totalRender": {
|
161 | "type": {
|
162 | "name": "func"
|
163 | },
|
164 | "required": false,
|
165 | "description": "总数的渲染函数",
|
166 | "docblock": "总数的渲染函数\n@param {Number} total 总数\n@param {Array} range 当前数据在总数中的区间",
|
167 | "params": [
|
168 | {
|
169 | "name": "total",
|
170 | "description": "总数",
|
171 | "type": {
|
172 | "name": "Number"
|
173 | }
|
174 | },
|
175 | {
|
176 | "name": "range",
|
177 | "description": "当前数据在总数中的区间",
|
178 | "type": {
|
179 | "name": "Array"
|
180 | }
|
181 | }
|
182 | ],
|
183 | "returns": null
|
184 | },
|
185 | "pageShowCount": {
|
186 | "type": {
|
187 | "name": "number"
|
188 | },
|
189 | "required": false,
|
190 | "description": "页码显示的数量,更多的使用...代替",
|
191 | "defaultValue": {
|
192 | "value": "5",
|
193 | "computed": false
|
194 | },
|
195 | "docblock": "页码显示的数量,更多的使用...代替"
|
196 | },
|
197 | "pageSize": {
|
198 | "type": {
|
199 | "name": "number"
|
200 | },
|
201 | "required": false,
|
202 | "description": "一页中的记录数",
|
203 | "defaultValue": {
|
204 | "value": "10",
|
205 | "computed": false
|
206 | },
|
207 | "docblock": "一页中的记录数"
|
208 | },
|
209 | "pageSizeSelector": {
|
210 | "type": {
|
211 | "name": "enum",
|
212 | "value": [
|
213 | {
|
214 | "value": "false",
|
215 | "computed": false
|
216 | },
|
217 | {
|
218 | "value": "'filter'",
|
219 | "computed": false
|
220 | },
|
221 | {
|
222 | "value": "'dropdown'",
|
223 | "computed": false
|
224 | }
|
225 | ]
|
226 | },
|
227 | "required": false,
|
228 | "description": "每页显示选择器类型",
|
229 | "defaultValue": {
|
230 | "value": "false",
|
231 | "computed": false
|
232 | },
|
233 | "docblock": "每页显示选择器类型"
|
234 | },
|
235 | "pageSizeList": {
|
236 | "type": {
|
237 | "name": "union",
|
238 | "value": [
|
239 | {
|
240 | "name": "arrayOf",
|
241 | "value": {
|
242 | "name": "number"
|
243 | }
|
244 | },
|
245 | {
|
246 | "name": "arrayOf",
|
247 | "value": {
|
248 | "name": "shape",
|
249 | "value": {
|
250 | "label": {
|
251 | "name": "string",
|
252 | "required": false
|
253 | },
|
254 | "value": {
|
255 | "name": "number",
|
256 | "required": false
|
257 | }
|
258 | }
|
259 | }
|
260 | }
|
261 | ]
|
262 | },
|
263 | "required": false,
|
264 | "description": "每页显示选择器可选值",
|
265 | "defaultValue": {
|
266 | "value": "[5, 10, 20]",
|
267 | "computed": false
|
268 | },
|
269 | "docblock": "每页显示选择器可选值"
|
270 | },
|
271 | "pageNumberRender": {
|
272 | "type": {
|
273 | "name": "func"
|
274 | },
|
275 | "required": false,
|
276 | "description": "自定义页码渲染函数,函数作用于页码button以及当前页/总页数的数字渲染",
|
277 | "defaultValue": {
|
278 | "value": "index => index",
|
279 | "computed": false
|
280 | },
|
281 | "docblock": "自定义页码渲染函数,函数作用于页码button以及当前页/总页数的数字渲染\n@param {Number} index 分页的页码,从1开始\n@return {ReactNode} 返回渲染结果",
|
282 | "params": [
|
283 | {
|
284 | "name": "index",
|
285 | "description": "分页的页码,从1开始",
|
286 | "type": {
|
287 | "name": "Number"
|
288 | }
|
289 | }
|
290 | ],
|
291 | "returns": {
|
292 | "description": "返回渲染结果",
|
293 | "type": {
|
294 | "name": "ReactNode"
|
295 | }
|
296 | }
|
297 | },
|
298 | "pageSizePosition": {
|
299 | "type": {
|
300 | "name": "enum",
|
301 | "value": [
|
302 | {
|
303 | "value": "'start'",
|
304 | "computed": false
|
305 | },
|
306 | {
|
307 | "value": "'end'",
|
308 | "computed": false
|
309 | }
|
310 | ]
|
311 | },
|
312 | "required": false,
|
313 | "description": "每页显示选择器在组件中的位置",
|
314 | "defaultValue": {
|
315 | "value": "'start'",
|
316 | "computed": false
|
317 | },
|
318 | "docblock": "每页显示选择器在组件中的位置"
|
319 | },
|
320 | "useFloatLayout": {
|
321 | "type": {
|
322 | "name": "bool"
|
323 | },
|
324 | "required": false,
|
325 | "description": "存在每页显示选择器时是否使用浮动布局",
|
326 | "defaultValue": {
|
327 | "value": "false",
|
328 | "computed": false
|
329 | },
|
330 | "docblock": "存在每页显示选择器时是否使用浮动布局"
|
331 | },
|
332 | "onPageSizeChange": {
|
333 | "type": {
|
334 | "name": "func"
|
335 | },
|
336 | "required": false,
|
337 | "description": "每页显示记录数量改变时的回调函数",
|
338 | "defaultValue": {
|
339 | "value": "() => {}",
|
340 | "computed": false
|
341 | },
|
342 | "docblock": "每页显示记录数量改变时的回调函数\n@param {Number} pageSize 改变后的每页显示记录数",
|
343 | "params": [
|
344 | {
|
345 | "name": "pageSize",
|
346 | "description": "改变后的每页显示记录数",
|
347 | "type": {
|
348 | "name": "Number"
|
349 | }
|
350 | }
|
351 | ],
|
352 | "returns": null
|
353 | },
|
354 | "hideOnlyOnePage": {
|
355 | "type": {
|
356 | "name": "bool"
|
357 | },
|
358 | "required": false,
|
359 | "description": "当分页数为1时,是否隐藏分页器",
|
360 | "defaultValue": {
|
361 | "value": "false",
|
362 | "computed": false
|
363 | },
|
364 | "docblock": "当分页数为1时,是否隐藏分页器"
|
365 | },
|
366 | "showJump": {
|
367 | "type": {
|
368 | "name": "bool"
|
369 | },
|
370 | "required": false,
|
371 | "description": "type 设置为 normal 时,在页码数超过5页后,会显示跳转输入框与按钮,当设置 showJump 为 false 时,不再显示该跳转区域",
|
372 | "defaultValue": {
|
373 | "value": "true",
|
374 | "computed": false
|
375 | },
|
376 | "docblock": "type 设置为 normal 时,在页码数超过5页后,会显示跳转输入框与按钮,当设置 showJump 为 false 时,不再显示该跳转区域"
|
377 | },
|
378 | "link": {
|
379 | "type": {
|
380 | "name": "string"
|
381 | },
|
382 | "required": false,
|
383 | "description": "设置页码按钮的跳转链接,它的值为一个包含 {page} 的模版字符串,如:https://www.taobao.com/{page}",
|
384 | "docblock": "设置页码按钮的跳转链接,它的值为一个包含 {page} 的模版字符串,如:https://www.taobao.com/{page}"
|
385 | },
|
386 | "popupProps": {
|
387 | "type": {
|
388 | "name": "object"
|
389 | },
|
390 | "required": false,
|
391 | "description": "弹层组件属性,透传给Popup",
|
392 | "docblock": "弹层组件属性,透传给Popup",
|
393 | "properties": []
|
394 | }
|
395 | },
|
396 | "methods": [],
|
397 | "subComponents": []
|
398 | } |
\ | No newline at end of file |