index.d.ts 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595
  1. import type { CSSProperties, ExtractPropTypes, PropType } from 'vue';
  2. import type { VueNode } from '../_util/type';
  3. import type { TransferListBodyProps } from './ListBody';
  4. import type { PaginationType } from './interface';
  5. export type { TransferListProps } from './list';
  6. export type { TransferOperationProps } from './operation';
  7. export type { TransferSearchProps } from './search';
  8. export declare type TransferDirection = 'left' | 'right';
  9. export interface RenderResultObject {
  10. label: VueNode;
  11. value: string;
  12. }
  13. export declare type RenderResult = VueNode | RenderResultObject | string | null;
  14. export interface TransferItem {
  15. key?: string;
  16. title?: string;
  17. description?: string;
  18. disabled?: boolean;
  19. [name: string]: any;
  20. }
  21. export declare type KeyWise<T> = T & {
  22. key: string;
  23. };
  24. export declare type KeyWiseTransferItem = KeyWise<TransferItem>;
  25. declare type TransferRender<RecordType> = (item: RecordType) => RenderResult;
  26. export interface ListStyle {
  27. direction: TransferDirection;
  28. }
  29. export declare type SelectAllLabel = VueNode | ((info: {
  30. selectedCount: number;
  31. totalCount: number;
  32. }) => VueNode);
  33. export interface TransferLocale {
  34. titles: VueNode[];
  35. notFoundContent?: VueNode;
  36. searchPlaceholder: string;
  37. itemUnit: string;
  38. itemsUnit: string;
  39. remove: string;
  40. selectAll: string;
  41. selectCurrent: string;
  42. selectInvert: string;
  43. removeAll: string;
  44. removeCurrent: string;
  45. }
  46. export declare const transferProps: () => {
  47. id: StringConstructor;
  48. prefixCls: StringConstructor;
  49. dataSource: {
  50. type: PropType<TransferItem[]>;
  51. default: any[];
  52. };
  53. disabled: {
  54. type: BooleanConstructor;
  55. default: any;
  56. };
  57. targetKeys: {
  58. type: PropType<string[]>;
  59. default: any;
  60. };
  61. selectedKeys: {
  62. type: PropType<string[]>;
  63. default: any;
  64. };
  65. render: {
  66. type: PropType<TransferRender<TransferItem>>;
  67. };
  68. listStyle: {
  69. type: PropType<CSSProperties | ((style: ListStyle) => CSSProperties)>;
  70. default: () => {};
  71. };
  72. operationStyle: {
  73. type: PropType<CSSProperties>;
  74. default: CSSProperties;
  75. };
  76. titles: {
  77. type: PropType<string[]>;
  78. };
  79. operations: {
  80. type: PropType<string[]>;
  81. };
  82. showSearch: {
  83. type: BooleanConstructor;
  84. default: boolean;
  85. };
  86. filterOption: {
  87. type: PropType<(inputValue: string, item: TransferItem) => boolean>;
  88. };
  89. searchPlaceholder: StringConstructor;
  90. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  91. locale: {
  92. type: PropType<Partial<TransferLocale>>;
  93. default: () => {};
  94. };
  95. rowKey: {
  96. type: PropType<(record: TransferItem) => string>;
  97. };
  98. showSelectAll: {
  99. type: BooleanConstructor;
  100. default: any;
  101. };
  102. selectAllLabels: {
  103. type: PropType<SelectAllLabel[]>;
  104. };
  105. children: {
  106. type: PropType<(props: TransferListBodyProps) => VueNode>;
  107. };
  108. oneWay: {
  109. type: BooleanConstructor;
  110. default: any;
  111. };
  112. pagination: {
  113. type: PropType<PaginationType>;
  114. default: any;
  115. };
  116. onChange: PropType<(targetKeys: string[], direction: TransferDirection, moveKeys: string[]) => void>;
  117. onSelectChange: PropType<(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void>;
  118. onSearch: PropType<(direction: TransferDirection, value: string) => void>;
  119. onScroll: PropType<(direction: TransferDirection, e: UIEvent) => void>;
  120. 'onUpdate:targetKeys': PropType<(keys: string[]) => void>;
  121. 'onUpdate:selectedKeys': PropType<(keys: string[]) => void>;
  122. };
  123. export declare type TransferProps = Partial<ExtractPropTypes<ReturnType<typeof transferProps>>>;
  124. declare const _default: {
  125. new (...args: any[]): {
  126. $: import("vue").ComponentInternalInstance;
  127. $data: {};
  128. $props: Partial<{
  129. listStyle: CSSProperties | ((style: ListStyle) => CSSProperties);
  130. disabled: boolean;
  131. locale: {};
  132. selectedKeys: string[];
  133. showSearch: boolean;
  134. pagination: any;
  135. dataSource: TransferItem[];
  136. showSelectAll: boolean;
  137. oneWay: boolean;
  138. targetKeys: string[];
  139. operationStyle: CSSProperties;
  140. }> & Omit<Readonly<ExtractPropTypes<{
  141. id: StringConstructor;
  142. prefixCls: StringConstructor;
  143. dataSource: {
  144. type: PropType<TransferItem[]>;
  145. default: any[];
  146. };
  147. disabled: {
  148. type: BooleanConstructor;
  149. default: any;
  150. };
  151. targetKeys: {
  152. type: PropType<string[]>;
  153. default: any;
  154. };
  155. selectedKeys: {
  156. type: PropType<string[]>;
  157. default: any;
  158. };
  159. render: {
  160. type: PropType<TransferRender<TransferItem>>;
  161. };
  162. listStyle: {
  163. type: PropType<CSSProperties | ((style: ListStyle) => CSSProperties)>;
  164. default: () => {};
  165. };
  166. operationStyle: {
  167. type: PropType<CSSProperties>;
  168. default: CSSProperties;
  169. };
  170. titles: {
  171. type: PropType<string[]>;
  172. };
  173. operations: {
  174. type: PropType<string[]>;
  175. };
  176. showSearch: {
  177. type: BooleanConstructor;
  178. default: boolean;
  179. };
  180. filterOption: {
  181. type: PropType<(inputValue: string, item: TransferItem) => boolean>;
  182. };
  183. searchPlaceholder: StringConstructor;
  184. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  185. locale: {
  186. type: PropType<Partial<TransferLocale>>;
  187. default: () => {};
  188. };
  189. rowKey: {
  190. type: PropType<(record: TransferItem) => string>;
  191. };
  192. showSelectAll: {
  193. type: BooleanConstructor;
  194. default: any;
  195. };
  196. selectAllLabels: {
  197. type: PropType<SelectAllLabel[]>;
  198. };
  199. children: {
  200. type: PropType<(props: Partial<ExtractPropTypes<{
  201. prefixCls: StringConstructor;
  202. filteredRenderItems: import("vue-types").VueTypeValidableDef<unknown[]> & {
  203. default: () => unknown[];
  204. } & {
  205. default: () => unknown[];
  206. };
  207. selectedKeys: import("vue-types").VueTypeValidableDef<unknown[]> & {
  208. default: () => unknown[];
  209. };
  210. disabled: {
  211. type: BooleanConstructor;
  212. default: any;
  213. };
  214. showRemove: {
  215. type: BooleanConstructor;
  216. default: any;
  217. };
  218. pagination: import("vue-types").VueTypeValidableDef<any>;
  219. onItemSelect: FunctionConstructor;
  220. onScroll: FunctionConstructor;
  221. onItemRemove: FunctionConstructor;
  222. }>>) => VueNode>;
  223. };
  224. oneWay: {
  225. type: BooleanConstructor;
  226. default: any;
  227. };
  228. pagination: {
  229. type: PropType<PaginationType>;
  230. default: any;
  231. };
  232. onChange: PropType<(targetKeys: string[], direction: TransferDirection, moveKeys: string[]) => void>;
  233. onSelectChange: PropType<(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void>;
  234. onSearch: PropType<(direction: TransferDirection, value: string) => void>;
  235. onScroll: PropType<(direction: TransferDirection, e: UIEvent) => void>;
  236. 'onUpdate:targetKeys': PropType<(keys: string[]) => void>;
  237. 'onUpdate:selectedKeys': PropType<(keys: string[]) => void>;
  238. }>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "listStyle" | "disabled" | "locale" | "selectedKeys" | "showSearch" | "pagination" | "dataSource" | "showSelectAll" | "oneWay" | "targetKeys" | "operationStyle">;
  239. $attrs: {
  240. [x: string]: unknown;
  241. };
  242. $refs: {
  243. [x: string]: unknown;
  244. };
  245. $slots: Readonly<{
  246. [name: string]: import("vue").Slot;
  247. }>;
  248. $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
  249. $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
  250. $emit: (event: string, ...args: any[]) => void;
  251. $el: any;
  252. $options: import("vue").ComponentOptionsBase<Readonly<ExtractPropTypes<{
  253. id: StringConstructor;
  254. prefixCls: StringConstructor;
  255. dataSource: {
  256. type: PropType<TransferItem[]>;
  257. default: any[];
  258. };
  259. disabled: {
  260. type: BooleanConstructor;
  261. default: any;
  262. };
  263. targetKeys: {
  264. type: PropType<string[]>;
  265. default: any;
  266. };
  267. selectedKeys: {
  268. type: PropType<string[]>;
  269. default: any;
  270. };
  271. render: {
  272. type: PropType<TransferRender<TransferItem>>;
  273. };
  274. listStyle: {
  275. type: PropType<CSSProperties | ((style: ListStyle) => CSSProperties)>;
  276. default: () => {};
  277. };
  278. operationStyle: {
  279. type: PropType<CSSProperties>;
  280. default: CSSProperties;
  281. };
  282. titles: {
  283. type: PropType<string[]>;
  284. };
  285. operations: {
  286. type: PropType<string[]>;
  287. };
  288. showSearch: {
  289. type: BooleanConstructor;
  290. default: boolean;
  291. };
  292. filterOption: {
  293. type: PropType<(inputValue: string, item: TransferItem) => boolean>;
  294. };
  295. searchPlaceholder: StringConstructor;
  296. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  297. locale: {
  298. type: PropType<Partial<TransferLocale>>;
  299. default: () => {};
  300. };
  301. rowKey: {
  302. type: PropType<(record: TransferItem) => string>;
  303. };
  304. showSelectAll: {
  305. type: BooleanConstructor;
  306. default: any;
  307. };
  308. selectAllLabels: {
  309. type: PropType<SelectAllLabel[]>;
  310. };
  311. children: {
  312. type: PropType<(props: Partial<ExtractPropTypes<{
  313. prefixCls: StringConstructor;
  314. filteredRenderItems: import("vue-types").VueTypeValidableDef<unknown[]> & {
  315. default: () => unknown[];
  316. } & {
  317. default: () => unknown[];
  318. };
  319. selectedKeys: import("vue-types").VueTypeValidableDef<unknown[]> & {
  320. default: () => unknown[];
  321. };
  322. disabled: {
  323. type: BooleanConstructor;
  324. default: any;
  325. };
  326. showRemove: {
  327. type: BooleanConstructor;
  328. default: any;
  329. };
  330. pagination: import("vue-types").VueTypeValidableDef<any>;
  331. onItemSelect: FunctionConstructor;
  332. onScroll: FunctionConstructor;
  333. onItemRemove: FunctionConstructor;
  334. }>>) => VueNode>;
  335. };
  336. oneWay: {
  337. type: BooleanConstructor;
  338. default: any;
  339. };
  340. pagination: {
  341. type: PropType<PaginationType>;
  342. default: any;
  343. };
  344. onChange: PropType<(targetKeys: string[], direction: TransferDirection, moveKeys: string[]) => void>;
  345. onSelectChange: PropType<(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void>;
  346. onSearch: PropType<(direction: TransferDirection, value: string) => void>;
  347. onScroll: PropType<(direction: TransferDirection, e: UIEvent) => void>;
  348. 'onUpdate:targetKeys': PropType<(keys: string[]) => void>;
  349. 'onUpdate:selectedKeys': PropType<(keys: string[]) => void>;
  350. }>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
  351. listStyle: CSSProperties | ((style: ListStyle) => CSSProperties);
  352. disabled: boolean;
  353. locale: {};
  354. selectedKeys: string[];
  355. showSearch: boolean;
  356. pagination: any;
  357. dataSource: TransferItem[];
  358. showSelectAll: boolean;
  359. oneWay: boolean;
  360. targetKeys: string[];
  361. operationStyle: CSSProperties;
  362. }> & {
  363. beforeCreate?: (() => void) | (() => void)[];
  364. created?: (() => void) | (() => void)[];
  365. beforeMount?: (() => void) | (() => void)[];
  366. mounted?: (() => void) | (() => void)[];
  367. beforeUpdate?: (() => void) | (() => void)[];
  368. updated?: (() => void) | (() => void)[];
  369. activated?: (() => void) | (() => void)[];
  370. deactivated?: (() => void) | (() => void)[];
  371. beforeDestroy?: (() => void) | (() => void)[];
  372. beforeUnmount?: (() => void) | (() => void)[];
  373. destroyed?: (() => void) | (() => void)[];
  374. unmounted?: (() => void) | (() => void)[];
  375. renderTracked?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
  376. renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
  377. errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>, info: string) => boolean | void)[];
  378. };
  379. $forceUpdate: () => void;
  380. $nextTick: typeof import("vue").nextTick;
  381. $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean>): import("vue").WatchStopHandle;
  382. } & Readonly<ExtractPropTypes<{
  383. id: StringConstructor;
  384. prefixCls: StringConstructor;
  385. dataSource: {
  386. type: PropType<TransferItem[]>;
  387. default: any[];
  388. };
  389. disabled: {
  390. type: BooleanConstructor;
  391. default: any;
  392. };
  393. targetKeys: {
  394. type: PropType<string[]>;
  395. default: any;
  396. };
  397. selectedKeys: {
  398. type: PropType<string[]>;
  399. default: any;
  400. };
  401. render: {
  402. type: PropType<TransferRender<TransferItem>>;
  403. };
  404. listStyle: {
  405. type: PropType<CSSProperties | ((style: ListStyle) => CSSProperties)>;
  406. default: () => {};
  407. };
  408. operationStyle: {
  409. type: PropType<CSSProperties>;
  410. default: CSSProperties;
  411. };
  412. titles: {
  413. type: PropType<string[]>;
  414. };
  415. operations: {
  416. type: PropType<string[]>;
  417. };
  418. showSearch: {
  419. type: BooleanConstructor;
  420. default: boolean;
  421. };
  422. filterOption: {
  423. type: PropType<(inputValue: string, item: TransferItem) => boolean>;
  424. };
  425. searchPlaceholder: StringConstructor;
  426. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  427. locale: {
  428. type: PropType<Partial<TransferLocale>>;
  429. default: () => {};
  430. };
  431. rowKey: {
  432. type: PropType<(record: TransferItem) => string>;
  433. };
  434. showSelectAll: {
  435. type: BooleanConstructor;
  436. default: any;
  437. };
  438. selectAllLabels: {
  439. type: PropType<SelectAllLabel[]>;
  440. };
  441. children: {
  442. type: PropType<(props: Partial<ExtractPropTypes<{
  443. prefixCls: StringConstructor;
  444. filteredRenderItems: import("vue-types").VueTypeValidableDef<unknown[]> & {
  445. default: () => unknown[];
  446. } & {
  447. default: () => unknown[];
  448. };
  449. selectedKeys: import("vue-types").VueTypeValidableDef<unknown[]> & {
  450. default: () => unknown[];
  451. };
  452. disabled: {
  453. type: BooleanConstructor;
  454. default: any;
  455. };
  456. showRemove: {
  457. type: BooleanConstructor;
  458. default: any;
  459. };
  460. pagination: import("vue-types").VueTypeValidableDef<any>;
  461. onItemSelect: FunctionConstructor;
  462. onScroll: FunctionConstructor;
  463. onItemRemove: FunctionConstructor;
  464. }>>) => VueNode>;
  465. };
  466. oneWay: {
  467. type: BooleanConstructor;
  468. default: any;
  469. };
  470. pagination: {
  471. type: PropType<PaginationType>;
  472. default: any;
  473. };
  474. onChange: PropType<(targetKeys: string[], direction: TransferDirection, moveKeys: string[]) => void>;
  475. onSelectChange: PropType<(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void>;
  476. onSearch: PropType<(direction: TransferDirection, value: string) => void>;
  477. onScroll: PropType<(direction: TransferDirection, e: UIEvent) => void>;
  478. 'onUpdate:targetKeys': PropType<(keys: string[]) => void>;
  479. 'onUpdate:selectedKeys': PropType<(keys: string[]) => void>;
  480. }>> & import("vue").ShallowUnwrapRef<() => JSX.Element> & {} & import("vue").ComponentCustomProperties;
  481. __isFragment?: never;
  482. __isTeleport?: never;
  483. __isSuspense?: never;
  484. } & import("vue").ComponentOptionsBase<Readonly<ExtractPropTypes<{
  485. id: StringConstructor;
  486. prefixCls: StringConstructor;
  487. dataSource: {
  488. type: PropType<TransferItem[]>;
  489. default: any[];
  490. };
  491. disabled: {
  492. type: BooleanConstructor;
  493. default: any;
  494. };
  495. targetKeys: {
  496. type: PropType<string[]>;
  497. default: any;
  498. };
  499. selectedKeys: {
  500. type: PropType<string[]>;
  501. default: any;
  502. };
  503. render: {
  504. type: PropType<TransferRender<TransferItem>>;
  505. };
  506. listStyle: {
  507. type: PropType<CSSProperties | ((style: ListStyle) => CSSProperties)>;
  508. default: () => {};
  509. };
  510. operationStyle: {
  511. type: PropType<CSSProperties>;
  512. default: CSSProperties;
  513. };
  514. titles: {
  515. type: PropType<string[]>;
  516. };
  517. operations: {
  518. type: PropType<string[]>;
  519. };
  520. showSearch: {
  521. type: BooleanConstructor;
  522. default: boolean;
  523. };
  524. filterOption: {
  525. type: PropType<(inputValue: string, item: TransferItem) => boolean>;
  526. };
  527. searchPlaceholder: StringConstructor;
  528. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  529. locale: {
  530. type: PropType<Partial<TransferLocale>>;
  531. default: () => {};
  532. };
  533. rowKey: {
  534. type: PropType<(record: TransferItem) => string>;
  535. };
  536. showSelectAll: {
  537. type: BooleanConstructor;
  538. default: any;
  539. };
  540. selectAllLabels: {
  541. type: PropType<SelectAllLabel[]>;
  542. };
  543. children: {
  544. type: PropType<(props: Partial<ExtractPropTypes<{
  545. prefixCls: StringConstructor;
  546. filteredRenderItems: import("vue-types").VueTypeValidableDef<unknown[]> & {
  547. default: () => unknown[];
  548. } & {
  549. default: () => unknown[];
  550. };
  551. selectedKeys: import("vue-types").VueTypeValidableDef<unknown[]> & {
  552. default: () => unknown[];
  553. };
  554. disabled: {
  555. type: BooleanConstructor;
  556. default: any;
  557. };
  558. showRemove: {
  559. type: BooleanConstructor;
  560. default: any;
  561. };
  562. pagination: import("vue-types").VueTypeValidableDef<any>;
  563. onItemSelect: FunctionConstructor;
  564. onScroll: FunctionConstructor;
  565. onItemRemove: FunctionConstructor;
  566. }>>) => VueNode>;
  567. };
  568. oneWay: {
  569. type: BooleanConstructor;
  570. default: any;
  571. };
  572. pagination: {
  573. type: PropType<PaginationType>;
  574. default: any;
  575. };
  576. onChange: PropType<(targetKeys: string[], direction: TransferDirection, moveKeys: string[]) => void>;
  577. onSelectChange: PropType<(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void>;
  578. onSearch: PropType<(direction: TransferDirection, value: string) => void>;
  579. onScroll: PropType<(direction: TransferDirection, e: UIEvent) => void>;
  580. 'onUpdate:targetKeys': PropType<(keys: string[]) => void>;
  581. 'onUpdate:selectedKeys': PropType<(keys: string[]) => void>;
  582. }>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
  583. listStyle: CSSProperties | ((style: ListStyle) => CSSProperties);
  584. disabled: boolean;
  585. locale: {};
  586. selectedKeys: string[];
  587. showSearch: boolean;
  588. pagination: any;
  589. dataSource: TransferItem[];
  590. showSelectAll: boolean;
  591. oneWay: boolean;
  592. targetKeys: string[];
  593. operationStyle: CSSProperties;
  594. }> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & import("@vue/runtime-core").Plugin;
  595. export default _default;