122 lines
2.9 KiB
TypeScript
122 lines
2.9 KiB
TypeScript
/**
|
|
*
|
|
* StepList is a helper component for Stepper component.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/stepper/)
|
|
*
|
|
* @module steplist
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ComponentHooks } from '../basecomponent';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { DefineComponent, DesignToken, EmitFn, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
|
|
|
|
export declare type StepListPassThroughOptionType = StepListPassThroughAttributes | ((options: StepListPassThroughMethodOptions) => StepListPassThroughAttributes | string) | string | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface StepListPassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: StepListProps;
|
|
/**
|
|
* Defines valid attributes.
|
|
*/
|
|
attrs: any;
|
|
/**
|
|
* Defines parent options.
|
|
*/
|
|
parent: any;
|
|
/**
|
|
* Defines passthrough(pt) options in global config.
|
|
*/
|
|
global: object | undefined;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link StepListProps.pt}
|
|
*/
|
|
export interface StepListPassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: StepListPassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks.
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
}
|
|
|
|
export interface StepListPassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in StepList component.
|
|
*/
|
|
export interface StepListProps {
|
|
/**
|
|
* Value of step.
|
|
*/
|
|
value: string;
|
|
/**
|
|
* It generates scoped CSS variables using design tokens for the component.
|
|
*/
|
|
dt?: DesignToken<any>;
|
|
/**
|
|
* Used to pass attributes to DOM elements inside the component.
|
|
* @type {StepListPassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<StepListPassThroughOptions>;
|
|
/**
|
|
* Used to configure passthrough(pt) options of the component.
|
|
* @type {PassThroughOptions}
|
|
*/
|
|
ptOptions?: PassThroughOptions;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in StepList slots.
|
|
*/
|
|
export interface StepListSlots {
|
|
/**
|
|
* Custom content template.
|
|
*/
|
|
default(): VNode[];
|
|
}
|
|
|
|
export interface StepListEmitsOptions {}
|
|
|
|
export declare type StepListEmits = EmitFn<StepListEmitsOptions>;
|
|
|
|
/**
|
|
* **PrimeVue - StepList**
|
|
*
|
|
* _StepList is a helper component for Stepper component._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/stepper/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare const StepList: DefineComponent<StepListProps, StepListSlots, StepListEmits>;
|
|
|
|
declare module 'vue' {
|
|
export interface GlobalComponents {
|
|
StepList: GlobalComponentConstructor<StepListProps, StepListSlots, StepListEmits>;
|
|
}
|
|
}
|
|
|
|
export default StepList;
|