UNPKG

13.6 kBJSONView Raw
1{
2 "name": "Transfer",
3 "props": {
4 "mode": {
5 "type": {
6 "name": "enum",
7 "value": [
8 {
9 "value": "'normal'",
10 "computed": false
11 },
12 {
13 "value": "'simple'",
14 "computed": false
15 }
16 ]
17 },
18 "required": false,
19 "description": "移动选项模式",
20 "defaultValue": {
21 "value": "'normal'",
22 "computed": false
23 },
24 "docblock": "移动选项模式"
25 },
26 "dataSource": {
27 "type": {
28 "name": "arrayOf",
29 "value": {
30 "name": "object"
31 }
32 },
33 "required": false,
34 "description": "数据源",
35 "defaultValue": {
36 "value": "[]",
37 "computed": false
38 },
39 "docblock": "数据源"
40 },
41 "value": {
42 "type": {
43 "name": "arrayOf",
44 "value": {
45 "name": "string"
46 }
47 },
48 "required": false,
49 "description": "(用于受控)当前值",
50 "docblock": "(用于受控)当前值"
51 },
52 "defaultValue": {
53 "type": {
54 "name": "arrayOf",
55 "value": {
56 "name": "string"
57 }
58 },
59 "required": false,
60 "description": "(用于非受控)初始值",
61 "defaultValue": {
62 "value": "[]",
63 "computed": false
64 },
65 "docblock": "(用于非受控)初始值"
66 },
67 "onChange": {
68 "type": {
69 "name": "func"
70 },
71 "required": false,
72 "description": "值发生改变的时候触发的回调函数",
73 "docblock": "值发生改变的时候触发的回调函数\n@param {Array} value 右面板值\n@param {Array} data 右面板数据\n@param {Object} extra 额外参数\n@param {Array} extra.leftValue 左面板值\n@param {Array} extra.leftData 左面板数据\n@param {Array} extra.movedValue 发生移动的值\n@param {Object} extra.movedData 发生移动的数据\n@param {String} extra.direction 移动的方向,值为'left'或'right'",
74 "params": [
75 {
76 "name": "value",
77 "description": "右面板值",
78 "type": {
79 "name": "Array"
80 }
81 },
82 {
83 "name": "data",
84 "description": "右面板数据",
85 "type": {
86 "name": "Array"
87 }
88 },
89 {
90 "name": "extra",
91 "description": "额外参数",
92 "type": {
93 "name": "Object"
94 }
95 },
96 {
97 "name": "extra.leftValue",
98 "description": "左面板值",
99 "type": {
100 "name": "Array"
101 }
102 },
103 {
104 "name": "extra.leftData",
105 "description": "左面板数据",
106 "type": {
107 "name": "Array"
108 }
109 },
110 {
111 "name": "extra.movedValue",
112 "description": "发生移动的值",
113 "type": {
114 "name": "Array"
115 }
116 },
117 {
118 "name": "extra.movedData",
119 "description": "发生移动的数据",
120 "type": {
121 "name": "Object"
122 }
123 },
124 {
125 "name": "extra.direction",
126 "description": "移动的方向,值为'left'或'right'",
127 "type": {
128 "name": "String"
129 }
130 }
131 ],
132 "returns": null
133 },
134 "onSelect": {
135 "type": {
136 "name": "func"
137 },
138 "required": false,
139 "description": "Item 被选中的时候触发的回调函数",
140 "docblock": "Item 被选中的时候触发的回调函数\n@param {Array} sourceSelectedValue 源面板选中的 Item 列表\n@param {Array} targetSelectedValue 目标面板选中的 Item 列表\n@param {String} trigger 触发面板,值为'source'或'target'",
141 "params": [
142 {
143 "name": "sourceSelectedValue",
144 "description": "源面板选中的 Item 列表",
145 "type": {
146 "name": "Array"
147 }
148 },
149 {
150 "name": "targetSelectedValue",
151 "description": "目标面板选中的 Item 列表",
152 "type": {
153 "name": "Array"
154 }
155 },
156 {
157 "name": "trigger",
158 "description": "触发面板,值为'source'或'target'",
159 "type": {
160 "name": "String"
161 }
162 }
163 ],
164 "returns": null
165 },
166 "disabled": {
167 "type": {
168 "name": "bool"
169 },
170 "required": false,
171 "description": "是否禁用",
172 "defaultValue": {
173 "value": "false",
174 "computed": false
175 },
176 "docblock": "是否禁用"
177 },
178 "leftDisabled": {
179 "type": {
180 "name": "bool"
181 },
182 "required": false,
183 "description": "是否禁用左侧面板",
184 "defaultValue": {
185 "value": "false",
186 "computed": false
187 },
188 "docblock": "是否禁用左侧面板"
189 },
190 "rightDisabled": {
191 "type": {
192 "name": "bool"
193 },
194 "required": false,
195 "description": "是否禁用右侧面板",
196 "defaultValue": {
197 "value": "false",
198 "computed": false
199 },
200 "docblock": "是否禁用右侧面板"
201 },
202 "itemRender": {
203 "type": {
204 "name": "func"
205 },
206 "required": false,
207 "description": "列表项渲染函数",
208 "defaultValue": {
209 "value": "data => data.label",
210 "computed": false
211 },
212 "docblock": "列表项渲染函数\n@param {Object} data 数据\n@return {ReactNode} 列表项内容",
213 "params": [
214 {
215 "name": "data",
216 "description": "数据",
217 "type": {
218 "name": "Object"
219 }
220 }
221 ],
222 "returns": {
223 "description": "列表项内容",
224 "type": {
225 "name": "ReactNode"
226 }
227 }
228 },
229 "filter": {
230 "type": {
231 "name": "func"
232 },
233 "required": false,
234 "description": "自定义搜索函数",
235 "defaultValue": {
236 "value": "根据 label 属性匹配",
237 "computed": false
238 },
239 "docblock": "自定义搜索函数\n@param {String} searchedValue 搜索的内容\n@param {Object} data 数据\n@return {Boolean} 是否匹配到\n@default 根据 label 属性匹配",
240 "params": [
241 {
242 "name": "searchedValue",
243 "description": "搜索的内容",
244 "type": {
245 "name": "String"
246 }
247 },
248 {
249 "name": "data",
250 "description": "数据",
251 "type": {
252 "name": "Object"
253 }
254 }
255 ],
256 "returns": {
257 "description": "是否匹配到",
258 "type": {
259 "name": "Boolean"
260 }
261 }
262 },
263 "onSearch": {
264 "type": {
265 "name": "func"
266 },
267 "required": false,
268 "description": "搜索框输入时触发的回调函数",
269 "defaultValue": {
270 "value": "() => {}",
271 "computed": false
272 },
273 "docblock": "搜索框输入时触发的回调函数\n@param {String} searchedValue 搜索的内容\n@param {String} position 搜索面板的位置",
274 "params": [
275 {
276 "name": "searchedValue",
277 "description": "搜索的内容",
278 "type": {
279 "name": "String"
280 }
281 },
282 {
283 "name": "position",
284 "description": "搜索面板的位置",
285 "type": {
286 "name": "String"
287 }
288 }
289 ],
290 "returns": null
291 },
292 "searchPlaceholder": {
293 "type": {
294 "name": "string"
295 },
296 "required": false,
297 "description": "搜索框占位符",
298 "docblock": "搜索框占位符"
299 },
300 "showSearch": {
301 "type": {
302 "name": "union",
303 "value": [
304 {
305 "name": "bool"
306 },
307 {
308 "name": "arrayOf",
309 "value": {
310 "name": "bool"
311 }
312 }
313 ]
314 },
315 "required": false,
316 "description": "左右面板是否显示搜索框",
317 "defaultValue": {
318 "value": "false",
319 "computed": false
320 },
321 "docblock": "左右面板是否显示搜索框"
322 },
323 "searchProps": {
324 "type": {
325 "name": "union",
326 "value": [
327 {
328 "name": "object"
329 },
330 {
331 "name": "arrayOf",
332 "value": {
333 "name": "object"
334 }
335 }
336 ]
337 },
338 "required": false,
339 "description": "左右面板搜索框配置项,同 Search 组件 props",
340 "docblock": "左右面板搜索框配置项,同 Search 组件 props"
341 },
342 "notFoundContent": {
343 "type": {
344 "name": "union",
345 "value": [
346 {
347 "name": "node"
348 },
349 {
350 "name": "arrayOf",
351 "value": {
352 "name": "node"
353 }
354 }
355 ]
356 },
357 "required": false,
358 "description": "列表为空显示内容",
359 "defaultValue": {
360 "value": "'Not Found'",
361 "computed": false
362 },
363 "docblock": "列表为空显示内容"
364 },
365 "titles": {
366 "type": {
367 "name": "arrayOf",
368 "value": {
369 "name": "node"
370 }
371 },
372 "required": false,
373 "description": "左右面板标题",
374 "defaultValue": {
375 "value": "[]",
376 "computed": false
377 },
378 "docblock": "左右面板标题"
379 },
380 "operations": {
381 "type": {
382 "name": "arrayOf",
383 "value": {
384 "name": "node"
385 }
386 },
387 "required": false,
388 "description": "向右向左移动按钮显示内容",
389 "defaultValue": {
390 "value": "[<Icon type=\"arrow-right\" />, <Icon type=\"arrow-left\" />]",
391 "computed": false
392 },
393 "docblock": "向右向左移动按钮显示内容\n@default [<Icon type=\"arrow-right\" />, <Icon type=\"arrow-left\" />]"
394 },
395 "defaultLeftChecked": {
396 "type": {
397 "name": "arrayOf",
398 "value": {
399 "name": "string"
400 }
401 },
402 "required": false,
403 "description": "左面板默认选中值",
404 "defaultValue": {
405 "value": "[]",
406 "computed": false
407 },
408 "docblock": "左面板默认选中值"
409 },
410 "defaultRightChecked": {
411 "type": {
412 "name": "arrayOf",
413 "value": {
414 "name": "string"
415 }
416 },
417 "required": false,
418 "description": "右面板默认选中值",
419 "defaultValue": {
420 "value": "[]",
421 "computed": false
422 },
423 "docblock": "右面板默认选中值"
424 },
425 "listClassName": {
426 "type": {
427 "name": "string"
428 },
429 "required": false,
430 "description": "左右面板列表自定义样式类名",
431 "docblock": "左右面板列表自定义样式类名"
432 },
433 "listStyle": {
434 "type": {
435 "name": "object"
436 },
437 "required": false,
438 "description": "左右面板列表自定义样式对象",
439 "docblock": "左右面板列表自定义样式对象",
440 "properties": []
441 },
442 "sortable": {
443 "type": {
444 "name": "bool"
445 },
446 "required": false,
447 "description": "是否允许拖拽排序",
448 "defaultValue": {
449 "value": "false",
450 "computed": false
451 },
452 "docblock": "是否允许拖拽排序"
453 },
454 "onSort": {
455 "type": {
456 "name": "func"
457 },
458 "required": false,
459 "description": "拖拽排序时触发的回调函数",
460 "defaultValue": {
461 "value": "() => {}",
462 "computed": false
463 },
464 "docblock": "拖拽排序时触发的回调函数\n@param {Array} value 排序后的值\n@param {String} position 拖拽的面板位置,值为:left 或 right",
465 "params": [
466 {
467 "name": "value",
468 "description": "排序后的值",
469 "type": {
470 "name": "Array"
471 }
472 },
473 {
474 "name": "position",
475 "description": "拖拽的面板位置,值为:left 或 right",
476 "type": {
477 "name": "String"
478 }
479 }
480 ],
481 "returns": null
482 },
483 "locale": {
484 "type": {
485 "name": "object"
486 },
487 "required": false,
488 "description": "自定义国际化文案对象",
489 "defaultValue": {
490 "value": "zhCN.Transfer",
491 "computed": true
492 },
493 "docblock": "自定义国际化文案对象",
494 "properties": []
495 },
496 "id": {
497 "type": {
498 "name": "string"
499 },
500 "required": false,
501 "description": "请设置 id 以保证transfer的可访问性",
502 "docblock": "请设置 id 以保证transfer的可访问性"
503 },
504 "children": {
505 "type": {
506 "name": "func"
507 },
508 "required": false,
509 "description": "接收 children 自定义渲染列表",
510 "docblock": "接收 children 自定义渲染列表",
511 "params": [],
512 "returns": null
513 },
514 "useVirtual": {
515 "type": {
516 "name": "bool"
517 },
518 "required": false,
519 "description": "是否开启虚拟滚动",
520 "docblock": "是否开启虚拟滚动"
521 },
522 "showCheckAll": {
523 "type": {
524 "name": "bool"
525 },
526 "required": false,
527 "description": "是否显示底部全选 checkbox",
528 "defaultValue": {
529 "value": "true",
530 "computed": false
531 },
532 "docblock": "是否显示底部全选 checkbox"
533 }
534 },
535 "methods": [],
536 "subComponents": []
537}
\No newline at end of file