primevue 3.23.0 → 3.24.0

package/scrolltop/ScrollTop.d.ts

@@ -1,35 +1,61 @@
+/**
+ *
+ * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
+ *
+ * [Live Demo](https://www.primevue.org/scrolltop/)
+ *
+ * @module scrolltop
+ *
+ */
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type ScrollTopTargetType = 'window' | 'parent' | undefined;
-
+/**
+ * Defines valid properties in ScrollTop component.
+ */
 export interface ScrollTopProps {
     /**
      * Target of the ScrollTop.
-     * @see ScrollTopTargetType
-     * Default value is 'window'.
+     * @defaultValue window
      */
-    target?: ScrollTopTargetType;
+    target?: 'window' | 'parent' | undefined;
     /**
      * Defines the threshold value of the vertical scroll position of the target to toggle the visibility.
-     * Default value is 400.
+     * @defaultValue 400
      */
     threshold?: number | undefined;
     /**
      * Icon to display.
-     * Default value is 'pi pi-chevron-up'.
+     * @defaultValue pi pi-chevron-up
      */
     icon?: string | undefined;
     /**
      * Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump.
-     * Default value is 'smooth'.
+     * @defaultValue smooth
      */
     behavior?: string | undefined;
 }
 
+/**
+ * Defines valid slots in ScrollTop component.
+ */
 export interface ScrollTopSlots {}
 
-export declare type ScrollTopEmits = {};
+/**
+ * Defines valid emits in ScrollTop component.
+ */
+export interface ScrollTopEmits {}
 
+/**
+ * **PrimeVue - ScrollTop**
+ *
+ * _ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly._
+ *
+ * [Live Demo](https://www.primevue.org/scrolltop/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class ScrollTop extends ClassComponent<ScrollTopProps, ScrollTopSlots, ScrollTopEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -38,13 +64,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
- *
- * Demos:
- *
- * - [ScrollTop](https://www.primefaces.org/primevue/scrolltop)
- *
- */
 export default ScrollTop;

package/selectbutton/SelectButton.d.ts

