primevue 3.22.4 → 3.24.0

package/editor/Editor.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * Editor groups a collection of contents in tabs.
+ *
+ * [Live Demo](https://www.primevue.org/editor/)
+ *
+ * @module editor
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom text change event.
+ * @see {@link EditorEmits['text-change']}
+ */
 export interface EditorTextChangeEvent {
     /**
      * Current value as html.
@@ -23,7 +36,10 @@ export interface EditorTextChangeEvent {
      */
     instance: any;
 }
-
+/**
+ * Custom selection change event.
+ * @see {@link EditorEmits['selection-change']}
+ */
 export interface EditorSelectionChangeEvent {
     /**
      * Current value as html.
@@ -50,7 +66,10 @@ export interface EditorSelectionChangeEvent {
      */
     instance: any;
 }
-
+/**
+ * Custom load event.
+ * @see {@link EditorEmits.load}
+ */
 export interface EditorLoadEvent {
     /**
      * Text editor instance.
@@ -58,6 +77,9 @@ export interface EditorLoadEvent {
     instance: any;
 }
 
+/**
+ * Defines valid properties in Editor component.
+ */
 export interface EditorProps {
     /**
      * Value of the content.
@@ -85,6 +107,9 @@ export interface EditorProps {
     modules?: any;
 }
 
+/**
+ * Defines valid slots in Editor slots.
+ */
 export interface EditorSlots {
     /**
      * Custom toolbar template.
@@ -92,29 +117,44 @@ export interface EditorSlots {
     toolbar: () => VNode[];
 }
 
-export declare type EditorEmits = {
+/**
+ * Defines valid emits in Editor component.
+ */
+export interface EditorEmits {
     /**
      * Emitted when the value changes.
      * @param {string} value - New value.
      */
-    'update:modelValue': (value: string) => void;
+    'update:modelValue'(value: string): void;
     /**
      * Callback to invoke when text of editor changes.
      * @param {EditorTextChangeEvent} event - Custom text change event.
      */
-    'text-change': (event: EditorTextChangeEvent) => void;
+    'text-change'(event: EditorTextChangeEvent): void;
     /**
      * Callback to invoke when selection of the text changes.
      * @param {EditorSelectionChangeEvent} event - Custom selection change event.
      */
-    'selection-change': (event: EditorSelectionChangeEvent) => void;
+    'selection-change'(event: EditorSelectionChangeEvent): void;
     /**
      * Callback to invoke when the quill modules are loaded.
      * @param {EditorLoadEvent} event - Custom load event.
      */
-    load: (event: EditorLoadEvent) => void;
-};
+    load(event: EditorLoadEvent): void;
+}
 
+/**
+ * **PrimeVue - Editor**
+ *
+ * _Editor groups a collection of contents in tabs._
+ *
+ * [Live Demo](https://www.primevue.org/editor/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Editor extends ClassComponent<EditorProps, EditorSlots, EditorEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -123,13 +163,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Editor is rich text editor component based on Quill.
- *
- * Demos:
- *
- * - [Editor](https://www.primefaces.org/primevue/editor)
- *
- */
 export default Editor;

package/fieldset/Fieldset.d.ts

@@ -1,6 +1,19 @@
-import { VNode } from 'vue';
+/**
+ *
+ * Fieldset is a grouping component with the optional content toggle feature.
+ *
+ * [Live Demo](https://www.primevue.org/fieldset/)
+ *
+ * @module fieldset
+ *
+ */
+import { AnchorHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom toggle event.
+ * @see {@link FieldsetEmits.toggle}
+ */
 export interface FieldsetToggleEvent {
     /**
      * Browser event.
@@ -12,6 +25,9 @@ export interface FieldsetToggleEvent {
     value: boolean;
 }
 
+/**
+ * Defines valid properties in Fieldset component.
+ */
 export interface FieldsetProps {
     /**
      * Header text of the fieldset.
@@ -19,18 +35,23 @@ export interface FieldsetProps {
     legend?: string | undefined;
     /**
      * When specified, content can toggled by clicking the legend.
+     * @defaultValue false
      */
     toggleable?: boolean | undefined;
     /**
      * Defines the default visibility state of the content.
+     * @defaultValue false
      */
     collapsed?: boolean | undefined;
     /**
-     * Uses to pass the custom value to read for the anchor inside the component.
+     * Uses to pass the custom value to read for the AnchorHTMLAttributes inside the component.
      */
-    toggleButtonProps?: object | undefined;
+    toggleButtonProps?: AnchorHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slots in Fieldset slots.
+ */
 export interface FieldsetSlots {
     /**
      * Default content slot.
@@ -42,19 +63,34 @@ export interface FieldsetSlots {
     legend: () => VNode[];
 }
 
-export declare type FieldsetEmits = {
+/**
+ * Defines valid emits in Fildset component.
+ */
+export interface FieldsetEmits {
     /**
      * Emitted when the collapsed changes.
      * @param {boolean} value - New value.
      */
-    'update:collapsed': (value: boolean) => void;
+    'update:collapsed'(value: boolean): void;
     /**
      * Callback to invoke when a tab gets expanded or collapsed.
      * @param {FieldsetToggleEvent} event - Custom toggle event.
      */
-    toggle: (event: FieldsetToggleEvent) => void;
-};
+    toggle(event: FieldsetToggleEvent): void;
+}
 
+/**
+ * **PrimeVue - Fieldset**
+ *
+ * _Fieldset is a grouping component with the optional content toggle feature._
+ *
+ * [Live Demo](https://www.primevue.org/fieldset/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Fieldset extends ClassComponent<FieldsetProps, FieldsetSlots, FieldsetEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -63,13 +99,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Fieldset is a grouping component with the optional content toggle feature.
- *
- * Demos:
- *
- * - [Fieldset](https://www.primefaces.org/primevue/fieldset)
- *
- */
 export default Fieldset;

package/fileupload/FileUpload.d.ts

@@ -1,8 +1,19 @@
+/**
+ *
+ * FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.
+ *
+ * [Live Demo](https://www.primevue.org/fileupload/)
+ *
+ * @module fileupload
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type FileUploadModeType = 'advanced' | 'basic' | undefined;
-
+/**
+ * Custom select event.
+ * @see {@link FileUploadEmits.select}
+ */
 export interface FileUploadSelectEvent {
     /**
      * Browser event.
@@ -14,6 +25,10 @@ export interface FileUploadSelectEvent {
     files: any;
 }
 
+/**
+ * Custom before upload event.
+ * @see {@link FileUploadEmits['before-upload']}
+ */
 export interface FileUploadBeforeUploadEvent {
     /**
      * XmlHttpRequest instance.
@@ -25,6 +40,10 @@ export interface FileUploadBeforeUploadEvent {
     formData: FormData;
 }
 
+/**
+ * Custom progress event.
+ * @see {@link FileUploadEmits.progress }
+ */
 export interface FileUploadProgressEvent {
     /**
      * Browser event.
@@ -36,6 +55,10 @@ export interface FileUploadProgressEvent {
     progress: number;
 }
 
+/**
+ * Custom upload event.
+ * @see {@link FileUploadEmits.upload}
+ */
 export interface FileUploadUploadEvent {
     /**
      * XmlHttpRequest instance.
@@ -47,13 +70,20 @@ export interface FileUploadUploadEvent {
     files: File | File[];
 }
 
+/**
+ * Custom uploader event.
+ * @see {@link FileUploadEmits.uploader}
+ */
 export interface FileUploadUploaderEvent {
     /**
      * List of selected files.
      */
     files: File | File[];
 }
-
+/**
+ * Custom error event.
+ * @see {@link FileUploadEmits.error}
+ */
 export interface FileUploadErrorEvent {
     /**
      * XmlHttpRequest instance.
@@ -64,7 +94,10 @@ export interface FileUploadErrorEvent {
      */
     files: File | File[];
 }
-
+/**
+ * Custom before send event.
+ * @see {@link FileUploadEmits['before-send']}
+ */
 export interface FileUploadBeforeSendEvent {
     /**
      * XmlHttpRequest instance.
@@ -76,6 +109,10 @@ export interface FileUploadBeforeSendEvent {
     formData: FormData;
 }
 
+/**
+ * Custom remove event.
+ * @see {@link FileUploadEmits.remove}
+ */
 export interface FileUploadRemoveEvent {
     /**
      * Removed file.
@@ -86,7 +123,10 @@ export interface FileUploadRemoveEvent {
      */
     files: File[];
 }
-
+/**
+ * Custom remove upload file event.
+ * @see {@link FileUploadEmits['remove-uploaded-file']}
+ */
 export interface FileUploadRemoveUploadedFile {
     /**
      * Removed file.
@@ -98,6 +138,9 @@ export interface FileUploadRemoveUploadedFile {
     files: File[];
 }
 
+/**
+ * Defines valid properties in FileUpload component.
+ */
 export interface FileUploadProps {
     /**
      * Name of the request parameter to identify the files at backend.
@@ -109,12 +152,12 @@ export interface FileUploadProps {
     url?: string | undefined;
     /**
      * Defines the UI of the component, possible values are 'advanced' and 'basic'.
-     * @see FileUploadModeType
-     * Default value is 'advanced'.
+     * @defaultValue advanced
      */
-    mode?: FileUploadModeType;
+    mode?: 'advanced' | 'basic' | undefined;
     /**
      * Used to select multiple files at once from file dialog.
+     * @defaultValue false
      */
     multiple?: boolean | undefined;
     /**
@@ -123,10 +166,12 @@ export interface FileUploadProps {
     accept?: string | undefined;
     /**
      * Disables the upload functionality.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
      * When enabled, upload begins automatically after selection is completed.
+     * @defaultValue false
      */
     auto?: boolean | undefined;
     /**
@@ -135,17 +180,17 @@ export interface FileUploadProps {
     maxFileSize?: number | undefined;
     /**
      * Message of the invalid fize size.
-     * Default value is '{0}: Invalid file size, file size should be smaller than {1}.'.
+     * @defaultValue {0}: Invalid file size, file size should be smaller than {1.}
      */
     invalidFileSizeMessage?: string | undefined;
     /**
      * Message to display when number of files to be uploaded exceeeds the limit.
-     * Default value is 'Maximum number of files exceeded, limit is {0} at most.'.
+     * @defaultValue Maximum number of files to be uploaded is {0.}
      */
     invalidFileLimitMessage?: string | undefined;
     /**
      * Message of the invalid fize type.
-     * Default value is '{0}: Invalid file type, allowed file types: {1}.'.
+     * @defaultValue '{0}: Invalid file type.'
      */
     invalidFileTypeMessage?: string | undefined;
     /**
@@ -154,11 +199,12 @@ export interface FileUploadProps {
     fileLimit?: number | undefined;
     /**
      * Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates.
+     * @defaultValue false
      */
     withCredentials?: boolean | undefined;
     /**
      * Width of the image thumbnail in pixels.
-     * Default value is 50.
+     * @defaultValue 50
      */
     previewWidth?: number | undefined;
     /**
@@ -167,12 +213,11 @@ export interface FileUploadProps {
     chooseLabel?: string | undefined;
     /**
      * Label of the upload button. Defaults to PrimeVue Locale configuration.
-     * Default value is 'Upload'.
      */
     uploadLabel?: string | undefined;
     /**
      * Label of the cancel button. Defaults to PrimeVue Locale configuration.
-     * Default value is 'Cancel'.
+     * @defaultValue Cancel
      */
     cancelLabel?: string | undefined;
     /**
@@ -181,24 +226,27 @@ export interface FileUploadProps {
     customUpload?: boolean | undefined;
     /**
      * Whether to show the upload button.
-     * Default value is true.
+     * @defaultValue true
      */
     showUploadButton?: boolean | undefined;
     /**
      * Whether to show the cancel button.
-     * Default value is true.
+     * @defaultValue true
      */
     showCancelButton?: boolean | undefined;
     /**
      * Icon of the choose button.
+     * @defaultValue pi pi-fw pi-plus
      */
     chooseIcon?: string | undefined;
     /**
      * Icon of the upload button.
+     * @defaultValue pi pi-fw pi-upload
      */
     uploadIcon?: string | undefined;
     /**
      * Icon of the cancel button.
+     * @defaultValue pi pi-fw pi-times
      */
     cancelIcon?: string | undefined;
     /**
@@ -211,11 +259,14 @@ export interface FileUploadProps {
     class?: any;
 }
 
+/**
+ * Defines valid slots in FileUpload slots.
+ */
 export interface FileUploadSlots {
     /**
      * Custom header content template.
      */
-    header: (scope: {
+    header(scope: {
         /**
          * Files to upload.
          */
@@ -227,20 +278,20 @@ export interface FileUploadSlots {
         /**
          * Choose function
          */
-        chooseCallback: () => void;
+        chooseCallback(): void;
         /**
          * Upload function
          */
-        uploadCallback: () => void;
+        uploadCallback(): void;
         /**
          *  Clear function
          */
-        clearCallback: () => void;
-    }) => VNode[];
+        clearCallback(): void;
+    }): VNode[];
     /**
      * Custom uploaded content template.
      */
-    content: (scope: {
+    content(scope: {
         /**
          * Files to upload.
          */
@@ -252,11 +303,11 @@ export interface FileUploadSlots {
         /**
          * Function to remove an uploaded file.
          */
-        removeUploadedFileCallback: (index: number) => void;
+        removeUploadedFileCallback(index: number): void;
         /**
          * Function to remove a file.
          */
-        removeFileCallback: (index: number) => void;
+        removeFileCallback(index: number): void;
         /**
          *  Uploaded progress as number.
          */
@@ -265,65 +316,77 @@ export interface FileUploadSlots {
          * Status messages about upload process.
          */
         messages: string | undefined;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom content when there is no selected file.
      */
-    empty: () => VNode[];
+    empty(): VNode[];
 }
 
-export declare type FileUploadEmits = {
+export interface FileUploadEmits {
     /**
      * Callback to invoke when files are selected.
      * @param {FileUploadSelectEvent} event - Custom select event.
      */
-    select: (event: FileUploadSelectEvent) => void;
+    select(event: FileUploadSelectEvent): void;
     /**
      * Callback to invoke before file upload begins to customize the request such as post parameters before the files.
      * @param {FileUploadBeforeUploadEvent} event - Custom before upload event.
      */
-    'before-upload': (event: FileUploadBeforeUploadEvent) => void;
+    'before-upload'(event: FileUploadBeforeUploadEvent): void;
     /**
      * Callback to invoke when files are being uploaded.
      * @param {FileUploadProgressEvent} event - Custom progress event.
      */
-    progress: (event: FileUploadProgressEvent) => void;
+    progress(event: FileUploadProgressEvent): void;
     /**
      * Callback to invoke when file upload is complete.
      * @param {FileUploadUploadEvent} event - Custom upload event.
      */
-    upload: (event: FileUploadUploadEvent) => void;
+    upload(event: FileUploadUploadEvent): void;
     /**
      * Callback to invoke to implement a custom upload.
      * @param {FileUploadUploaderEvent} event - Custom uploader event.
      */
-    uploader: (event: FileUploadUploaderEvent) => void;
+    uploader(event: FileUploadUploaderEvent): void;
     /**
      * Callback to invoke if file upload fails.
      * @param {FileUploadErrorEvent} event - Custom error event.
      */
-    error: (event: FileUploadErrorEvent) => void;
+    error(event: FileUploadErrorEvent): void;
     /**
      * Callback to invoke before file send begins to customize the request such as adding headers.
      * @param {FileUploadBeforeSendEvent} event - Custom before send event.
      */
-    'before-send': (event: FileUploadBeforeSendEvent) => void;
+    'before-send'(event: FileUploadBeforeSendEvent): void;
     /**
      * Callback to invoke when files in queue are removed without uploading.
      */
-    clear: () => void;
+    clear(): void;
     /**
      * Callback to invoke when a singe file is removed from the list.
      * @param {FileUploadRemoveEvent} event - Custom remove event.
      */
-    remove: (event: FileUploadRemoveEvent) => void;
+    remove(event: FileUploadRemoveEvent): void;
     /**
      * Callback to invoke when a single uploaded file is removed from the uploaded file list.
      * @param {FileUploadRemoveUploadedFile} event - Custom uploaded file remove event.
      */
-    removeUploadedFile: (event: FileUploadRemoveUploadedFile) => void;
-};
+    removeUploadedFile(event: FileUploadRemoveUploadedFile): void;
+}
 
+/**
+ * **PrimeVue - FileUpload**
+ *
+ * _FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations._
+ *
+ * [Live Demo](https://www.primevue.org/fileupload/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class FileUpload extends ClassComponent<FileUploadProps, FileUploadSlots, FileUploadEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -332,13 +395,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.
- *
- * Demos:
- *
- * - [FileUpload](https://www.primefaces.org/primevue/fileupload)
- *
- */
 export default FileUpload;

package/focustrap/FocusTrap.d.ts

@@ -1,5 +1,44 @@
-import { ObjectDirective } from 'vue';
+/**
+ *
+ * Focus Trap keeps focus within a certain DOM element while tabbing.
+ *
+ * [Live Demo](https://primevue.org/focustrap)
+ *
+ * @module focustrap
+ */
+import { DirectiveBinding, ObjectDirective } from 'vue';
 
-declare const Ripple: ObjectDirective;
+/**
+ * Defines options of FocusTrap.
+ */
+export interface FocusTrapOptions {
+    /**
+     * When present, it specifies that the directive should be disabled.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+}
 
-export default Ripple;
+/**
+ * Binding of FocusTrap directive.
+ */
+export interface FocusTrapDirectiveBinding extends Omit<DirectiveBinding, 'modifiers' | 'value'> {
+    /**
+     * Value of the FocusTrap.
+     */
+    value?: FocusTrapOptions | undefined;
+}
+
+/**
+ * **PrimeVue - FocusTrap**
+ *
+ * _FocusTrap directive provides advisory information for a component._
+ *
+ * [Live Demo](https://www.primevue.org/focustrap/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ */
+declare const FocusTrap: ObjectDirective;
+
+export default FocusTrap;

package/fullcalendar/FullCalendar.d.ts

@@ -27,7 +27,7 @@ declare module '@vue/runtime-core' {
  *
  * Demos:
  *
- * - [FullCalendar](https://www.primefaces.org/primevue/fullcalendar)
+ * - [FullCalendar](https://primevue.org/fullcalendar)
  *
  * @deprecated
  */