primevue 3.22.4 → 3.24.0

package/password/Password.d.ts

@@ -1,8 +1,18 @@
-import { VNode, InputHTMLAttributes, HTMLAttributes } from 'vue';
+/**
+ *
+ * Password displays strength indicator for password fields.
+ *
+ * [Live Demo](https://www.primevue.org/password/)
+ *
+ * @module password
+ *
+ */
+import { HTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor, Nullable } from '../ts-helpers';
 
-type PasswordAppendToType = 'body' | 'self' | string | undefined | HTMLElement;
-
+/**
+ * Defines valid properties in Password component.
+ */
 export interface PasswordProps extends InputHTMLAttributes {
     /**
      * Value of the component.
@@ -14,12 +24,12 @@ export interface PasswordProps extends InputHTMLAttributes {
     promptLabel?: string | undefined;
     /**
      * Regex for a medium level password.
-     * Default value is '^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})'.
+     * @defaultValue ^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})
      */
     mediumRegex?: string | undefined;
     /**
      * Regex for a strong level password.
-     * Default value is '^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})'.
+     * @defaultValue ^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})
      */
     strongRegex?: string | undefined;
     /**
@@ -36,31 +46,32 @@ export interface PasswordProps extends InputHTMLAttributes {
     strongLabel?: string | undefined;
     /**
      * Whether to show the strength indicator or not.
-     * Default value is true.
+     * @defaultValue true
      */
     feedback?: boolean | 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 PasswordAppendToType
-     * Default value is 'body'.
+     * A valid query selector or an HTMLElement to specify where the overlay gets attached.
+     * @defaultValue body
      */
-    appendTo?: PasswordAppendToType;
+    appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
     /**
      * Whether to show an icon to display the password as plain text.
+     * @defaultValue false
      */
     toggleMask?: boolean | undefined;
     /**
      * Icon to hide displaying the password as plain text.
-     * Default value is 'pi pi-eye-slash'.
+     * @defaultValue pi pi-eye-slash
      */
     hideIcon?: string | undefined;
     /**
      * Icon to show displaying the password as plain text.
-     * Default value is 'pi pi-eye'.
+     * @defaultValue pi pi-eye
      */
     showIcon?: string | undefined;
     /**
      * When present, it specifies that the component should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
@@ -69,7 +80,7 @@ export interface PasswordProps extends InputHTMLAttributes {
     placeholder?: string | undefined;
     /**
      * When present, it specifies that an input field must be filled out before submitting the form.
-     * Default value is false.
+     * @defaultValue false
      */
     required?: boolean | undefined;
     /**
@@ -114,29 +125,46 @@ export interface PasswordProps extends InputHTMLAttributes {
     'aria-label'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in Password component.
+ */
 export interface PasswordSlots {
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom footer template.
      */
-    footer: () => VNode[];
+    footer(): VNode[];
     /**
      * Custom content template.
      */
-    content: () => VNode[];
+    content(): VNode[];
 }
 
-export declare type PasswordEmits = {
+/**
+ * Defines valid emits in Password component.
+ */
+export interface PasswordEmits {
     /**
      * Emitted when the value changes.
      * @param {string} value - New value.
      */
-    'update:modelValue': (value: string) => void;
-};
+    'update:modelValue'(value: string): void;
+}
 
+/**
+ * **PrimeVue - Password**
+ *
+ * _Password displays strength indicator for password fields._
+ *
+ * [Live Demo](https://www.primevue.org/password/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Password extends ClassComponent<PasswordProps, PasswordSlots, PasswordEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -145,13 +173,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Password displays strength indicator for password fields.
- *
- * Demos:
- *
- * - [Password](https://www.primefaces.org/primevue/password)
- *
- */
 export default Password;

package/picklist/PickList.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * PickList is used to reorder items between different lists.
+ *
+ * [Live Demo](https://primevue.org/picklist)
+ *
+ * @module picklist
+ *
+ */
 import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom reorder event.
+ * @see {@link PickListEmits.reorder}
+ */
 export interface PickListReorderEvent {
     /**
      * Browser event
@@ -20,6 +33,10 @@ export interface PickListReorderEvent {
     listIndex: number;
 }
 
+/**
+ * Custom selection change event.
+ * @see {@link PickListEmits['selection-change']}
+ */
 export interface PickListSelectionChangeEvent {
     /**
      * Browser event
@@ -31,6 +48,10 @@ export interface PickListSelectionChangeEvent {
     value: any[];
 }
 
+/**
+ * Custom move-to-target event.
+ * @see {@link PickListEmits['move-to-target']}
+ */
 export interface PickListMoveToTargetEvent {
     /**
      * Browser event
@@ -43,20 +64,29 @@ export interface PickListMoveToTargetEvent {
 }
 
 /**
+ * Custom move-all-to-target event.
+ * @see {@link PickListEmits['move-all-to-target']}
  * @extends PickListMoveToTargetEvent
  */
 export interface PickListMoveAllToTargetEvent extends PickListMoveToTargetEvent {}
 
 /**
+ * Custom move-to-source event.
+ * @see {@link PickListEmits['move-all-to-target']}
  * @extends PickListMoveToTargetEvent
  */
 export interface PickListMoveToSourceEvent extends PickListMoveToTargetEvent {}
 
 /**
+ * Custom move-all-to-source event.
+ * @see {@link PickListEmits['move-all-to-target']}
  * @extends PickListMoveToTargetEvent
  */
 export interface PickListMoveAllToSourceEvent extends PickListMoveToTargetEvent {}
 
+/**
+ * Defines valid properties in PickList component.
+ */
 export interface PickListProps {
     /**
      * Value of the component as a multidimensional array.
@@ -74,7 +104,7 @@ export interface PickListProps {
      * Defines whether metaKey is requred or not for the selection.
      * When true metaKey needs to be pressed to select or unselect an item and
      * when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
-     * Default value is true.
+     * @defaultValue true
      */
     metaKeySelection?: boolean | undefined;
     /**
@@ -83,24 +113,27 @@ export interface PickListProps {
     listStyle?: any | undefined;
     /**
      * Whether the list optimizes layout based on screen size.
-     * Default value is true.
+     * @defaultValue true
      */
     responsive?: boolean | undefined;
     /**
      * The breakpoint to define the maximum width boundary when responsiveness is enabled.
-     * Default value is '960px'.
+     * @defaultValue 960px
      */
     breakpoint?: string | undefined;
     /**
      * Whether to displays rows with alternating colors.
+     * @defaultValue false
      */
     stripedRows?: boolean | undefined;
     /**
      * Whether to show buttons of source list.
+     * @defaultValue false
      */
     showSourceControls?: boolean | undefined;
     /**
      * Whether to show buttons of target list.
+     * @defaultValue false
      */
     showTargetControls?: boolean | undefined;
     /**
@@ -149,16 +182,19 @@ export interface PickListProps {
     moveAllToSourceProps?: ButtonHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slots in PickList component.
+ */
 export interface PickListSlots {
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom item template.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Item of the component
          */
@@ -167,84 +203,98 @@ export interface PickListSlots {
          * Index of the item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom source header template.
      */
-    sourceheader: () => VNode[];
+    sourceheader(): VNode[];
     /**
      * Custom target header template.
      */
-    targetheader: () => VNode[];
+    targetheader(): VNode[];
     /**
      * Custom source controls start template.
      */
-    sourcecontrolsstart: () => VNode[];
+    sourcecontrolsstart(): VNode[];
     /**
      * Custom source controls end template.
      */
-    sourcecontrolsend: () => VNode[];
+    sourcecontrolsend(): VNode[];
     /**
      * Custom move controls start template.
      */
-    movecontrolsstart: () => VNode[];
+    movecontrolsstart(): VNode[];
     /**
      * Custom move controls end template.
      */
-    movecontrolsend: () => VNode[];
+    movecontrolsend(): VNode[];
     /**
      * Custom target controls start template.
      */
-    targetcontrolsstart: () => VNode[];
+    targetcontrolsstart(): VNode[];
     /**
      * Custom target controls end template.
      */
-    targetcontrolsend: () => VNode[];
+    targetcontrolsend(): VNode[];
 }
 
-export declare type PickListEmits = {
+/**
+ * Defines valid emits in PickList component.
+ */
+export interface PickListEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:modelValue': (value: any[][]) => void;
+    'update:modelValue'(value: any[][]): void;
     /**
      * Emitted when the selection changes.
      * @param {*} value - New value.
      */
-    'update:selection': (value: any[][]) => void;
+    'update:selection'(value: any[][]): void;
     /**
      * Callback to invoke when the list is reordered.
      * @param {PickListReorderEvent} event - Custom reorder event.
      */
-    reorder: (event: PickListReorderEvent) => void;
+    reorder(event: PickListReorderEvent): void;
     /**
      * Callback to invoke when one or more items are moved to the other list.
      * @param {PickListSelectionChangeEvent} event - Custom selection change event.
      */
-    'selection-change': (event: PickListSelectionChangeEvent) => void;
+    'selection-change'(event: PickListSelectionChangeEvent): void;
     /**
      * Callback to invoke when one or more items are moved to the target list.
      * @param {PickListMoveToTargetEvent} event - Custom move to target event.
      */
-    'move-to-target': (event: PickListMoveToTargetEvent) => void;
+    'move-to-target'(event: PickListMoveToTargetEvent): void;
     /**
      * Callback to invoke when all items are moved to the target list.
      * @param {PickListMoveAllToTargetEvent} event - Custom move all to target event.
      */
-    'move-all-to-target': (event: PickListMoveAllToTargetEvent) => void;
+    'move-all-to-target'(event: PickListMoveAllToTargetEvent): void;
     /**
      * Callback to invoke when one or more items are moved to the source list.
      * @param {PickListMoveToSourceEvent} event - Custom move to source event.
      */
-    'move-to-source': (event: PickListMoveToSourceEvent) => void;
+    'move-to-source'(event: PickListMoveToSourceEvent): void;
     /**
      * Callback to invoke when all items are moved to the source list.
      * @param {PickListMoveAllToSourceEvent} event - Custom move all to source event.
      */
-    'move-all-to-source': (event: PickListMoveAllToSourceEvent) => void;
-};
+    'move-all-to-source'(event: PickListMoveAllToSourceEvent): void;
+}
 
+/**
+ * **PrimeVue - PickList**
+ *
+ * _PickList is used to reorder items between different lists._
+ *
+ * [Live Demo](https://www.primevue.org/picklist/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class PickList extends ClassComponent<PickListProps, PickListSlots, PickListEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -253,13 +303,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * PickList is used to reorder items between different lists.
- *
- * Demos:
- *
- * - [PickList](https://www.primefaces.org/primevue/picklist)
- *
- */
 export default PickList;

package/progressbar/ProgressBar.d.ts

@@ -1,8 +1,18 @@
+/**
+ *
+ * ProgressBar is a process status indicator.
+ *
+ * [Live Demo](https://www.primevue.org/progressbar)
+ *
+ * @module progressbar
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type ProgressBarModeType = 'determinate' | 'indeterminate' | undefined;
-
+/**
+ * Defines valid properties in ProgressBar component.
+ */
 export interface ProgressBarProps {
     /**
      * Current value of the progress.
@@ -10,26 +20,42 @@ export interface ProgressBarProps {
     value?: number | undefined;
     /**
      * Defines the mode of the progress
-     * @see ProgressBarModeType
-     * Default value is 'determinate'.
+     * @defaultValue determinate
      */
-    mode?: ProgressBarModeType;
+    mode?: 'determinate' | 'indeterminate' | undefined;
     /**
      * Whether to display the progress bar value.
-     * Default value is true.
+     * @defaultValue true
      */
     showValue?: boolean | undefined;
 }
 
+/**
+ * Defines valid slots in ProgressBar component.
+ */
 export interface ProgressBarSlots {
     /**
      * Custom content slot.
      */
-    default: () => VNode[];
+    default(): VNode[];
 }
 
-export declare type ProgressBarEmits = {};
+/**
+ * Defines valid emits in ProgressBar component.
+ */
+export interface ProgressBarEmits {}
 
+/**
+ * **PrimeVue - ProgressBar**
+ *
+ * ProgressBar is a process status indicator._
+ *
+ * [Live Demo](https://www.primevue.org/progressbar/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class ProgressBar extends ClassComponent<ProgressBarProps, ProgressBarSlots, ProgressBarEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -38,13 +64,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ProgressBar is a process status indicator.
- *
- * Demos:
- *
- * - [ProgressBar](https://www.primefaces.org/primevue/progressbar)
- *
- */
 export default ProgressBar;

package/progressspinner/ProgressSpinner.d.ts

@@ -1,10 +1,21 @@
-import { VNode } from 'vue';
+/**
+ *
+ * ProgressSpinner is a process status indicator.
+ *
+ * [Live Demo](https://www.primevue.org/progressspinner)
+ *
+ * @module progressspinner
+ *
+ */
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in ProgressSpinner component.
+ */
 export interface ProgressSpinnerProps {
     /**
      * Width of the circle stroke.
-     * Default value is 2.
+     * @defaultValue 2
      */
     strokeWidth?: string | undefined;
     /**
@@ -13,15 +24,32 @@ export interface ProgressSpinnerProps {
     fill?: string | undefined;
     /**
      * Duration of the rotate animation.
-     * Default value is 2s.
+     * @defaultValue 2s
      */
     animationDuration?: string | undefined;
 }
 
+/**
+ * Defines valid slots in ProgressSpinner component.
+ */
 export interface ProgressSpinnerSlots {}
 
-export declare type ProgressSpinnerEmits = {};
+/**
+ * Defines valid emits in ProgressSpinner component.
+ */
+export interface ProgressSpinnerEmits {}
 
+/**
+ * **PrimeVue - ProgressSpinner**
+ *
+ * _ProgressSpinner is a process status indicator._
+ *
+ * [Live Demo](https://www.primevue.org/progressspinner/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class ProgressSpinner extends ClassComponent<ProgressSpinnerProps, ProgressSpinnerSlots, ProgressSpinnerEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -30,13 +58,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ProgressSpinner is a process status indicator.
- *
- * Demos:
- *
- * - [ProgressSpinner](https://www.primefaces.org/primevue/progressspinner)
- *
- */
 export default ProgressSpinner;

package/radiobutton/RadioButton.d.ts

@@ -1,6 +1,18 @@
+/**
+ *
+ * RadioButton is an extension to standard radio button element with theming.
+ *
+ * [Live Demo](https://www.primevue.org/radiobutton/)
+ *
+ * @module radiobutton
+ *
+ */
 import { InputHTMLAttributes } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in RadioButton component.
+ */
 export interface RadioButtonProps {
     /**
      * Value of the checkbox.
@@ -46,24 +58,39 @@ export interface RadioButtonProps {
 
 export interface RadioButtonSlots {}
 
-export declare type RadioButtonEmits = {
+/**
+ * Defines valid emits in RadioButton component.
+ */
+export interface RadioButtonEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:modelValue': (value: any) => void;
+    'update:modelValue'(value: any): void;
     /**
      * Callback to invoke on radio button click.
      * @param {Event} event - Browser event.
      */
-    click: (event: Event) => void;
+    click(event: Event): void;
     /**
      * Callback to invoke on radio button value change.
      * @param {Event} event - Browser event.
      */
-    change: (event: Event) => void;
-};
+    change(event: Event): void;
+}
 
+/**
+ * **PrimeVue - RadioButton**
+ *
+ * _RadioButton is an extension to standard radio button element with theming._
+ *
+ * [Live Demo](https://www.primevue.org/radiobutton/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class RadioButton extends ClassComponent<RadioButtonProps, RadioButtonSlots, RadioButtonEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -72,13 +99,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * RadioButton is an extension to standard radio button element with theming.
- *
- * Demos:
- *
- * - [RadioButton](https://www.primefaces.org/primevue/radiobutton)
- *
- */
 export default RadioButton;