props.d.ts 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. import { IBaseProps } from '../_util/base';
  2. interface IStep {
  3. /**
  4. * @description 图片地址
  5. */
  6. imageUrl: string;
  7. /**
  8. * @description 图片模式
  9. */
  10. imageMode: string;
  11. /**
  12. * @description 图片内联样式
  13. */
  14. imageStyle: string;
  15. /**
  16. * @description 距离顶部
  17. */
  18. top: string;
  19. /**
  20. * @description 距离左边
  21. */
  22. left: string;
  23. /**
  24. * @description className
  25. */
  26. className?: string;
  27. }
  28. export interface IGuideTour extends IBaseProps {
  29. /**
  30. * @description 蒙层样式
  31. */
  32. maskStyle: string;
  33. /**
  34. * @description 蒙层 className
  35. */
  36. maskClassName?: string;
  37. /**
  38. * @description 步骤详情
  39. */
  40. items: IStep[];
  41. /**
  42. * @description 当前步骤
  43. */
  44. current: number;
  45. /**
  46. * @description 初始step
  47. */
  48. defaultCurrent: number;
  49. /**
  50. * @description 是否开启滑动模式
  51. */
  52. swiperable: boolean;
  53. /**
  54. * @description 引导是否可见, 受控
  55. * @default true
  56. */
  57. visible: boolean;
  58. /**
  59. * @description 关闭回调
  60. */
  61. onCancel: () => void;
  62. /**
  63. * @description 步骤改变回调
  64. */
  65. onChange: (index: number) => boolean;
  66. /**
  67. * @description 上一步按钮文案
  68. * @default "上一步"
  69. */
  70. prevStepText?: string;
  71. /**
  72. * @description 下一步按钮文案
  73. * @default "下一步"
  74. */
  75. nextStepText?: string;
  76. /**
  77. * @description 知道了按钮文案
  78. * @default "知道了"
  79. */
  80. gotItText?: string;
  81. /**
  82. * @description 跳过按钮文案
  83. * @default "跳过"
  84. */
  85. jumpText?: string;
  86. }
  87. export declare const GuideTourDefaultProps: Partial<IGuideTour>;
  88. export {};