From 71675bff08dc9f600c3e777bd2644242346a79d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bahad=C4=B1r=20Sofuo=C4=9Flu?= Date: Wed, 1 Mar 2023 11:06:07 +0300 Subject: [PATCH] TabPanel TabView d.ts updated --- components/tabpanel/TabPanel.d.ts | 37 +++++++++++++++++--- components/tabview/TabView.d.ts | 56 +++++++++++++++++++++++++++---- 2 files changed, 81 insertions(+), 12 deletions(-) diff --git a/components/tabpanel/TabPanel.d.ts b/components/tabpanel/TabPanel.d.ts index ba6e7d85e..407d7adbc 100755 --- a/components/tabpanel/TabPanel.d.ts +++ b/components/tabpanel/TabPanel.d.ts @@ -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 { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Defines valid properties in TabPanel component. + */ export interface TabPanelProps { /** * Orientation of tab headers. @@ -36,10 +48,13 @@ export interface TabPanelProps { contentProps?: HTMLAttributes | undefined; /** * Whether the tab is disabled. + * @defaultValue false */ disabled?: boolean | undefined; } - +/** + * Defines valid slots in TabPanel slots. + */ export interface TabPanelSlots { /** * Custom content template. @@ -51,9 +66,21 @@ export interface TabPanelSlots { header: () => VNode[]; } -export declare type TabPanelEmits = {}; +export interface TabPanelEmits {} -declare class TabPanel extends ClassComponent {} +/** + * **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 {} declare module '@vue/runtime-core' { 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: * - * - [TabPanel](https://www.primefaces.org/primevue/tabpanel) + * - [TabPanel](https://www.primefaces.org/primevue/tabview) * */ export default TabPanel; diff --git a/components/tabview/TabView.d.ts b/components/tabview/TabView.d.ts index db7809af0..3ba36b975 100755 --- a/components/tabview/TabView.d.ts +++ b/components/tabview/TabView.d.ts @@ -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 { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Custom tab change event. + * @see tab-change + */ export interface TabViewChangeEvent { /** * Browser event @@ -13,29 +26,40 @@ export interface TabViewChangeEvent { } /** + * Custom tab change event. + * @see tab-click * @extends TabViewChangeEvent + */ export interface TabViewClickEvent extends TabViewChangeEvent {} +/** + * 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; /** @@ -48,32 +72,50 @@ export interface TabViewProps { nextButtonProps?: ButtonHTMLAttributes | undefined; } +/** + * Defines valid slots in TabView slots. + */ export interface TabViewSlots { /** * 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. * @param {number} value - New value. */ - 'update:modelValue': (value: number) => void; + '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; + '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; -}; + 'tab-click'(event: TabViewClickEvent): void; +} -declare class TabView extends ClassComponent {} +/** + * **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 {} declare module '@vue/runtime-core' { interface GlobalComponents {