From 31c8dcba48c41859f4cf5242e4c3370e28170a4f Mon Sep 17 00:00:00 2001 From: Cagatay Civici Date: Fri, 14 May 2021 12:18:42 +0300 Subject: [PATCH] Add api docs --- api-generator/components/cascadeselect.js | 12 ++++++++++++ api-generator/components/datatable.js | 2 +- api-generator/components/dropdown.js | 12 ++++++++++++ api-generator/components/fileupload.js | 16 +++++++++++++++ api-generator/components/multiselect.js | 24 +++++++++++++++++++++++ api-generator/components/tree.js | 6 ++++++ src/views/fileupload/FileUploadDoc.vue | 2 +- src/views/tree/TreeDoc.vue | 6 ++++++ 8 files changed, 78 insertions(+), 2 deletions(-) diff --git a/api-generator/components/cascadeselect.js b/api-generator/components/cascadeselect.js index 16dd65151..3cf69159c 100644 --- a/api-generator/components/cascadeselect.js +++ b/api-generator/components/cascadeselect.js @@ -82,6 +82,18 @@ const CascadeSelectProps = [ type: "string", default: "null", description: "Style class of the overlay panel." + }, + { + name: "loading", + type: "boolean", + default: "false", + description: "Whether the multiselect is in loading state." + }, + { + name: "loadingIcon", + type: "string", + default: "pi pi-spinner pi-spin", + description: "Icon to display in loading state." } ]; diff --git a/api-generator/components/datatable.js b/api-generator/components/datatable.js index a452a9196..17dd33d24 100644 --- a/api-generator/components/datatable.js +++ b/api-generator/components/datatable.js @@ -309,7 +309,7 @@ const DataTableProps = [ name: "scrollHeight", type: "string", default: "null", - description: 'Height of the scroll viewport in fixed pixels or the "flex" keyword for a dynamic size.' + description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.' }, { name: "frozenValue", diff --git a/api-generator/components/dropdown.js b/api-generator/components/dropdown.js index db454ef94..a04a1110d 100644 --- a/api-generator/components/dropdown.js +++ b/api-generator/components/dropdown.js @@ -142,6 +142,18 @@ const DividerProps = [ type: "string", default: "null", description: "Style class of the overlay panel." + }, + { + name: "loading", + type: "boolean", + default: "false", + description: "Whether the multiselect is in loading state." + }, + { + name: "loadingIcon", + type: "string", + default: "pi pi-spinner pi-spin", + description: "Icon to display in loading state." } ]; diff --git a/api-generator/components/fileupload.js b/api-generator/components/fileupload.js index 6adccf550..3160d49f0 100644 --- a/api-generator/components/fileupload.js +++ b/api-generator/components/fileupload.js @@ -226,6 +226,22 @@ const FileUploadEvents = [ description: "List of selected files." } ] + }, + { + name: "remove", + description: "Callback to invoke when a singe file is removed from the list.", + arguments: [ + { + file: "event.file", + type: "object", + description: "Removed file." + }, + { + file: "event.files", + type: "object", + description: "Remaining files to be uploaded." + } + ] } ]; diff --git a/api-generator/components/multiselect.js b/api-generator/components/multiselect.js index f6a97db83..227db1070 100644 --- a/api-generator/components/multiselect.js +++ b/api-generator/components/multiselect.js @@ -136,6 +136,30 @@ const MultiSelectProps = [ type: "string", default: "null", description: "Style class of the overlay panel." + }, + { + name: "selectionLimit", + type: "number", + default: "null", + description: "Maximum number of selectable items." + }, + { + name: "showToggleAll", + type: "boolean", + default: "false", + description: "Whether to show the header checkbox to toggle the selection of all items at once." + }, + { + name: "loading", + type: "boolean", + default: "false", + description: "Whether the multiselect is in loading state." + }, + { + name: "loadingIcon", + type: "string", + default: "pi pi-spinner pi-spin", + description: "Icon to display in loading state." } ]; diff --git a/api-generator/components/tree.js b/api-generator/components/tree.js index 2d0db0e2c..81e902a76 100644 --- a/api-generator/components/tree.js +++ b/api-generator/components/tree.js @@ -70,6 +70,12 @@ const TreeProps = [ type: "string", default: "undefined", description: "Locale to use in filtering. The default locale is the host environment's current locale." + }, + { + name: "scrollHeight", + type: "string", + default: "null", + description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.' } ]; diff --git a/src/views/fileupload/FileUploadDoc.vue b/src/views/fileupload/FileUploadDoc.vue index 3d060f22b..7aa2b1c89 100755 --- a/src/views/fileupload/FileUploadDoc.vue +++ b/src/views/fileupload/FileUploadDoc.vue @@ -280,7 +280,7 @@ myUploader(event) { remove - event.file: Remove filed
+ event.file: Removed file.
event.files: Remaining files to be uploaded. Callback to invoke when a singe file is removed from the list. diff --git a/src/views/tree/TreeDoc.vue b/src/views/tree/TreeDoc.vue index 23221fd12..3a9b6834b 100755 --- a/src/views/tree/TreeDoc.vue +++ b/src/views/tree/TreeDoc.vue @@ -655,6 +655,12 @@ export default { string undefined Locale to use in filtering. The default locale is the host environment's current locale. + + + scrollHeight + string + null + Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.