Steps d.ts updated

pull/3689/head
mertsincan 2023-03-01 13:04:38 +00:00
parent 2d343263b4
commit 757609cc44
1 changed files with 36 additions and 15 deletions

View File

@ -1,7 +1,19 @@
/**
*
* Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps.
*
* [Live Demo](https://www.primevue.org/steps/)
*
* @module steps
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
import { MenuItem } from '../menuitem'; import { MenuItem } from '../menuitem';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in Steps component.
*/
export interface StepsProps { export interface StepsProps {
/** /**
* Unique identifier of the element. * Unique identifier of the element.
@ -13,31 +25,49 @@ export interface StepsProps {
model?: MenuItem[] | undefined; model?: MenuItem[] | undefined;
/** /**
* Whether the items are clickable or not. * Whether the items are clickable or not.
* Default value is true. * @defaultValue true
*/ */
readonly?: boolean | undefined; readonly?: boolean | undefined;
/** /**
* Whether to apply 'router-link-active-exact' class if route exactly matches the item path. * Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
* Default value is true. * @defaultValue true
*/ */
exact?: boolean | undefined; exact?: boolean | undefined;
} }
/**
* Defines valid slots in Steps component.
*/
export interface StepsSlots { export interface StepsSlots {
/** /**
* Custom item template. * Custom item template.
* @param {Object} scope - item slot's params. * @param {Object} scope - item slot's params.
*/ */
item: (scope: { item(scope: {
/** /**
* Menuitem instance * Menuitem instance
*/ */
item: MenuItem; item: MenuItem;
}) => VNode[]; }): VNode[];
} }
export declare type StepsEmits = {}; /**
* Defines valid emits in Steps component.
*/
export interface StepsEmits {}
/**
* **PrimeVue - Steps**
*
* _Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps._
*
* [Live Demo](https://www.primevue.org/steps/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
declare class Steps extends ClassComponent<StepsProps, StepsSlots, StepsEmits> {} declare class Steps extends ClassComponent<StepsProps, StepsSlots, StepsEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
@ -46,13 +76,4 @@ declare module '@vue/runtime-core' {
} }
} }
/**
*
* 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/steps)
*
*/
export default Steps; export default Steps;