props.d.ts 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. import { IBaseProps } from '../../_util/base';
  2. export interface ICascaderOption {
  3. label: string;
  4. value: any;
  5. children?: ICascaderOption[];
  6. }
  7. /**
  8. * @description 级联组件,基于Picker封装
  9. */
  10. export interface ICascaderProps extends IBaseProps {
  11. visible?: boolean;
  12. defaultVisible?: boolean;
  13. /**
  14. * @desciption 动画类型
  15. * @default "transform"
  16. */
  17. animationType: 'transform' | 'position';
  18. /**
  19. * @description 当前数据
  20. */
  21. value: any[];
  22. /**
  23. * @description 默认值
  24. */
  25. defaultValue: any[];
  26. /**
  27. * @description 可选项数据
  28. */
  29. options: ICascaderOption[];
  30. /**
  31. * @description 提示文案
  32. * @default '请选择'
  33. */
  34. placeholder: string;
  35. /**
  36. * @description 取消文案
  37. * @default "取消"
  38. */
  39. cancelText: string;
  40. /**
  41. * @description 是否禁用
  42. */
  43. disabled?: boolean;
  44. /**
  45. * @description 标题
  46. */
  47. title: string;
  48. /**
  49. * @description 确定按钮文案
  50. * @default "确定"
  51. */
  52. okText: string;
  53. /**
  54. *@description 选中框样式
  55. * 版本要求: 支付宝小程序基础库 1.10.0 及以上
  56. */
  57. indicatorStyle?: string;
  58. /**
  59. *@description 选中框类名
  60. * 版本要求: 支付宝小程序基础库 1.10.0 及以上
  61. */
  62. indicatorClassName?: string;
  63. /**
  64. * @description 蒙层的样式。
  65. * 版本要求: 支付宝小程序基础库 1.10.0 及以上
  66. */
  67. maskStyle?: string;
  68. /**
  69. * @description 蒙层的类名。
  70. * 版本要求: 支付宝小程序基础库 1.10.0 及以上
  71. */
  72. maskClassName?: string;
  73. /**
  74. * @description 点击确认回调
  75. */
  76. onOk?: (value: any[], selectedOptions: ICascaderOption[], e: Record<string, any>) => void;
  77. /**
  78. * @description 点击取消回调
  79. */
  80. onCancel?: (e: Record<string, any>) => void;
  81. /**
  82. * @description 选中值的文本显示格式
  83. */
  84. onFormat?: (value: any[], selectedOptions: ICascaderOption[]) => string;
  85. /**
  86. * @description 切换显示隐藏
  87. */
  88. onVisibleChange?: (visible: boolean, e: Record<string, any>) => void;
  89. /**
  90. * @description 发生滚动即触发, 与 onChange 点击 ok 后触发不同
  91. */
  92. onChange?: (value: any[], selectedOptions: ICascaderOption[], e: Record<string, any>) => void;
  93. /**
  94. * @description 点击蒙层是否可以关闭
  95. * @default false
  96. */
  97. maskClosable: boolean;
  98. /**
  99. * @description 弹出框类名
  100. */
  101. popClassName: string;
  102. /**
  103. * @description 弹出框样式
  104. */
  105. popStyle: string;
  106. }
  107. export declare const CascaderDefaultProps: Partial<ICascaderProps>;