diff --git a/components/sidebar/Sidebar.d.ts b/components/sidebar/Sidebar.d.ts index 246eadc1e..5a42a365d 100755 --- a/components/sidebar/Sidebar.d.ts +++ b/components/sidebar/Sidebar.d.ts @@ -1,83 +1,111 @@ +/** + * + * Sidebar is a panel component displayed as an overlay at the edges of the screen. + * + * - [Live Demo](https://www.primefaces.org/primevue/sidebar) + * + * @module sidebar + * + */ import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; -type SidebarPositionType = 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined; - +/** + * Defines valid properties in Sidebar component. + */ export interface SidebarProps { /** * Specifies the visibility of the dialog. + * @defaultValue false */ visible?: boolean | undefined; /** * Specifies the position of the sidebar. - * @see SidebarPositionType - * Default value is 'left'. + * @defaultValue left */ - position?: SidebarPositionType; + position?: 'left' | 'right' | 'top' | 'bottom' | 'full' | undefined; /** * Base zIndex value to use in layering. - * Default value is 0. + * @defaultValue 0 */ baseZIndex?: number | undefined; /** * Whether to automatically manage layering. - * Default value is true. + * @defaultValue true */ autoZIndex?: boolean | undefined; /** * Whether clicking outside closes the panel. - * Default value is true. + * @defaultValue true */ dismissable?: boolean | undefined; /** * Whether to display a close icon inside the panel. - * Default value is true. + * @defaultValue true */ showCloseIcon?: boolean | undefined; /** * Icon to display in the sidebar close button. - * Default value is 'pi pi-times'. + * @defaultValue pi pi-times */ closeIcon?: string | undefined; /** * Whether to a modal layer behind the sidebar. - * Default value is true. + * @defaultValue true */ modal?: boolean | undefined; /** * Whether background scroll should be blocked when sidebar is visible. + * @defaultValue false */ blockScroll?: boolean | undefined; } +/** + * Defines valid slots in Sidebar component. + */ export interface SidebarSlots { /** * Custom content template. */ - default: () => VNode[]; + default(): VNode[]; /** * Custom header template. */ - header: () => VNode[]; + header(): VNode[]; } -export declare type SidebarEmits = { +/** + * Defines valid emits in Sidebar component. + */ +export interface SidebarEmits { /** * Emitted when the value changes. * @param {boolean} value - New value. */ - 'update:modelValue': (value: boolean) => void; + 'update:modelValue'(value: boolean): void; /** * Callback to invoke when sidebar gets shown. */ - show: () => void; + show(): void; /** * Callback to invoke when sidebar gets hidden. */ - hide: () => void; -}; + hide(): void; +} -declare class Sidebar extends ClassComponent {} +/** + * **PrimeVue - Sidebar** + * + * _Sidebar is a panel component displayed as an overlay._ + * + * [Live Demo](https://www.primevue.org/sidebar/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) + * + * @group Component + */ +export declare class Sidebar extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents {