Add api docs

pull/1196/head^2
Cagatay Civici 2021-05-14 12:18:42 +03:00
parent 805efbea4e
commit 31c8dcba48
8 changed files with 78 additions and 2 deletions

View File

@ -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."
}
];

View File

@ -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",

View File

@ -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."
}
];

View File

@ -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."
}
]
}
];

View File

@ -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."
}
];

View File

@ -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.'
}
];

View File

@ -280,7 +280,7 @@ myUploader(event) {
</tr>
<tr>
<td>remove</td>
<td>event.file: Remove filed <br />
<td>event.file: Removed file. <br />
event.files: Remaining files to be uploaded.</td>
<td>Callback to invoke when a singe file is removed from the list.</td>
</tr>

View File

@ -655,6 +655,12 @@ export default {
<td>string</td>
<td>undefined</td>
<td>Locale to use in filtering. The default locale is the host environment's current locale.</td>
</tr>
<tr>
<td>scrollHeight</td>
<td>string</td>
<td>null</td>
<td>Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.</td>
</tr>
</tbody>
</table>