@@ -1,12 +1,19 @@
+/**
+ *
+ * SelectButton is used to choose single or multiple items from a list using buttons.
+ *
+ * [Live Demo](https://www.primevue.org/selectbutton/)
+ *
+ * @module selectbutton
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type SelectButtonOptionLabelType = string | ((data: any) => string) | undefined;
-
-type SelectButtonOptionValueType = string | ((data: any) => any) | undefined;
-
-type SelectButtonOptionDisabledType = string | ((data: any) => boolean) | undefined;
-
+/**
+ * Custom change event.
+ * @see {@link SelectButtonEmits.change}
+ */
 export interface SelectButtonChangeEvent {
     /**
      * Browser event.
@@ -18,6 +25,9 @@ export interface SelectButtonChangeEvent {
     value: any;
 }
 
+/**
+ * Defines valid properties in SelectButton component.
+ */
 export interface SelectButtonProps {
     /**
      * Value of the component.
@@ -30,21 +40,23 @@ export interface SelectButtonProps {
     /**
      * Property name or getter function to use as the label of an option.
      */
-    optionLabel?: SelectButtonOptionLabelType;
+    optionLabel?: string | ((data: any) => string) | undefined;
     /**
      * Property name or getter function to use as the value of an option, defaults to the option itself when not defined.
      */
-    optionValue?: SelectButtonOptionValueType;
+    optionValue?: string | ((data: any) => any) | undefined;
     /**
      * Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.
      */
-    optionDisabled?: SelectButtonOptionDisabledType;
+    optionDisabled?: string | ((data: any) => boolean) | undefined;
     /**
      * When specified, allows selecting multiple values.
+     * @defaultValue false
      */
     multiple?: boolean | undefined;
     /**
      * When present, it specifies that the element should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
@@ -53,6 +65,7 @@ export interface SelectButtonProps {
     dataKey?: string | undefined;
     /**
      * Whether selection can be cleared.
+     * @defaultValue true
      */
     unselectable?: boolean | undefined;
     /**
@@ -61,12 +74,15 @@ export interface SelectButtonProps {
     'aria-labelledby'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in SelectButton component.
+ */
 export interface SelectButtonSlots {
     /**
      * Custom content for each option.
      * @param {Object} scope - option slot's params.
      */
-    option: (scope: {
+    option(scope: {
         /**
          * Option instance
          */
@@ -75,32 +91,45 @@ export interface SelectButtonSlots {
          * Index of the option
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type SelectButtonEmits = {
+/**
+ * Defines valid emits in SelectButton component.
+ */
+export interface SelectButtonEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:modelValue': (value: any) => void;
+    'update:modelValue'(value: any): void;
     /**
      * Callback to invoke on value change.
      * @param {SelectButtonChangeEvent} event - Custom change event.
      */
-    change: (event: SelectButtonChangeEvent) => void;
+    change(event: SelectButtonChangeEvent): void;
     /**
      * Callback to invoke on focus.
-     * @param {SelectButtonChangeEvent} event - Browser event.
      */
-    focus: (event: Event) => void;
+    focus(event: Event): void;
     /**
      * Callback to invoke on blur.
      * @param {Event} event - Browser event.
      */
-    blur: (event: Event) => void;
-};
+    blur(event: Event): void;
+}
 
+/**
+ * **PrimeVue - SelectButton**
+ *
+ * _SelectButton is used to choose single or multiple items from a list using buttons._
+ *
+ * [Live Demo](https://www.primevue.org/selectbutton/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class SelectButton extends ClassComponent<SelectButtonProps, SelectButtonSlots, SelectButtonEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -109,13 +138,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * SelectButton is a form component to choose a value from a list of options using button elements.
- *
- * Demos:
- *
- * - [SelectButton](https://www.primefaces.org/primevue/selectbutton)
- *
- */
 export default SelectButton;

package/sidebar/Sidebar.d.ts

@@ -1,82 +1,110 @@
+/**
+ *
+ * Sidebar is a panel component displayed as an overlay at the edges of the screen.
+ *
+ * [Live Demo](https://primevue.org/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;
+}
 
+/**
+ * **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
+ */
 declare class Sidebar extends ClassComponent<SidebarProps, SidebarSlots, SidebarEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -85,13 +113,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Sidebar is a panel component displayed as an overlay at the edges of the screen.
- *
- * Demos:
- *
- * - [Sidebar](https://www.primefaces.org/primevue/sidebar)
- *
- */
 export default Sidebar;

package/skeleton/Skeleton.d.ts

@@ -1,28 +1,35 @@
+/**
+ *
+ * Skeleton is a placeholder to display instead of the actual content.
+ *
+ * [Live Demo](https://www.primevue.org/skeleton/)
+ *
+ * @module skeleton
+ *
+ */
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type SkeletonShapeType = 'rectangle' | 'circle' | undefined;
-
-type SkeletonAnimationType = 'wave' | 'none' | undefined;
-
+/**
+ * Defines valid properties in Skeleton component.
+ */
 export interface SkeletonProps {
     /**
      * Shape of the element.
-     * @see SkeletonShapeType
-     * Default value is 'rectangle'.
+     * @defaultValue rectangle
      */
-    shape?: SkeletonShapeType;
+    shape?: 'rectangle' | 'circle' | undefined;
     /**
      * Size of the Circle or Square.
      */
     size?: string | undefined;
     /**
      * Width of the element.
-     * Default value is '100%'.
+     * @defaultValue 100%
      */
     width?: string | undefined;
     /**
      * Height of the element.
-     * Default value is '1rem'.
+     * @defaultValue 1rem
      */
     height?: string | undefined;
     /**
@@ -31,16 +38,32 @@ export interface SkeletonProps {
     borderRadius?: string | undefined;
     /**
      * Type of the animation.
-     * @see SkeletonAnimationType
-     * Default value is 'wave'.
+     * @defaultValue wave
      */
-    animation?: SkeletonAnimationType;
+    animation?: 'wave' | 'none' | undefined;
 }
 
+/**
+ * Defines valid slots in Skeleton component.
+ */
 export interface SkeletonSlots {}
 
-export declare type SkeletonEmits = {};
+/**
+ * Defines valid emits in Skeleton component.
+ */
+export interface SkeletonEmits {}
 
+/**
+ * **PrimeVue - Skeleton**
+ *
+ * _Skeleton is a placeholder to display instead of the actual content._
+ *
+ * [Live Demo](https://www.primevue.org/skeleton/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Skeleton extends ClassComponent<SkeletonProps, SkeletonSlots, SkeletonEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -49,13 +72,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Skeleton is a placeholder to display instead of the actual content.
- *
- * Demos:
- *
- * - [Skeleton](https://www.primefaces.org/primevue/skeleton)
- *
- */
 export default Skeleton;

package/slider/Slider.d.ts

@@ -1,7 +1,18 @@
+/**
+ *
+ * Slider is a component to provide input with a drag handle.
+ *
+ * [Live Demo](https://www.primevue.org/slider/)
+ *
+ * @module slider
+ *
+ */
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type SliderOrientationType = 'horizontal' | 'vertical' | undefined;
-
+/**
+ * Custom slide end event.
+ * @see {@link SliderEmits.slideend}
+ */
 export interface SliderSlideEndEvent {
     /**
      * Original event
@@ -13,39 +24,42 @@ export interface SliderSlideEndEvent {
     value: number;
 }
 
+/**
+ * Defines valid properties in Slider component.
+ */
 export interface SliderProps {
     /**
      * Value of the component.
-     * Default value is 0.
      */
     modelValue?: number | number[] | undefined;
     /**
      * Mininum boundary value.
-     * Default value is 0.
+     * @defaultValue 0
      */
     min?: number | undefined;
     /**
      * Maximum boundary value.
-     * Default value is 100.
+     * @defaultValue 100
      */
     max?: number | undefined;
     /**
      * Orientation of the slider.
-     * @see SliderOrientationType
-     * Default value is 'horizontal'.
+     * @defaultValue horizontal
      */
-    orientation?: SliderOrientationType;
+    orientation?: 'horizontal' | 'vertical' | undefined;
     /**
      * Step factor to increment/decrement the value.
-     * Default value is 1.
+     * @defaultValue 1
      */
     step?: number | undefined;
     /**
      * When speficed, allows two boundary values to be picked.
+     * @defaultValue false
      */
     range?: boolean | undefined;
     /**
      * When present, it specifies that the component should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
@@ -62,26 +76,44 @@ export interface SliderProps {
     'aria-label'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in Slider component.
+ */
 export interface SliderSlots {}
 
-export declare type SliderEmits = {
+/**
+ * Defines valid emits in Slider component.
+ */
+export interface SliderEmits {
     /**
      * Emitted when the value changes.
      * @param {number | number[]} value - New value.
      */
-    'update:modelValue': (value: number | number[]) => void;
+    'update:modelValue'(value: number | number[]): void;
     /**
      * Callback to invoke on value change.
      * @param {number} value - New value
      */
-    change: (value: number) => void;
+    change(value: number): void;
     /**
      * Callback to invoke when slide ends.
      * @param {SliderSlideEndEvent} event - Custom slide end event.
      */
-    slideend: (event: SliderSlideEndEvent) => void;
-};
+    slideend(event: SliderSlideEndEvent): void;
+}
 
+/**
+ * **PrimeVue - Slider**
+ *
+ * _Slider is a component to provide input with a drag handle._
+ *
+ * [Live Demo](https://www.primevue.org/slider/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Slider extends ClassComponent<SliderProps, SliderSlots, SliderEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -90,13 +122,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Slider is an input component to provide a numerical input.
- *
- * Demos:
- *
- * - [Slider](https://www.primefaces.org/primevue/slider)
- *
- */
 export default Slider;