primevue 3.22.4 → 3.24.0

package/galleria/Galleria.d.ts

@@ -1,10 +1,15 @@
+/**
+ *
+ * Galleria is an advanced content gallery component.
+ *
+ * [Live Demo](https://www.primevue.org/galleria/)
+ *
+ * @module galleria
+ *
+ */
 import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type GalleriaThumbnailsPositionType = 'bottom' | 'top' | 'left' | 'right' | undefined;
-
-type GalleriaIndicatorsPositionType = 'bottom' | 'top' | 'left' | 'right' | undefined;
-
 export interface GalleriaResponsiveOptions {
     /**
      * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
@@ -16,6 +21,9 @@ export interface GalleriaResponsiveOptions {
     numVisible: number;
 }
 
+/**
+ * Defines valid properties in Galleria component.
+ */
 export interface GalleriaProps {
     /**
      * Unique identifier of the element.
@@ -27,19 +35,22 @@ export interface GalleriaProps {
     value?: any[];
     /**
      * Index of the first item.
-     * Default value is 0.
+     * @defaultValue 0
      */
     activeIndex?: number | undefined;
     /**
      * Whether to display the component on fullscreen.
+     * @defaultValue false
      */
     fullScreen?: boolean | undefined;
     /**
      * Specifies the visibility of the mask on fullscreen mode.
+     * @defaultValue false
      */
     visible?: boolean | undefined;
     /**
      * Number of items per page.
+     * @defaultValue 3
      */
     numVisible?: number | undefined;
     /**
@@ -49,67 +60,72 @@ export interface GalleriaProps {
     responsiveOptions?: GalleriaResponsiveOptions[];
     /**
      * Whether to display navigation buttons in item section.
+     * @defaultValue false
      */
     showItemNavigators?: boolean | undefined;
     /**
      * Whether to display navigation buttons in thumbnail container.
-     * Default value is true.
+     * @defaultValue true
      */
     showThumbnailNavigators?: boolean | undefined;
     /**
      * Whether to display navigation buttons on item hover.
+     * @defaultValue false
      */
     showItemNavigatorsOnHover?: boolean | undefined;
     /**
      * When enabled, item is changed on indicator hover.
+     * @defaultValue false
      */
     changeItemOnIndicatorHover?: boolean | undefined;
     /**
      * Defines if scrolling would be infinite.
+     * @defaultValue false
      */
     circular?: boolean | undefined;
     /**
      * Items are displayed with a slideshow in autoPlay mode.
+     * @defaultValue false
      */
     autoPlay?: boolean | undefined;
     /**
      * Time in milliseconds to scroll items.
-     * Default value is 4000.
+     * @defaultValue 4000
      */
     transitionInterval?: number | undefined;
     /**
      * Whether to display thumbnail container.
-     * Default value is true.
+     * @defaultValue true
      */
     showThumbnails?: boolean | undefined;
     /**
      * Position of thumbnails.
-     * @see GalleriaThumbnailsPositionType
-     * Default value is 'bottom'.
+     * @defaultValue bottom
      */
-    thumbnailsPosition?: GalleriaThumbnailsPositionType;
+    thumbnailsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined;
     /**
      * Height of the viewport in vertical thumbnail.
-     * Default value is '300px'.
+     * @defaultValue 300px
      */
     verticalThumbnailViewPortHeight?: string | undefined;
     /**
      * Whether to display indicator container.
+     * @defaultValue false
      */
     showIndicators?: boolean | undefined;
     /**
      * When enabled, indicator container is displayed on item container.
+     * @defaultValue false
      */
     showIndicatorsOnItem?: boolean | undefined;
     /**
      * Position of indicators.
-     * @see GalleriaIndicatorsPositionType
-     * Default value is 'bottom'.
+     * @defaultValue bottom
      */
-    indicatorsPosition?: GalleriaIndicatorsPositionType;
+    indicatorsPosition?: 'bottom' | 'top' | 'left' | 'right' | undefined;
     /**
      * Base zIndex value to use in layering.
-     * Default value is 0.
+     * @defaultValue 0
      */
     baseZIndex?: number | undefined;
     /**
@@ -137,71 +153,88 @@ export interface GalleriaProps {
      */
     nextButtonProps?: ButtonHTMLAttributes | undefined;
 }
-
+/**
+ * Defines valid slots in Galleria slots.
+ */
 export interface GalleriaSlots {
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom footer template.
      */
-    footer: () => VNode[];
+    footer(): VNode[];
     /**
      * Custom item template.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Item instance
          */
         item: any;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom caption template.
      * @param {Object} scope - caption slot's params.
      */
-    caption: (scope: {
+    caption(scope: {
         /**
          * Item instance
          */
         item: any;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom indicator template.
      * @param {Object} scope - indicator slot's params.
      */
-    indicator: (scope: {
+    indicator(scope: {
         /**
          * Index of the indicator item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom thumbnail template.
      * @param {Object} scope - thumbnail slot's params.
      */
-    thumbnail: (scope: {
+    thumbnail(scope: {
         /**
          * Item instance
          */
         item: any;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type GalleriaEmits = {
+/**
+ * Defines valid emits in Galleria component.
+ */
+export interface GalleriaEmits {
     /**
      * Emitted when the active index changes.
      * @param {number} value - Index of new active item.
      */
-    'update:activeIndex': (value: number) => void;
+    'update:activeIndex'(value: number): void;
     /**
      * Emitted when the visible changes.
      * @param {boolean} value - New value.
      */
-    'update:visible': (value: boolean) => void;
-};
+    'update:visible'(value: boolean): void;
+}
 
+/**
+ * **PrimeVue - Galleria**
+ *
+ * _Galleria is an advanced content gallery component._
+ *
+ * [Live Demo](https://www.primevue.org/galleria/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Galleria extends ClassComponent<GalleriaProps, GalleriaSlots, GalleriaEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -210,13 +243,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Galleria is an advanced content gallery component.
- *
- * Demos:
- *
- * - [Galleria](https://www.primefaces.org/primevue/galleria)
- *
- */
 export default Galleria;

package/image/Image.d.ts

@@ -1,9 +1,22 @@
+/**
+ *
+ * Displays an image with preview and tranformation options. For multiple image, see Galleria.
+ *
+ * [Live Demo](https://www.primevue.org/image/)
+ *
+ * @module image
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in Image component.
+ */
 export interface ImageProps {
     /**
      * Controls the preview functionality.
+     * @defaultValue false
      */
     preview?: boolean | undefined;
     /**
@@ -16,34 +29,49 @@ export interface ImageProps {
     imageClass?: any;
 }
 
+/**
+ * Defines valid slots in Image slots.
+ */
 export interface ImageSlots {
     /**
      * Custom indicator template.
      */
-    indicator: () => VNode[];
+    indicator(): VNode[];
 }
 
-export declare type ImageEmits = {};
+export interface ImageEmits {}
 
+/**
+ * **PrimeVue - Image**
+ *
+ * _Displays an image with preview and tranformation options. For multiple image, see Galleria._
+ *
+ * [Live Demo](https://www.primevue.org/image/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Image extends ClassComponent<ImageProps, ImageSlots, ImageEmits> {
     /**
      * Triggered when the preview overlay is shown.
      *
      * @memberof Image
      */
-    show: () => void;
+    show(): void;
     /**
      * Triggered when the preview overlay is hidden.
      *
      * @memberof Image
      */
-    hide: () => void;
+    hide(): void;
     /**
      * Triggered when an error occurs while loading an image file.
      *
      * @memberof Image
      */
-    error: () => void;
+    error(): void;
 }
 
 declare module '@vue/runtime-core' {
@@ -52,13 +80,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Displays an image with preview and tranformation options. For multiple image, see Galleria.
- *
- * Demos:
- *
- * - [Image](https://www.primefaces.org/primevue/image)
- *
- */
 export default Image;

package/inlinemessage/InlineMessage.d.ts

@@ -1,26 +1,49 @@
+/**
+ *
+ * InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.
+ *
+ * [Live Demo](https://www.primevue.org/inlinemessage/)
+ *
+ * @module inlinemessage
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type InlineMessageSeverityType = 'success' | 'info' | 'warn' | 'error' | undefined;
-
+/**
+ * Defines valid properties in InlineMessage component.
+ */
 export interface InlineMessageProps {
     /**
      * Severity level of the message.
-     * @see InlineMessageSeverityType
-     * Default value is 'info'.
+     * @defaultValue info
      */
-    severity?: InlineMessageSeverityType;
+    severity?: 'success' | 'info' | 'warn' | 'error' | undefined;
 }
-
+/**
+ * Defines valid slots in InlineMessage slots.
+ */
 export interface InlineMessageSlots {
     /**
      * Default custom slot.
      */
-    default: () => VNode[];
+    default(): VNode[];
 }
 
-export declare type InlineMessageEmits = {};
+export interface InlineMessageEmits {}
 
+/**
+ * **PrimeVue - InlineMessage**
+ *
+ * _InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message._
+ *
+ * [Live Demo](https://www.primevue.org/inlinemessage/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class InlineMessage extends ClassComponent<InlineMessageProps, InlineMessageSlots, InlineMessageEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -29,13 +52,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.
- *
- * Demos:
- *
- * - [InlineMessage](https://www.primefaces.org/primevue/message)
- *
- */
 export default InlineMessage;

package/inplace/Inplace.d.ts

@@ -1,22 +1,37 @@
-import { HTMLAttributes, ButtonHTMLAttributes, VNode } from 'vue';
+/**
+ *
+ * Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
+ *
+ * [Live Demo](https://www.primevue.org/inplace)
+ *
+ * @module inplace
+ *
+ */
+import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in Inplace component.
+ */
 export interface InplaceProps {
     /**
      * Displays a button to switch back to display mode.
+     * @defaultValue false
      */
     closable?: boolean | undefined;
     /**
      * Whether the content is displayed or not.
+     * @defaultValue false
      */
     active?: boolean | undefined;
     /**
      * When present, it specifies that the element should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
      * Icon to display in the close button.
-     * Default value is 'pi pi-times'.
+     * @defaultValue pi pi-times
      */
     closeIcon?: string | undefined;
     /**
@@ -29,35 +44,52 @@ export interface InplaceProps {
     closeButtonProps?: ButtonHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slots in Inplace component.
+ */
 export interface InplaceSlots {
     /**
      * Custom display template.
      */
-    display: () => VNode[];
+    display(): VNode[];
     /**
      * Custom content template.
      */
-    content: () => VNode[];
+    content(): VNode[];
 }
 
-export declare type InplaceEmits = {
+/**
+ * Defines valid emits in Inplace component.
+ */
+export interface InplaceEmits {
     /**
      * Emitted when the active changes.
      * @param {boolean} value - New value.
      */
-    'update:active': (value: boolean) => void;
+    'update:active'(value: boolean): void;
     /**
      * Callback to invoke when inplace is opened.
      * @param {Event} event - Browser event.
      */
-    open: (event: Event) => void;
+    open(event: Event): void;
     /**
      * Callback to invoke when inplace is closed.
      * @param {Event} event - Browser event.
      */
-    close: (event: Event) => void;
-};
+    close(event: Event): void;
+}
 
+/**
+ * **PrimeVue - Inplace**
+ *
+ * _Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content._
+ *
+ * [Live Demo](https://www.primevue.org/inplace/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Inplace extends ClassComponent<InplaceProps, InplaceSlots, InplaceEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -66,13 +98,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
- *
- * Demos:
- *
- * - [Inplace](https://www.primefaces.org/primevue/inplace)
- *
- */
 export default Inplace;

package/inputmask/InputMask.d.ts

@@ -1,5 +1,17 @@
+/**
+ *
+ * InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.
+ *
+ * [Live Demo](https://www.primevue.org/inputmask/)
+ *
+ * @module inputmask
+ *
+ */
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in InputMask component.
+ */
 export interface InputMaskProps {
     /**
      * Value of the component.
@@ -7,7 +19,7 @@ export interface InputMaskProps {
     modelValue?: string | undefined;
     /**
      * Placeholder character in mask, default is underscore.
-     * Default value is '_'.
+     * @defaultValue _
      */
     slotChar?: string | undefined;
     /**
@@ -16,35 +28,44 @@ export interface InputMaskProps {
     mask?: string | undefined;
     /**
      * Clears the incomplete value on blur.
-     * Default value is true.
+     * @defaultValue true
      */
     autoClear?: boolean | undefined;
     /**
      * Defines if model sets the raw unmasked value to bound value or the formatted mask value.
+     * @defaultValue false
      */
     unmask?: boolean | undefined;
+    /**
+     * Whether the items are clickable or not.
+     * @defaultValue false
+     */
+    readonly?: boolean | undefined;
 }
 
 export interface InputMaskSlots {}
 
-export declare type InputMaskEmits = {
+/**
+ * Defines valid emits in InputMask component.
+ */
+export interface InputMaskEmits {
     /**
      * Emitted when the value changes.
      * @param {string} value - New value.
      */
-    'update:modelValue': (value: string) => void;
+    'update:modelValue'(value: string): void;
     /**
      * Callback to invoke when the component receives focus.
      */
-    focus: (event: Event) => void;
+    focus(event: Event): void;
     /**
      * Callback to invoke when the component loses focus.
      */
-    blur: (event: Event) => void;
+    blur(event: Event): void;
     /**
      * Callback to invoke when a key is pressed.
      */
-    keydown: (event: Event) => void;
+    keydown(event: Event): void;
     /**
      * Callback to invoke when a key that produces a character value is pressed down.
      */
@@ -57,8 +78,20 @@ export declare type InputMaskEmits = {
      * Callback to invoke when the mask is completed.
      */
     complete: (event: Event) => void;
-};
+}
 
+/**
+ * **PrimeVue - InputMask**
+ *
+ * _InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone._
+ *
+ * [Live Demo](https://www.primevue.org/inputmask/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class InputMask extends ClassComponent<InputMaskProps, InputMaskSlots, InputMaskEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -67,13 +100,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.
- *
- * Demos:
- *
- * - [InputMask](https://www.primefaces.org/primevue/inputmask)
- *
- */
 export default InputMask;