diff --git a/components/panel/Panel.d.ts b/components/panel/Panel.d.ts index 39271deaf..06caa2770 100755 --- a/components/panel/Panel.d.ts +++ b/components/panel/Panel.d.ts @@ -1,6 +1,19 @@ +/** + * + * Panel is a container with the optional content toggle feature. + * + * [Live Demo](https://www.primevue.org/panel/) + * + * @module panel + * + */ import { ButtonHTMLAttributes, VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Custom toggle event. + * @see toggle + */ export interface PanelToggleEvent { /** * Browser event. @@ -12,6 +25,9 @@ export interface PanelToggleEvent { value: boolean; } +/** + * Defines valid properties in Panel component. + */ export interface PanelProps { /** * Header text of the panel. @@ -31,22 +47,28 @@ export interface PanelProps { toggleButtonProps?: ButtonHTMLAttributes | undefined; } +/** + * Defines valid slots in Panel slots. + */ export interface PanelSlots { /** * Custom content template. */ - default: () => VNode[]; + default(): VNode[]; /** * Custom header template. */ - header: () => VNode[]; + header(): VNode[]; /** * Custom icons template. */ - icons: () => VNode[]; + icons(): VNode[]; } -export declare type PanelEmits = { +/** + * Defines valid emits in Panel component. + */ +export interface PanelEmits { /** * Emitted when the collapsed changes. * @param {boolean} value - New value. @@ -57,9 +79,21 @@ export declare type PanelEmits = { * @param {PanelToggleEvent} event - Custom toggle event. */ toggle: (event: PanelToggleEvent) => void; -}; +} -declare class Panel extends ClassComponent {} +/** + * **PrimeVue - Panel** + * + * _Panel is a container with the optional content toggle feature._ + * + * [Live Demo](https://www.primevue.org/panel/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + * @group Component + * + */ +export declare class Panel extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents {