diff --git a/src/components/steps/Steps.d.ts b/src/components/steps/Steps.d.ts index a8c6508df..c726f3239 100755 --- a/src/components/steps/Steps.d.ts +++ b/src/components/steps/Steps.d.ts @@ -1,19 +1,59 @@ -interface StepsProps { - id?: string; - model?: any[]; - readonly?: boolean; - exact?: boolean; +import { VNode } from 'vue'; +import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +import { MenuItem } from '../menuitem'; + +export interface StepsProps { + /** + * Unique identifier of the element. + */ + id?: string | undefined; + /** + * An array of menuitems. + */ + model?: MenuItem[] | undefined; + /** + * Whether the items are clickable or not. + * Default value is true. + */ + readonly?: boolean | undefined; + /** + * Whether to apply 'router-link-active-exact' class if route exactly matches the item path. + * Default value is true. + */ + exact?: boolean | undefined; } -interface StepsItemSlotInterface { - item: any; +export interface StepsSlots { + /** + * Custom item template. + * @param {Object} scope - item slot's params. + */ + item: (scope: { + /** + * Menuitem instance + */ + item: MenuItem; + }) => VNode[]; } -declare class Steps { - $props: StepsProps; - $slots: { - item: StepsItemSlotInterface; +export declare type StepsEmits = { +} + +declare class Steps extends ClassComponent { } + +declare module '@vue/runtime-core' { + interface GlobalComponents { + Steps: GlobalComponentConstructor } } +/** + * + * Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps. + * + * Demos: + * + * - [Steps](https://www.primefaces.org/primevue/showcase/#/steps) + * + */ export default Steps;