@primereact/mcp 11.0.0-rc.2

package/data/llms/headless/components/fileupload/api.json

@@ -0,0 +1,905 @@
+[
+  {
+    "name": "useFileUpload",
+    "source": "apps/showcase/assets/apidoc/usefileupload.json",
+    "data": {
+      "description": "The useFileUpload manages the state and functionality of a fileupload component.",
+      "interfaces": {
+        "UseFileUploadHandlerEvent": {
+          "description": "Custom upload handler event",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "List of files to be uploaded."
+            },
+            {
+              "name": "options",
+              "type": "{ clear: () => void; props: UseFileUploadProps }",
+              "default": "",
+              "description": "Options object containing utility methods and component properties."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadSelectEvent": {
+          "description": "Custom file select event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "ChangeEvent<HTMLInputElement, Element> | DragEvent",
+              "default": "",
+              "description": "Original browser event."
+            },
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "List of selected files."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadRemoveEvent": {
+          "description": "Custom file remove event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "file",
+              "type": "File",
+              "default": "",
+              "description": "Removed file."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadBeforeUploadEvent": {
+          "description": "Custom before upload event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "xhr",
+              "type": "XMLHttpRequest",
+              "default": "",
+              "description": "XmlHttpRequest instance."
+            },
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "Files to be uploaded."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadUploadEvent": {
+          "description": "Custom upload event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "xhr",
+              "type": "XMLHttpRequest",
+              "default": "",
+              "description": "XmlHttpRequest instance."
+            },
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "Uploaded files."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileError": {
+          "description": "A single validation error with its reason and resolved message.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "reason",
+              "type": "\"fileType\" | \"fileSize\" | \"fileLimit\"",
+              "default": "",
+              "description": "The validation rule that failed."
+            },
+            {
+              "name": "message",
+              "type": "string",
+              "default": "",
+              "description": "Ready-to-display message resolved from the matching invalidFile*Message prop."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadRejectedFile": {
+          "description": "A file rejected during selection, grouped with all of its validation errors.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "file",
+              "type": "File",
+              "default": "",
+              "description": "The rejected file. Undefined for file limit rejections, which are not tied to a single file."
+            },
+            {
+              "name": "errors",
+              "type": "UseFileUploadFileError[]",
+              "default": "",
+              "description": "All validation errors collected for this file."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadValidationErrorEvent": {
+          "description": "Custom error event for client-side validation failures (raised once per selection, with all rejected files collected).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "type",
+              "type": "\"validation\"",
+              "default": "",
+              "description": "Discriminator identifying the error source."
+            },
+            {
+              "name": "rejectedFiles",
+              "type": "UseFileUploadRejectedFile[]",
+              "default": "",
+              "description": "All files rejected by validation during this selection, each with its collected errors."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadUploadErrorEvent": {
+          "description": "Custom error event for an upload (XHR) failure.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "type",
+              "type": "\"upload\"",
+              "default": "",
+              "description": "Discriminator identifying the error source."
+            },
+            {
+              "name": "reason",
+              "type": "\"upload\"",
+              "default": "",
+              "description": "Always \"upload\" for upload failures."
+            },
+            {
+              "name": "xhr",
+              "type": "XMLHttpRequest",
+              "default": "",
+              "description": "XmlHttpRequest instance."
+            },
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "Files that failed to upload."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadChangeEvent": {
+          "description": "Custom change event. Fired whenever the selected (pending) file set changes — on select, remove and clear.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "acceptedFiles",
+              "type": "File[]",
+              "default": "",
+              "description": "The current list of accepted (pending) files after the change."
+            },
+            {
+              "name": "rejectedFiles",
+              "type": "UseFileUploadRejectedFile[]",
+              "default": "",
+              "description": "Files rejected by validation during this change, each grouped with its errors (empty when nothing was rejected)."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadProgressEvent": {
+          "description": "Custom progress event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "ProgressEvent",
+              "default": "",
+              "description": "Original browser event."
+            },
+            {
+              "name": "progress",
+              "type": "number",
+              "default": "",
+              "description": "Calculated progress value."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadBeforeSendEvent": {
+          "description": "Custom before send event.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "xhr",
+              "type": "XMLHttpRequest",
+              "default": "",
+              "description": "XmlHttpRequest instance."
+            },
+            {
+              "name": "formData",
+              "type": "FormData",
+              "default": "",
+              "description": "FormData object."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadProps": {
+          "description": "Defines valid properties in useFileUpload.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "Name of the request parameter to identify the files at backend."
+            },
+            {
+              "name": "url",
+              "type": "string",
+              "default": "",
+              "description": "Remote url to upload the files."
+            },
+            {
+              "name": "multiple",
+              "type": "boolean",
+              "default": "false",
+              "description": "Used to select multiple files at once from file dialog."
+            },
+            {
+              "name": "accept",
+              "type": "string",
+              "default": "",
+              "description": "Pattern to restrict the allowed file types such as \"image/*\"."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "name": "auto",
+              "type": "boolean",
+              "default": "false",
+              "description": "When enabled, upload begins automatically after selection is completed."
+            },
+            {
+              "name": "maxFileSize",
+              "type": "number",
+              "default": "",
+              "description": "Maximum file size allowed in bytes."
+            },
+            {
+              "name": "fileLimit",
+              "type": "number",
+              "default": "",
+              "description": "Maximum number of files that can be uploaded."
+            },
+            {
+              "name": "withCredentials",
+              "type": "boolean",
+              "default": "false",
+              "description": "Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates."
+            },
+            {
+              "name": "customUpload",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether to use the default upload or a manual implementation defined in uploadHandler callback."
+            },
+            {
+              "name": "invalidFileLimitMessage",
+              "type": "string",
+              "default": "'Maximum number of files exceeded, limit is {0} at most.'",
+              "description": "Message to display when number of files to be uploaded exceeds the limit."
+            },
+            {
+              "name": "invalidFileSizeMessage",
+              "type": "string",
+              "default": "'{0}: Invalid file size, file size should be smaller than {1}.'",
+              "description": "Message to display when file size exceeds the limit."
+            },
+            {
+              "name": "invalidFileTypeMessage",
+              "type": "string",
+              "default": "'{0}: Invalid file type, allowed file types: {1}.'",
+              "description": "Message to display when file type is not allowed."
+            },
+            {
+              "name": "uploadHandler",
+              "type": "(event: UseFileUploadHandlerEvent) => void",
+              "default": "",
+              "description": "Callback to invoke to implement a custom upload."
+            },
+            {
+              "name": "onSelect",
+              "type": "(event: UseFileUploadSelectEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when files are selected."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: UseFileUploadChangeEvent) => void",
+              "default": "",
+              "description": "Callback to invoke whenever the selected (pending) file set changes — on select, remove and clear. Carries the current accepted files and any files rejected by validation, so message/UI state can be synced in one place."
+            },
+            {
+              "name": "onBeforeUpload",
+              "type": "(event: UseFileUploadBeforeUploadEvent) => void",
+              "default": "",
+              "description": "Callback to invoke before file upload begins to customize the request such as post parameters before the files."
+            },
+            {
+              "name": "onUpload",
+              "type": "(event: UseFileUploadUploadEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when file upload is complete."
+            },
+            {
+              "name": "onError",
+              "type": "(event: UseFileUploadErrorEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when a client-side validation fails (invalid type/size/limit) or an upload fails. Discriminate via  `event.type` ."
+            },
+            {
+              "name": "onProgress",
+              "type": "(event: UseFileUploadProgressEvent) => void",
+              "default": "",
+              "description": "Callback to invoke on upload progress."
+            },
+            {
+              "name": "onBeforeSend",
+              "type": "(event: UseFileUploadBeforeSendEvent) => void",
+              "default": "",
+              "description": "Callback to invoke before send for customization such as adding headers."
+            },
+            {
+              "name": "onClear",
+              "type": "() => void",
+              "default": "",
+              "description": "Callback to invoke when files in queue are removed without uploading."
+            },
+            {
+              "name": "onRemove",
+              "type": "(event: UseFileUploadRemoveEvent) => void",
+              "default": "",
+              "description": "Callback to invoke when a file is removed."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadState": {
+          "description": "Defines valid state in useFileUpload.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "files",
+              "type": "File[]",
+              "default": "",
+              "description": "List of currently selected files to be uploaded."
+            },
+            {
+              "name": "progress",
+              "type": "number",
+              "default": "",
+              "description": "Current upload progress as a percentage (0-100)."
+            },
+            {
+              "name": "uploadedFiles",
+              "type": "File[]",
+              "default": "",
+              "description": "List of successfully uploaded files."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadRootProps": {
+          "description": "Pre-built props for the root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"root\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadChooseProps": {
+          "description": "Pre-built props for the choose button element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler that opens the file selection dialog."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadUploadProps": {
+          "description": "Pre-built props for the upload button element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "onClick",
+              "type": "() => void",
+              "default": "",
+              "description": "Click handler that initiates the upload process."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the upload button is disabled (no files selected)."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadInputProps": {
+          "description": "Pre-built props for the file input element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "ref",
+              "type": "(node: HTMLInputElement) => void",
+              "default": "",
+              "description": "Callback ref for the file input element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"text\"",
+              "default": "",
+              "description": "Data part attribute."
+            },
+            {
+              "name": "type",
+              "type": "\"file\"",
+              "default": "",
+              "description": "Input type (always 'file')."
+            },
+            {
+              "name": "accept",
+              "type": "string",
+              "default": "",
+              "description": "Accepted file types."
+            },
+            {
+              "name": "multiple",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether multiple files can be selected."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is disabled."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement, Element> | DragEvent) => void",
+              "default": "",
+              "description": "Change handler for file selection."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadContentProps": {
+          "description": "Pre-built props for the content/drop zone element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "ref",
+              "type": "(node: HTMLDivElement) => void",
+              "default": "",
+              "description": "Callback ref for the content element."
+            },
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"content\"",
+              "default": "",
+              "description": "Data part attribute."
+            },
+            {
+              "name": "role",
+              "type": "\"region\"",
+              "default": "",
+              "description": "Region role exposing the drop zone to assistive technology."
+            },
+            {
+              "name": "aria-busy",
+              "type": "boolean",
+              "default": "",
+              "description": "Reflects whether an upload is currently in progress."
+            },
+            {
+              "name": "onDragEnter",
+              "type": "DragEventHandler<HTMLDivElement>",
+              "default": "",
+              "description": "Handler for drag enter event on the drop zone."
+            },
+            {
+              "name": "onDragOver",
+              "type": "DragEventHandler<HTMLDivElement>",
+              "default": "",
+              "description": "Handler for drag over event on the drop zone."
+            },
+            {
+              "name": "onDragLeave",
+              "type": "DragEventHandler<HTMLDivElement>",
+              "default": "",
+              "description": "Handler for drag leave event on the drop zone."
+            },
+            {
+              "name": "onDrop",
+              "type": "DragEventHandler<HTMLDivElement>",
+              "default": "",
+              "description": "Handler for drop event on the drop zone."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileRemoveProps": {
+          "description": "Pre-built props for the file remove button element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileRemove\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileProps": {
+          "description": "Pre-built props for the file element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"file\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileThumbnailProps": {
+          "description": "Pre-built props for the file thumbnail element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileThumbnail\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileInfoProps": {
+          "description": "Pre-built props for the file info element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileInfo\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileNameProps": {
+          "description": "Pre-built props for the file name element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileName\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileSizeProps": {
+          "description": "Pre-built props for the file size element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileSize\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadFileListProps": {
+          "description": "Pre-built props for the file list element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "\"fileupload\"",
+              "default": "",
+              "description": "Data scope attribute."
+            },
+            {
+              "name": "data-part",
+              "type": "\"fileList\"",
+              "default": "",
+              "description": "Data part attribute."
+            }
+          ],
+          "methods": []
+        },
+        "UseFileUploadExposes": {
+          "description": "Defines the methods and properties exposed by useFileUpload.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseFileUploadState",
+              "default": "",
+              "description": "State of the file upload."
+            },
+            {
+              "name": "uploadedFileCount",
+              "type": "{ current: number }",
+              "default": "",
+              "description": "Reference to track the number of uploaded files for file limit validation."
+            },
+            {
+              "name": "hasFiles",
+              "type": "boolean",
+              "default": "",
+              "description": "Indicates whether there are files selected for upload."
+            },
+            {
+              "name": "hasUploadedFiles",
+              "type": "boolean",
+              "default": "",
+              "description": "Indicates whether there are files that have been successfully uploaded."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseFileUploadRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "chooseProps",
+              "type": "UseFileUploadChooseProps",
+              "default": "",
+              "description": "Pre-built props for the choose button element."
+            },
+            {
+              "name": "uploadProps",
+              "type": "UseFileUploadUploadProps",
+              "default": "",
+              "description": "Pre-built props for the upload button element."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseFileUploadInputProps",
+              "default": "",
+              "description": "Pre-built props for the file input element."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseFileUploadContentProps",
+              "default": "",
+              "description": "Pre-built props for the content/drop zone element."
+            },
+            {
+              "name": "fileRemoveProps",
+              "type": "UseFileUploadFileRemoveProps",
+              "default": "",
+              "description": "Pre-built props for the file remove button element."
+            },
+            {
+              "name": "fileProps",
+              "type": "UseFileUploadFileProps",
+              "default": "",
+              "description": "Pre-built props for the file element."
+            },
+            {
+              "name": "fileThumbnailProps",
+              "type": "UseFileUploadFileThumbnailProps",
+              "default": "",
+              "description": "Pre-built props for the file thumbnail element."
+            },
+            {
+              "name": "fileInfoProps",
+              "type": "UseFileUploadFileInfoProps",
+              "default": "",
+              "description": "Pre-built props for the file info element."
+            },
+            {
+              "name": "fileNameProps",
+              "type": "UseFileUploadFileNameProps",
+              "default": "",
+              "description": "Pre-built props for the file name element."
+            },
+            {
+              "name": "fileSizeProps",
+              "type": "UseFileUploadFileSizeProps",
+              "default": "",
+              "description": "Pre-built props for the file size element."
+            },
+            {
+              "name": "fileListProps",
+              "type": "UseFileUploadFileListProps",
+              "default": "",
+              "description": "Pre-built props for the file list element."
+            },
+            {
+              "name": "upload",
+              "type": "() => void",
+              "default": "",
+              "description": "Initiates the upload process for selected files."
+            },
+            {
+              "name": "cancelUpload",
+              "type": "() => void",
+              "default": "",
+              "description": "Aborts the in-progress XHR upload (if any) and resets progress."
+            },
+            {
+              "name": "choose",
+              "type": "() => void",
+              "default": "",
+              "description": "Programmatically triggers the file selection dialog."
+            },
+            {
+              "name": "clear",
+              "type": "() => void",
+              "default": "",
+              "description": "Clears all selected files."
+            },
+            {
+              "name": "remove",
+              "type": "(index: number) => void",
+              "default": "",
+              "description": "Removes a file from the selected files list by index."
+            },
+            {
+              "name": "removeUploadedFile",
+              "type": "(index: number) => void",
+              "default": "",
+              "description": "Removes a file from the uploaded files list by index."
+            },
+            {
+              "name": "formatSize",
+              "type": "(bytes: number) => string",
+              "default": "",
+              "description": "Formats a file size in bytes to a human-readable string."
+            },
+            {
+              "name": "onFileSelect",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Handler for file selection from input or drag-and-drop."
+            },
+            {
+              "name": "onDragEnter",
+              "type": "(event: DragEvent) => void",
+              "default": "",
+              "description": "Handler for drag enter event."
+            },
+            {
+              "name": "onDragOver",
+              "type": "(event: DragEvent) => void",
+              "default": "",
+              "description": "Handler for drag over event."
+            },
+            {
+              "name": "onDragLeave",
+              "type": "() => void",
+              "default": "",
+              "description": "Handler for drag leave event."
+            },
+            {
+              "name": "onDrop",
+              "type": "(event: DragEvent) => void",
+              "default": "",
+              "description": "Handler for drop event."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseFileUploadErrorReason": {
+          "description": "The reason a file upload error occurred.",
+          "values": "\"fileType\" | \"fileSize\" | \"fileLimit\" | \"upload\""
+        },
+        "UseFileUploadErrorEvent": {
+          "description": "Custom error event. Fired for both client-side validation failures and upload failures; discriminate via  `type` .",
+          "values": "UseFileUploadValidationErrorEvent | UseFileUploadUploadErrorEvent"
+        },
+        "UseFileUploadInstance": {
+          "description": "Instance of useFileUpload headless.",
+          "values": "HeadlessInstance<UseFileUploadProps, UseFileUploadState, UseFileUploadExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]