steps.d.ts 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. import { EpPropFinalized, EpPropMergeType } from "../../../utils/vue/props/types.js";
  2. import "../../../utils/index.js";
  3. import { _default } from "./steps.vue.js";
  4. import * as vue from "vue";
  5. import { ExtractPublicPropTypes } from "vue";
  6. //#region ../../packages/components/steps/src/steps.d.ts
  7. type StepsStatus = 'wait' | 'process' | 'finish' | 'error' | 'success';
  8. interface StepsProps {
  9. /**
  10. * @description the spacing of each step, will be responsive if omitted. Supports percentage.
  11. * @default ''
  12. */
  13. space?: number | string;
  14. /**
  15. * @description current activation step
  16. * @default 0
  17. */
  18. active?: number;
  19. /**
  20. * @description display direction
  21. * @default 'horizontal'
  22. */
  23. direction?: 'horizontal' | 'vertical';
  24. /**
  25. * @description center title and description
  26. */
  27. alignCenter?: boolean;
  28. /**
  29. * @description whether to apply simple theme
  30. */
  31. simple?: boolean;
  32. /**
  33. * @description status of end step
  34. * @default 'finish'
  35. */
  36. finishStatus?: StepsStatus;
  37. /**
  38. * @description status of current step
  39. * @default 'process'
  40. */
  41. processStatus?: StepsStatus;
  42. }
  43. /**
  44. * @deprecated Removed after 3.0.0, Use `StepsProps` instead.
  45. */
  46. declare const stepsProps: {
  47. readonly space: EpPropFinalized<readonly [NumberConstructor, StringConstructor], unknown, unknown, "", boolean>;
  48. readonly active: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  49. readonly direction: EpPropFinalized<StringConstructor, "horizontal" | "vertical", unknown, "horizontal", boolean>;
  50. readonly alignCenter: {
  51. readonly type: vue.PropType<EpPropMergeType<BooleanConstructor, unknown, unknown>>;
  52. readonly required: false;
  53. readonly validator: ((val: unknown) => boolean) | undefined;
  54. __epPropKey: true;
  55. };
  56. readonly simple: {
  57. readonly type: vue.PropType<EpPropMergeType<BooleanConstructor, unknown, unknown>>;
  58. readonly required: false;
  59. readonly validator: ((val: unknown) => boolean) | undefined;
  60. __epPropKey: true;
  61. };
  62. readonly finishStatus: EpPropFinalized<StringConstructor, "success" | "error" | "wait" | "finish" | "process", unknown, "finish", boolean>;
  63. readonly processStatus: EpPropFinalized<StringConstructor, "success" | "error" | "wait" | "finish" | "process", unknown, "process", boolean>;
  64. };
  65. /**
  66. * @deprecated Removed after 3.0.0, Use `StepsProps` instead.
  67. */
  68. type StepsPropsPublic = ExtractPublicPropTypes<typeof stepsProps>;
  69. declare const stepsEmits: {
  70. change: (newVal: number, oldVal: number) => boolean;
  71. };
  72. type StepsEmits = typeof stepsEmits;
  73. type StepsInstance = InstanceType<typeof _default> & unknown;
  74. //#endregion
  75. export { StepsEmits, StepsInstance, StepsProps, StepsPropsPublic, StepsStatus, stepsEmits, stepsProps };