primevue-mirror/components/lib/steps/Steps.d.ts

236 lines
5.4 KiB
TypeScript
Raw Normal View History

2023-03-01 13:04:38 +00:00
/**
*
* 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
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
2022-09-06 12:03:37 +00:00
import { MenuItem } from '../menuitem';
2023-09-05 08:50:46 +00:00
import { PassThroughOptions } from '../passthrough';
import { DefineComponent, DesignToken, EmitFn, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
export declare type StepsPassThroughOptionType = StepsPassThroughAttributes | ((options: StepsPassThroughMethodOptions) => StepsPassThroughAttributes | string) | string | null | undefined;
2023-04-26 09:58:46 +00:00
/**
* Custom passthrough(pt) option method.
*/
export interface StepsPassThroughMethodOptions {
/**
* Defines instance.
*/
2023-07-06 12:01:33 +00:00
instance: any;
/**
* Defines valid properties.
*/
2023-04-26 09:58:46 +00:00
props: StepsProps;
/**
* Defines current options.
*/
2023-07-24 10:57:49 +00:00
context: StepsContext;
/**
* Defines valid attributes.
*/
attrs: any;
/**
* Defines parent options.
*/
parent: any;
2023-09-05 08:50:46 +00:00
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
2023-04-26 09:58:46 +00:00
}
/**
* Custom passthrough(pt) options.
* @see {@link StepsProps.pt}
*/
export interface StepsPassThroughOptions {
/**
* Used to pass attributes to the root's DOM element.
2023-04-26 09:58:46 +00:00
*/
root?: StepsPassThroughOptionType;
/**
* Used to pass attributes to the list's DOM element.
2023-04-26 09:58:46 +00:00
*/
list?: StepsPassThroughOptionType;
2023-04-26 09:58:46 +00:00
/**
* Used to pass attributes to the list item's DOM element.
2023-04-26 09:58:46 +00:00
*/
item?: StepsPassThroughOptionType;
2023-04-26 09:58:46 +00:00
/**
* Used to pass attributes to the item link's DOM element.
2023-04-26 09:58:46 +00:00
*/
itemLink?: StepsPassThroughOptionType;
2023-04-26 09:58:46 +00:00
/**
* Used to pass attributes to the item number's DOM element.
2023-04-26 09:58:46 +00:00
*/
itemNumber?: StepsPassThroughOptionType;
2023-04-26 09:58:46 +00:00
/**
* Used to pass attributes to the item label's DOM element.
2023-04-26 09:58:46 +00:00
*/
itemLabel?: StepsPassThroughOptionType;
2023-07-06 11:09:01 +00:00
/**
2023-11-07 06:16:39 +00:00
* Used to manage all lifecycle hooks.
2023-07-06 11:09:01 +00:00
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-04-26 09:58:46 +00:00
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface StepsPassThroughAttributes {
[key: string]: any;
}
2023-07-24 10:57:49 +00:00
/**
* Defines current options in Steps component.
*/
export interface StepsContext {
2023-07-25 09:11:49 +00:00
/**
* Current menuitem
*/
item: any;
2023-07-24 10:57:49 +00:00
/**
* Index of the menuitem.
*/
index: number;
/**
* Current active state of menuitem as a boolean.
* @defaultValue false
*/
active: boolean;
/**
* Current disabled state of menuitem as a boolean.
* @defaultValue false
*/
disabled: boolean;
}
/**
* Defines valid router binding props in Steps component.
*/
export interface StepsRouterBindProps {
/**
* Action element binding
*/
action: object;
/**
* Icon element binding
*/
step: object;
/**
* Label element binding
*/
label: object;
}
2023-03-01 13:04:38 +00:00
/**
* Defines valid properties in Steps component.
*/
2022-09-06 12:03:37 +00:00
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.
2023-03-01 13:04:38 +00:00
* @defaultValue true
2022-09-06 12:03:37 +00:00
*/
readonly?: boolean | undefined;
/**
* Active step index of menuitem.
* @defaultValue 0
*/
activeStep?: number | undefined;
/**
* It generates scoped CSS variables using design tokens for the component.
*/
dt?: DesignToken<any>;
2023-04-26 09:58:46 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to DOM elements inside the component.
2023-04-26 09:58:46 +00:00
* @type {StepsPassThroughOptions}
*/
pt?: PassThrough<StepsPassThroughOptions>;
2023-09-05 08:50:46 +00:00
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
2023-05-30 11:58:41 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
2023-03-01 13:04:38 +00:00
/**
* Defines valid slots in Steps component.
*/
2022-09-06 12:03:37 +00:00
export interface StepsSlots {
/**
* Custom item template.
* @param {Object} scope - item slot's params.
*/
2023-03-01 13:04:38 +00:00
item(scope: {
2022-09-06 12:03:37 +00:00
/**
* Menuitem instance
*/
item: MenuItem;
/**
* Current active state of the menuitem
*/
active: boolean;
2023-08-30 14:29:26 +00:00
/**
* Label property of the menuitem
*/
label: string | ((...args: any) => string) | undefined;
/**
* Order of the menuitem
*/
index: number;
/**
* Binding properties of the menuitem
*/
props: StepsRouterBindProps;
2023-03-01 13:04:38 +00:00
}): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-03-01 13:04:38 +00:00
/**
* Defines valid emits in Steps component.
*/
2024-05-16 14:05:43 +00:00
export interface StepsEmitsOptions {}
export declare type StepsEmits = EmitFn<StepsEmitsOptions>;
2022-09-06 12:03:37 +00:00
2023-03-01 13:04:38 +00:00
/**
* **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/)
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-03-01 13:04:38 +00:00
*
* @group Component
*
*/
declare const Steps: DefineComponent<StepsProps, StepsSlots, StepsEmits>;
2022-09-06 12:03:37 +00:00
declare module 'vue' {
export interface GlobalComponents {
Steps: GlobalComponentConstructor<StepsProps, StepsSlots, StepsEmits>;
2022-09-06 12:03:37 +00:00
}
}
export default Steps;