TabPanel TabView d.ts updated

pull/3689/head
Bahadır Sofuoğlu 2023-03-01 11:06:07 +03:00
parent 38f1eef021
commit 71675bff08
2 changed files with 81 additions and 12 deletions

View File

@ -1,6 +1,18 @@
/**
*
* TabPanel is a helper component for TabPanel component.
*
* [Live Demo](https://www.primevue.org/tabview/)
*
* @module tabpanel
*
*/
import { AnchorHTMLAttributes, HTMLAttributes, LiHTMLAttributes, VNode } from 'vue'; import { AnchorHTMLAttributes, HTMLAttributes, LiHTMLAttributes, VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in TabPanel component.
*/
export interface TabPanelProps { export interface TabPanelProps {
/** /**
* Orientation of tab headers. * Orientation of tab headers.
@ -36,10 +48,13 @@ export interface TabPanelProps {
contentProps?: HTMLAttributes | undefined; contentProps?: HTMLAttributes | undefined;
/** /**
* Whether the tab is disabled. * Whether the tab is disabled.
* @defaultValue false
*/ */
disabled?: boolean | undefined; disabled?: boolean | undefined;
} }
/**
* Defines valid slots in TabPanel slots.
*/
export interface TabPanelSlots { export interface TabPanelSlots {
/** /**
* Custom content template. * Custom content template.
@ -51,9 +66,21 @@ export interface TabPanelSlots {
header: () => VNode[]; header: () => VNode[];
} }
export declare type TabPanelEmits = {}; export interface TabPanelEmits {}
declare class TabPanel extends ClassComponent<TabPanelProps, TabPanelSlots, TabPanelEmits> {} /**
* **PrimeVue - TabPanel**
*
* _TabPanel is a helper component for TabPanel component._
*
* [Live Demo](https://www.primevue.org/tabview/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
export declare class TabPanel extends ClassComponent<TabPanelProps, TabPanelSlots, TabPanelEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
interface GlobalComponents { interface GlobalComponents {
@ -63,11 +90,11 @@ declare module '@vue/runtime-core' {
/** /**
* *
* TabPanel is a helper component for TabView component. * TabPanel is a helper component for TabPanel component.
* *
* Demos: * Demos:
* *
* - [TabPanel](https://www.primefaces.org/primevue/tabpanel) * - [TabPanel](https://www.primefaces.org/primevue/tabview)
* *
*/ */
export default TabPanel; export default TabPanel;

View File

@ -1,6 +1,19 @@
/**
*
* 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 { ButtonHTMLAttributes, VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Custom tab change event.
* @see tab-change
*/
export interface TabViewChangeEvent { export interface TabViewChangeEvent {
/** /**
* Browser event * Browser event
@ -13,29 +26,40 @@ export interface TabViewChangeEvent {
} }
/** /**
* Custom tab change event.
* @see tab-click
* @extends TabViewChangeEvent * @extends TabViewChangeEvent
*/ */
export interface TabViewClickEvent extends TabViewChangeEvent {} export interface TabViewClickEvent extends TabViewChangeEvent {}
/**
* Defines valid properties in TabView component.
*/
export interface TabViewProps { export interface TabViewProps {
/** /**
* Index of the active tab. * Index of the active tab.
* @defaultValue 0
*/ */
activeIndex?: number | undefined; activeIndex?: number | undefined;
/** /**
* When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css. * When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css.
* @defaultValue false
*/ */
lazy?: boolean | undefined; lazy?: boolean | undefined;
/** /**
* When enabled displays buttons at each side of the tab headers to scroll the tab list. * When enabled displays buttons at each side of the tab headers to scroll the tab list.
* @defaultValue false
*/ */
scrollable?: boolean | undefined; scrollable?: boolean | undefined;
/** /**
* Index of the element in tabbing order. * Index of the element in tabbing order.
* @defaultValue 0
*/ */
tabindex?: number | undefined; tabindex?: number | undefined;
/** /**
* When enabled, the focused tab is activated. * When enabled, the focused tab is activated.
* @defaultValue false
*/ */
selectOnFocus?: boolean | undefined; selectOnFocus?: boolean | undefined;
/** /**
@ -48,32 +72,50 @@ export interface TabViewProps {
nextButtonProps?: ButtonHTMLAttributes | undefined; nextButtonProps?: ButtonHTMLAttributes | undefined;
} }
/**
* Defines valid slots in TabView slots.
*/
export interface TabViewSlots { export interface TabViewSlots {
/** /**
* Default slot to detect TabPanel components. * Default slot to detect TabPanel components.
*/ */
default: () => VNode[]; default(): VNode[];
} }
export declare type TabViewEmits = { /**
* Defines valid emits in TabView component.
*/
export interface TabViewEmits {
/** /**
* Emitted when the value changes. * Emitted when the value changes.
* @param {number} value - New value. * @param {number} value - New value.
*/ */
'update:modelValue': (value: number) => void; 'update:modelValue'(value: number): void;
/** /**
* Callback to invoke when an active tab is changed. * Callback to invoke when an active tab is changed.
* @param {TabViewChangeEvent} event - Custom tab change event. * @param {TabViewChangeEvent} event - Custom tab change event.
*/ */
'tab-change': (event: TabViewChangeEvent) => void; 'tab-change'(event: TabViewChangeEvent): void;
/** /**
* Callback to invoke when an active tab is clicked. * Callback to invoke when an active tab is clicked.
* @param {TabViewClickEvent} event - Custom tab click event. * @param {TabViewClickEvent} event - Custom tab click event.
*/ */
'tab-click': (event: TabViewClickEvent) => void; 'tab-click'(event: TabViewClickEvent): void;
}; }
declare class TabView extends ClassComponent<TabViewProps, TabViewSlots, TabViewEmits> {} /**
* **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.svg)
*
* @group Component
*
*/
export declare class TabView extends ClassComponent<TabViewProps, TabViewSlots, TabViewEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
interface GlobalComponents { interface GlobalComponents {