transfer.d.ts 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. import type { ExtractPropTypes, h as H, VNode } from 'vue';
  2. import type Transfer from './transfer.vue';
  3. export type TransferKey = string | number;
  4. export type TransferDirection = 'left' | 'right';
  5. export type TransferDataItem = Record<string, any>;
  6. export type renderContent = (h: typeof H, option: TransferDataItem) => VNode | VNode[];
  7. export interface TransferFormat {
  8. noChecked?: string;
  9. hasChecked?: string;
  10. }
  11. export interface TransferPropsAlias {
  12. label?: string;
  13. key?: string;
  14. disabled?: string;
  15. }
  16. export interface TransferCheckedState {
  17. leftChecked: TransferKey[];
  18. rightChecked: TransferKey[];
  19. }
  20. export declare const LEFT_CHECK_CHANGE_EVENT = "left-check-change";
  21. export declare const RIGHT_CHECK_CHANGE_EVENT = "right-check-change";
  22. export declare const transferProps: {
  23. readonly data: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferDataItem[]) | (() => TransferDataItem[]) | ((new (...args: any[]) => TransferDataItem[]) | (() => TransferDataItem[]))[], unknown, unknown, () => never[], boolean>;
  24. readonly titles: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => [string, string]) | (() => [string, string]) | ((new (...args: any[]) => [string, string]) | (() => [string, string]))[], unknown, unknown, () => never[], boolean>;
  25. readonly buttonTexts: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => [string, string]) | (() => [string, string]) | ((new (...args: any[]) => [string, string]) | (() => [string, string]))[], unknown, unknown, () => never[], boolean>;
  26. readonly filterPlaceholder: StringConstructor;
  27. readonly filterMethod: {
  28. readonly type: import("vue").PropType<(query: string, item: TransferDataItem) => boolean>;
  29. readonly required: false;
  30. readonly validator: ((val: unknown) => boolean) | undefined;
  31. __epPropKey: true;
  32. };
  33. readonly leftDefaultChecked: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferKey[]) | (() => TransferKey[]) | ((new (...args: any[]) => TransferKey[]) | (() => TransferKey[]))[], unknown, unknown, () => never[], boolean>;
  34. readonly rightDefaultChecked: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferKey[]) | (() => TransferKey[]) | ((new (...args: any[]) => TransferKey[]) | (() => TransferKey[]))[], unknown, unknown, () => never[], boolean>;
  35. readonly renderContent: {
  36. readonly type: import("vue").PropType<renderContent>;
  37. readonly required: false;
  38. readonly validator: ((val: unknown) => boolean) | undefined;
  39. __epPropKey: true;
  40. };
  41. readonly modelValue: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferKey[]) | (() => TransferKey[]) | ((new (...args: any[]) => TransferKey[]) | (() => TransferKey[]))[], unknown, unknown, () => never[], boolean>;
  42. readonly format: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferFormat) | (() => TransferFormat) | ((new (...args: any[]) => TransferFormat) | (() => TransferFormat))[], unknown, unknown, () => {}, boolean>;
  43. readonly filterable: BooleanConstructor;
  44. readonly props: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => TransferPropsAlias) | (() => TransferPropsAlias) | ((new (...args: any[]) => TransferPropsAlias) | (() => TransferPropsAlias))[], unknown, unknown, () => import("element-plus/es/utils").Mutable<{
  45. readonly label: "label";
  46. readonly key: "key";
  47. readonly disabled: "disabled";
  48. }>, boolean>;
  49. readonly targetOrder: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "push" | "unshift" | "original", unknown, "original", boolean>;
  50. readonly validateEvent: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  51. };
  52. export type TransferProps = ExtractPropTypes<typeof transferProps>;
  53. export declare const transferCheckedChangeFn: (value: TransferKey[], movedKeys?: TransferKey[]) => boolean;
  54. export declare const transferEmits: {
  55. change: (value: TransferKey[], direction: TransferDirection, movedKeys: TransferKey[]) => boolean;
  56. "update:modelValue": (value: TransferKey[]) => boolean;
  57. "left-check-change": (value: TransferKey[], movedKeys?: TransferKey[]) => boolean;
  58. "right-check-change": (value: TransferKey[], movedKeys?: TransferKey[]) => boolean;
  59. };
  60. export type TransferEmits = typeof transferEmits;
  61. export type TransferInstance = InstanceType<typeof Transfer> & unknown;