143 lines
3.3 KiB
TypeScript
Executable File
143 lines
3.3 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* TabList is a helper component for Tabs component.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/tabs/)
|
|
*
|
|
* @module tablist
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ComponentHooks } from '../basecomponent';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { ClassComponent, DesignToken, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
|
|
|
|
export declare type TabListPassThroughOptionType = TabListPassThroughAttributes | ((options: TabListPassThroughMethodOptions) => TabListPassThroughAttributes | string) | string | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface TabListPassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: TabListProps;
|
|
/**
|
|
* Defines current options.
|
|
*/
|
|
context: TabListContext;
|
|
/**
|
|
* 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 TabListProps.pt}
|
|
*/
|
|
export interface TabListPassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: TabListPassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the previous button component.
|
|
*/
|
|
previousButton?: TabListPassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the next button component.
|
|
*/
|
|
nextButton?: TabListPassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the list's DOM element.
|
|
*/
|
|
content?: TabListPassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the inkbar's DOM element.
|
|
*/
|
|
inkbar?: TabListPassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks.
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
}
|
|
|
|
export interface TabListPassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in TabList component.
|
|
*/
|
|
export interface TabListProps {
|
|
/**
|
|
* 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 {TabListPassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<TabListPassThroughOptions>;
|
|
/**
|
|
* Used to configure passthrough(pt) options of the component.
|
|
* @type {PassThroughOptions}
|
|
*/
|
|
ptOptions?: PassThroughOptions;
|
|
}
|
|
|
|
/**
|
|
* Defines current options in TabList component.
|
|
*/
|
|
export interface TabListContext {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in TabList slots.
|
|
*/
|
|
export interface TabListSlots {
|
|
/**
|
|
* Custom content template.
|
|
*/
|
|
default(): VNode[];
|
|
}
|
|
|
|
export interface TabListEmits {}
|
|
|
|
/**
|
|
* **PrimeVue - TabList**
|
|
*
|
|
* _TabList is a helper component for Tabs component._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/tabs/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class TabList extends ClassComponent<TabListProps, TabListSlots, TabListEmits> {}
|
|
|
|
declare module 'vue' {
|
|
export interface GlobalComponents {
|
|
TabList: GlobalComponentConstructor<TabList>;
|
|
}
|
|
}
|
|
|
|
export default TabList;
|