primevue 3.23.0 → 3.24.0

package/carousel/Carousel.d.ts

@@ -1,8 +1,15 @@
+/**
+ *
+ * Carousel is a content slider featuring various customization options.
+ *
+ * [Live Demo](https://www.primevue.org/carousel/)
+ *
+ * @module carousel
+ *
+ */
 import { ButtonHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type CarouselOrientationType = 'horizontal' | 'vertical' | undefined;
-
 export interface CarouselResponsiveOptions {
     /**
      * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
@@ -17,7 +24,9 @@ export interface CarouselResponsiveOptions {
      */
     numScroll: number;
 }
-
+/**
+ * Defines valid properties in Carousel component.
+ */
 export interface CarouselProps {
     /**
      * An array of objects to display.
@@ -25,17 +34,17 @@ export interface CarouselProps {
     value?: any | undefined;
     /**
      * Index of the first item.
-     * Default value is 0.
+     * @defaultValue 0
      */
     page?: number | undefined;
     /**
      * Number of items per page.
-     * Default value is 1.
+     * @defaultValue 1
      */
     numVisible?: number | undefined;
     /**
      * Number of items to scroll.
-     * Default value is 1.
+     * @defaultValue 1
      */
     numScroll?: number | undefined;
     /**
@@ -45,13 +54,12 @@ export interface CarouselProps {
     responsiveOptions?: CarouselResponsiveOptions[] | undefined;
     /**
      * Specifies the layout of the component, valid values are 'horizontal' and 'vertical'.
-     * @see CarouselOrientationType
-     * Default value is 'horizontal'.
+     * @defaultValue horizontal
      */
-    orientation?: CarouselOrientationType;
+    orientation?: 'horizontal' | 'vertical' | undefined;
     /**
      * Height of the viewport in vertical layout.
-     * Default value is '300px'.
+     * @defaultValue 300px
      */
     verticalViewPortHeight?: string | undefined;
     /**
@@ -68,21 +76,22 @@ export interface CarouselProps {
     indicatorsContentClass?: any;
     /**
      * Defines if scrolling would be infinite.
+     * @defaultValue false
      */
     circular?: boolean | undefined;
     /**
      * Time in milliseconds to scroll items automatically.
-     * Default value is 0.
+     * @defaultValue 0
      */
     autoplayInterval?: number | undefined;
     /**
      * Whether to display navigation buttons in container.
-     * Default value is true.
+     * @defaultValue true
      */
     showNavigators?: boolean | undefined;
     /**
      * Whether to display indicator container.
-     * Default value is true.
+     * @defaultValue true
      */
     showIndicators?: boolean | undefined;
     /**
@@ -95,12 +104,15 @@ export interface CarouselProps {
     nextButtonProps?: ButtonHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slots in Carousel slots.
+ */
 export interface CarouselSlots {
     /**
      * Custom content for each item.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Data of the component
          */
@@ -109,25 +121,40 @@ export interface CarouselSlots {
          * Index of the item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom footer template.
      */
-    footer: () => VNode[];
+    footer(): VNode[];
 }
 
-export declare type CarouselEmits = {
+/**
+ * Defines valid emits in Carousel component.
+ */
+export interface CarouselEmits {
     /**
      * Emitted when the page changes.
      * @param {number} value - New page value.
      */
-    'update:page': (value: number) => void;
-};
+    'update:page'(value: number): void;
+}
 
+/**
+ * **PrimeVue - Carousel**
+ *
+ * _Carousel is a content slider featuring various customization options._
+ *
+ * [Live Demo](https://www.primevue.org/carousel/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Carousel extends ClassComponent<CarouselProps, CarouselSlots, CarouselEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -136,13 +163,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Carousel is a content slider featuring various customization options.
- *
- * Demos:
- *
- * - [Carousel](https://www.primefaces.org/primevue/carousel)
- *
- */
 export default Carousel;

package/cascadeselect/CascadeSelect.d.ts

@@ -1,16 +1,19 @@
+/**
+ *
+ * CascadeSelect is a form component to select a value from a nested structure of options.
+ *
+ * [Live Demo](https://www.primevue.org/cascadeselect/)
+ *
+ * @module cascadeselect
+ *
+ */
 import { HTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type CascadeSelectOptionLabelType = string | ((data: any) => string) | undefined;
-
-type CascadeSelectOptionValueType = string | ((data: any) => any) | undefined;
-
-type CascadeSelectOptionDisabledType = string | ((data: any) => boolean) | undefined;
-
-type CascadeSelectOptionChildrenType = string[] | string | ((data: any) => any[]) | undefined;
-
-type CascadeSelectAppendToType = 'body' | 'self' | string | undefined | HTMLElement;
-
+/**
+ * Custom change event
+ * @see {@link CascadeSelectEmits.change}
+ */
 export interface CascadeSelectChangeEvent {
     /**
      * Original event.
@@ -23,10 +26,14 @@ export interface CascadeSelectChangeEvent {
 }
 
 /**
+ * @see {@link CascadeSelectEmits.change}
  * @extends CascadeSelectChangeEvent
  */
 export interface CascadeSelectGroupChangeEvent extends CascadeSelectChangeEvent {}
 
+/**
+ * Defines valid properties in CascadeSelect component.
+ */
 export interface CascadeSelectProps {
     /**
      * Value of the component.
@@ -38,35 +45,31 @@ export interface CascadeSelectProps {
     options?: any[] | undefined;
     /**
      * Property name or getter function to use as the label of an option.
-     * @see CascadeSelectOptionLabelType
      */
-    optionLabel?: CascadeSelectOptionLabelType;
+    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.
-     * @see CascadeSelectOptionValueType
      */
-    optionValue?: CascadeSelectOptionValueType;
+    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.
-     * @see CascadeSelectOptionDisabledType
      */
-    optionDisabled?: CascadeSelectOptionDisabledType;
+    optionDisabled?: string | ((data: any) => boolean) | undefined;
     /**
      * Property name or getter function to use as the label of an option group.
-     * @see CascadeSelectOptionLabelType
      */
-    optionGroupLabel?: CascadeSelectOptionLabelType;
+    optionGroupLabel?: string | ((data: any) => string) | undefined;
     /**
      * Property name or getter function to retrieve the items of a group.
-     * @see CascadeSelectOptionChildrenType
      */
-    optionGroupChildren?: CascadeSelectOptionChildrenType;
+    optionGroupChildren?: string[] | string | ((data: any) => any[]) | undefined;
     /**
      * Default text to display when no option is selected.
      */
     placeholder?: string | undefined;
     /**
      * When present, it specifies that the component should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
@@ -103,37 +106,37 @@ export interface CascadeSelectProps {
     panelProps?: HTMLAttributes | undefined;
     /**
      * A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself.
-     * @see CascadeSelectAppendToType
-     * Default value is 'body'.
+     * @defaultValue body
      */
-    appendTo?: CascadeSelectAppendToType;
+    appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
     /**
      * Whether the dropdown is in loading state.
+     * @defaultValue false
      */
     loading?: boolean | undefined;
     /**
      * Icon to display in the dropdown.
-     * Default value is 'pi pi-chevron-down'.
+     * @defaultValue pi pi-chevron-down
      */
     dropdownIcon?: string | undefined;
     /**
      * Icon to display in loading state.
-     * Default value is 'pi pi-spinner pi-spin'.
+     * @defaultValue pi pi-spinner pi-spin
      */
     loadingIcon?: string | undefined;
     /**
      * Icon to display in the option group.
-     * Default value is 'pi pi-angle-right'.
+     * @defaultValue pi pi-angle-right
      */
     optionGroupIcon?: string | undefined;
     /**
      * Whether to focus on the first visible or selected element when the overlay panel is shown.
-     * Default value is true.
+     * @defaultValue true
      */
     autoOptionFocus?: boolean | undefined;
     /**
      * When enabled, the focused option is selected/opened.
-     * Default value is false.
+     * @defaultValue false
      */
     selectOnFocus?: boolean | undefined;
     /**
@@ -142,27 +145,27 @@ export interface CascadeSelectProps {
     searchLocale?: string | undefined;
     /**
      * Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.
-     * Default value is '{0} results are available'.
+     * @defaultValue '{0} results are available'
      */
     searchMessage?: string | undefined;
     /**
      * Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.
-     * Default value is '{0} items selected'.
+     * @defaultValue '{0} items selected'
      */
     selectionMessage?: string | undefined;
     /**
      * Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.
-     * Default value is 'No selected item'.
+     * @defaultValue No selected item
      */
     emptySelectionMessage?: string | undefined;
     /**
      * Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.
-     * Default value is 'No results found'.
+     * @defaultValue No results found
      */
     emptySearchMessage?: string | undefined;
     /**
      * Text to be displayed when there are no options available. Defaults to value from PrimeVue locale configuration.
-     * Default value is 'No available options'.
+     * @defaultValue No available options
      */
     emptyMessage?: string | undefined;
     /**
@@ -179,22 +182,25 @@ export interface CascadeSelectProps {
     'aria-label'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in CascadeSelect component.
+ */
 export interface CascadeSelectSlots {
     /**
      * Custom content for each option.
      * @param {Object} scope - option slot's params.
      */
-    option: (scope: {
+    option(scope: {
         /**
          * Option instance
          */
         option: any;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom value template.
      * @param {CascadeSelectValueSlot} scope - value slot's params.
      */
-    value: (scope: {
+    value(scope: {
         /**
          * Value of the component
          */
@@ -203,62 +209,76 @@ export interface CascadeSelectSlots {
          * Placeholder text to show
          */
         placeholder: string;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom indicator template.
      */
-    indicator: () => VNode[];
+    indicator(): VNode[];
 }
 
-export declare type CascadeSelectEmits = {
+/**
+ * Defines valid emits in CascadeSelect component.
+ */
+export interface CascadeSelectEmits {
     /**
      * 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 { CascadeSelectChangeEvent } event - Custom change event.
      */
-    change: (event: CascadeSelectChangeEvent) => void;
+    change(event: CascadeSelectChangeEvent): void;
     /**
      * Callback to invoke when the component receives focus.
      * @param {Event} event - Browser event.
      */
-    focus: (event: Event) => void;
+    focus(event: Event): void;
     /**
      * Callback to invoke when the component loses focus.
      * @param {Event} event - Browser event.
      */
-    blur: (event: Event) => void;
+    blur(event: Event): void;
     /**
      * Callback to invoke on click.
      * @param { Event } event - Browser event.
      */
-    click: (event: Event) => void;
+    click(event: Event): void;
     /**
      * Callback to invoke when a group changes.
      * @param { CascadeSelectGroupChangeEvent } event - Custom change event.
      */
-    'group-change': (event: CascadeSelectGroupChangeEvent) => void;
+    'group-change'(event: CascadeSelectGroupChangeEvent): void;
     /**
      * Callback to invoke before the overlay is shown.
      */
-    'before-show': () => void;
+    'before-show'(): void;
     /**
      * Callback to invoke before the overlay is hidden.
      */
-    'before-hide': () => void;
+    'before-hide'(): void;
     /**
      * Callback to invoke when the overlay is shown.
      */
-    show: () => void;
+    show(): void;
     /**
      * Callback to invoke when the overlay is hidden.
      */
-    hide: () => void;
-};
+    hide(): void;
+}
 
+/**
+ * **PrimeVue - CascadeSelect**
+ *
+ * _CascadeSelect is a form component to select a value from a nested structure of options._
+ *
+ * [Live Demo](https://www.primevue.org/cascadeselect/)
+ * --- ---
+ * ![PrimeVue(https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class CascadeSelect extends ClassComponent<CascadeSelectProps, CascadeSelectSlots, CascadeSelectEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -267,13 +287,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * CascadeSelect displays a nested structure of options.
- *
- * Demos:
- *
- * - [CascadeSelect](https://www.primefaces.org/primevue/cascadeselect)
- *
- */
 export default CascadeSelect;

package/chart/Chart.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * Chart groups a collection of contents in tabs.
+ *
+ * [Live Demo](https://www.primevue.org/chart/)
+ *
+ * @module chart
+ *
+ */
 import { CanvasHTMLAttributes } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom select event.
+ * @see {@link ChartEmits.select}
+ */
 export interface ChartSelectEvent {
     /**
      * Browser event.
@@ -16,6 +29,9 @@ export interface ChartSelectEvent {
     dataset: any;
 }
 
+/**
+ * Defines valid properties in Chart component.
+ */
 export interface ChartProps {
     /**
      * Type of the chart.
@@ -35,12 +51,12 @@ export interface ChartProps {
     plugins?: any;
     /**
      * Width of the chart in non-responsive mode.
-     * Default value is 300.
+     * @defaultValue 300
      */
     width?: number | undefined;
     /**
      * Height of the chart in non-responsive mode.
-     * Default value is 150.
+     * @defaultValue 150
      */
     height?: number | undefined;
     /**
@@ -51,44 +67,59 @@ export interface ChartProps {
 
 export interface ChartSlots {}
 
-export declare type ChartEmits = {
+/**
+ * Defines valid emits in Chart component.
+ */
+export interface ChartEmits {
     /**
      * Callback to invoke when a tab gets expanded.
      * @param {ChartSelectEvent} event - Custom select event.
      */
-    select: (event: ChartSelectEvent) => void;
+    select(event: ChartSelectEvent): void;
     /**
      * Callback to invoke when chart is loaded.
      * @param {*} chart - Chart instance.
      */
-    loaded: (chart: any) => void;
-};
+    loaded(chart: any): void;
+}
 
+/**
+ * **PrimeVue - Chart**
+ *
+ * _Chart groups a collection of contents in tabs._
+ *
+ * [Live Demo](https://www.primevue.org/chart/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Chart extends ClassComponent<ChartProps, ChartSlots, ChartEmits> {
     /**
      * Redraws the graph.
      *
      * @memberof Chart
      */
-    refresh: () => void;
+    refresh(): void;
     /**
      * Destroys the graph first and then creates it again.
      *
      * @memberof Chart
      */
-    reinit: () => void;
+    reinit(): void;
     /**
      * Returns an HTML string of a legend for that chart. The legend is generated from the legendCallback in the options.
      *
      * @memberof Chart
      */
-    generateLegend: () => string | any;
+    generateLegend(): string | any;
     /**
      * Returns Chart instance.
      *
      * @memberof Chart
      */
-    getChart: () => any;
+    getChart(): any;
 }
 
 declare module '@vue/runtime-core' {
@@ -97,17 +128,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Chart components are based on Charts.js, an open source HTML5 based charting library.
- *
- * Helper API;
- *
- * - [Chart.js](https://www.chartjs.org/)
- *
- * Demos:
- *
- * - [Chart](https://www.primefaces.org/primevue/chart)
- *
- */
 export default Chart;