Files
element-plus/packages/components/steps/src/steps.ts
Xc 8f4e8dc1ae docs(components): [steps] (#11854)
* Update steps docs with new syntax.
2023-04-07 14:39:36 +08:00

67 lines
1.5 KiB
TypeScript

import { CHANGE_EVENT } from '@element-plus/constants'
import { buildProps, isNumber } from '@element-plus/utils'
import type Steps from './steps.vue'
import type { ExtractPropTypes } from 'vue'
export const stepsProps = buildProps({
/**
* @description the spacing of each step, will be responsive if omitted. Supports percentage.
*/
space: {
type: [Number, String],
default: '',
},
/**
* @description current activation step
*/
active: {
type: Number,
default: 0,
},
/**
* @description display direction
*/
direction: {
type: String,
default: 'horizontal',
values: ['horizontal', 'vertical'],
},
/**
* @description center title and description
*/
alignCenter: {
type: Boolean,
},
/**
* @description whether to apply simple theme
*/
simple: {
type: Boolean,
},
/**
* @description status of end step
*/
finishStatus: {
type: String,
values: ['wait', 'process', 'finish', 'error', 'success'],
default: 'finish',
},
/**
* @description status of current step
*/
processStatus: {
type: String,
values: ['wait', 'process', 'finish', 'error', 'success'],
default: 'process',
},
} as const)
export type StepsProps = ExtractPropTypes<typeof stepsProps>
export const stepsEmits = {
[CHANGE_EVENT]: (newVal: number, oldVal: number) =>
[newVal, oldVal].every(isNumber),
}
export type StepsEmits = typeof stepsEmits
export type StepsInstance = InstanceType<typeof Steps>