/** * * TabView is a container component to group content with tabs. * * [Live Demo](https://www.primevue.org/tabview/) * * @module tabview * */ import { ButtonHTMLAttributes, VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; export declare type TabViewPassThroughOptionType = TabViewPassThroughAttributes | ((options: { props: TabViewProps; state: TabViewState }) => TabViewPassThroughAttributes) | null | undefined; /** * Custom tab change event. * @see {@link TabViewEmits['tab-change']} */ export interface TabViewChangeEvent { /** * Browser event */ originalEvent: Event; /** * Index of the selected tab */ index: number; } /** * Custom tab change event. * @see {@link TabViewEmits['tab-click']} * @extends TabViewChangeEvent */ export interface TabViewClickEvent extends TabViewChangeEvent {} /** * Custom passthrough(pt) options. * @see {@link TabViewProps.pt} */ export interface TabViewPassThroughOptions { /** * Uses to pass attributes to the root's DOM element. */ root?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the nav container's DOM element. */ navcontainer?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the nav content's DOM element. */ navcontent?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the list's DOM element. */ nav?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the list items' DOM element. */ tabheader?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the inkbar's DOM element. */ inkbar?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the previous button's DOM element. */ prevbutton?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the previous button icon's DOM element. */ previcon?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the nex button's DOM element. */ nextbutton?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the next button icon's DOM element. */ nexticon?: TabViewPassThroughOptionType; /** * Uses to pass attributes to the panel's DOM element. */ panelcontainer?: TabViewPassThroughOptionType; } /** * Custom passthrough attributes for each DOM elements */ export interface TabViewPassThroughAttributes { [key: string]: any; } /** * Defines current inline state in TabView component. */ export interface TabViewState { /** * Current active index state. */ d_activeIndex: number; /** * Unique id for the TabView component. */ id: string; /** * Current state of previous button. * @defaultValue true */ isPrevButtonDisabled: boolean; /** * Current state of the next button. * @defaultValue false */ isNextButtonDisabled: boolean; } /** * Defines valid properties in TabView component. */ export interface TabViewProps { /** * Index of the active tab. * @defaultValue 0 */ activeIndex?: number | undefined; /** * When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css. * @defaultValue false */ lazy?: boolean | undefined; /** * When enabled displays buttons at each side of the tab headers to scroll the tab list. * @defaultValue false */ scrollable?: boolean | undefined; /** * Index of the element in tabbing order. * @defaultValue 0 */ tabindex?: number | undefined; /** * When enabled, the focused tab is activated. * @defaultValue false */ selectOnFocus?: boolean | undefined; /** * Uses to pass all properties of the HTMLButtonElement to the previous button. * @deprecated since v3.26.0. Use 'pt' property instead. */ previousButtonProps?: ButtonHTMLAttributes | undefined; /** * Uses to pass all properties of the HTMLButtonElement to the next button. * @deprecated since v3.26.0. Use 'pt' property instead. */ nextButtonProps?: ButtonHTMLAttributes | undefined; /** * Uses to pass attributes to DOM elements inside the component. * @type {TabViewPassThroughOptions} */ pt?: TabViewPassThroughOptions; } /** * Defines valid slots in TabView slots. */ export interface TabViewSlots { /** * Default slot to detect TabPanel components. */ default(): VNode[]; /** * Previous button icon template for the scrollable component. */ previcon(): VNode[]; /** * Next button icon template for the scrollable component. */ nexticon(): VNode[]; } /** * Defines valid emits in TabView component. */ export interface TabViewEmits { /** * Emitted when the value changes. * @param {number} value - New value. */ 'update:modelValue'(value: number): void; /** * Callback to invoke when an active tab is changed. * @param {TabViewChangeEvent} event - Custom tab change event. */ 'tab-change'(event: TabViewChangeEvent): void; /** * Callback to invoke when an active tab is clicked. * @param {TabViewClickEvent} event - Custom tab click event. */ 'tab-click'(event: TabViewClickEvent): void; } /** * **PrimeVue - TabView** * * _TabView is a container component to group content with tabs._ * * [Live Demo](https://www.primevue.org/tabview/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component * */ declare class TabView extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents { TabView: GlobalComponentConstructor; } } export default TabView;