diff --git a/api-generator/build-apidoc.js b/api-generator/build-apidoc.js
index f56c48531..631829760 100644
--- a/api-generator/build-apidoc.js
+++ b/api-generator/build-apidoc.js
@@ -167,6 +167,11 @@ if (project) {
description: '',
values: []
};
+
+ const methods = {
+ description: '',
+ values: []
+ };
const model_props_group = model.groups.find((g) => g.title === 'Properties');
model_props_group &&
@@ -181,9 +186,55 @@ if (project) {
});
});
+ const model_methods_group = model.groups.find((g) => g.title === 'Methods');
+
+ model_methods_group &&
+ model_methods_group.children.forEach((method) => {
+ const signature = method.getAllSignatures()[0];
+ const isSlot = model.name.includes('Slots');
+
+ methods.values.push({
+ name: signature.name,
+ parameters: signature.parameters.map((param) => {
+ let type = param.type.toString();
+
+ if (param.type.declaration && isSlot) {
+ type = '';
+
+ if (param.type.declaration.children) {
+ param.type.declaration.children.forEach((child) => {
+ if (child.signatures) {
+ const childSinature = child.signatures[0];
+ const parameters = childSinature.parameters.reduce((acc, { name, type }, index) => (index === 0 ? `${name}: ${type.name}` : `${acc}, ${name}: ${type.name}`), '');
+
+ type += ` \t ${childSinature.name}(${parameters}): ${childSinature.type?.name}, // ${childSinature.comment?.summary[0]?.text}\n `;
+ } else {
+ const childType = child.type.elementType ? child.type.elementType.name : child.type.name;
+
+ type += ` \t ${child.name}: ${childType}, // ${child.comment?.summary[0]?.text}\n `;
+ }
+ });
+ }
+
+ type = `{\n ${type} }`;
+ }
+
+ return {
+ name: param.name,
+ optional: param.flags.isOptional,
+ type: type,
+ description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
+ };
+ }),
+ returnType: signature.type.toString(),
+ description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' ')
+ });
+ });
+
doc[name]['model'][model.name] = {
description: event_props_description,
- props
+ props,
+ methods
};
});
diff --git a/components/autocomplete/AutoComplete.d.ts b/components/autocomplete/AutoComplete.d.ts
index 11cbb614c..dc13fc782 100755
--- a/components/autocomplete/AutoComplete.d.ts
+++ b/components/autocomplete/AutoComplete.d.ts
@@ -278,6 +278,7 @@ export interface AutoCompleteProps {
/**
* Defines valid slots in AutoComplete component.
+ * @todo Next release we should complete types for all slots
*/
export interface AutoCompleteSlots {
/**
diff --git a/components/confirmationoptions/ConfirmationOptions.d.ts b/components/confirmationoptions/ConfirmationOptions.d.ts
index e5030eb81..387bb5738 100644
--- a/components/confirmationoptions/ConfirmationOptions.d.ts
+++ b/components/confirmationoptions/ConfirmationOptions.d.ts
@@ -41,8 +41,9 @@ export interface ConfirmationOptions {
blockScroll?: boolean | undefined;
/**
* Callback to execute when action is confirmed.
+ * @todo Next release should be able to change
*/
- accept?(): void;
+ accept?: () => void;
/**
* Callback to execute when action is rejected.
*/
@@ -50,7 +51,7 @@ export interface ConfirmationOptions {
/**
* Callback to execute when dialog is hidden.
*/
- onHide?(): void;
+ onHide?: () => void;
/**
* Label of the accept button. Defaults to PrimeVue Locale configuration.
*/
diff --git a/components/confirmationservice/ConfirmationService.d.ts b/components/confirmationservice/ConfirmationService.d.ts
index ed7aa39f4..61f659adb 100644
--- a/components/confirmationservice/ConfirmationService.d.ts
+++ b/components/confirmationservice/ConfirmationService.d.ts
@@ -2,7 +2,7 @@
*
* [Live Demo](https://www.primevue.org/confirmdialog/)
*
- * @module confirmationservice
+ * @module confirmationservice-useconfirm
*
*/
import { Plugin } from 'vue';
@@ -13,9 +13,7 @@ export default plugin;
/**
* Confirmation Service methods.
- *
- * @group Interfaces
- *
+ * @group Model
*/
export interface ConfirmationServiceMethods {
/**
diff --git a/components/dialogservice/DialogService.d.ts b/components/dialogservice/DialogService.d.ts
index 26b3a687e..d37ceac1b 100644
--- a/components/dialogservice/DialogService.d.ts
+++ b/components/dialogservice/DialogService.d.ts
@@ -2,7 +2,7 @@
*
* [Live Demo](https://www.primevue.org/dynamicdialog/)
*
- * @module dialogservice
+ * @module dialogservice-usedialog
*
*/
import { Plugin } from 'vue';
@@ -14,7 +14,7 @@ export default plugin;
/**
* Dynamic Dialog components methods.
*
- * @group Interfaces
+ * @group Model
*
*/
export interface DialogServiceMethods {
@@ -24,7 +24,7 @@ export interface DialogServiceMethods {
* @param {DynamicDialogOptions} options - DynamicDialog Object
* @return {@link DynamicDialogInstance}
*/
- open: (content: any, options?: DynamicDialogOptions) => DynamicDialogInstance;
+ open(content: any, options?: DynamicDialogOptions): DynamicDialogInstance;
}
declare module 'vue/types/vue' {
diff --git a/components/terminalservice/TerminalService.d.ts b/components/terminalservice/TerminalService.d.ts
index 3d72de70a..141d53ad7 100755
--- a/components/terminalservice/TerminalService.d.ts
+++ b/components/terminalservice/TerminalService.d.ts
@@ -7,7 +7,7 @@
/**
* Confirmation Service methods.
*
- * @group Interfaces
+ * @group Model
*
*/
export interface TerminalServiceOptions {
diff --git a/components/toastservice/ToastService.d.ts b/components/toastservice/ToastService.d.ts
index dd9901263..a742fe416 100755
--- a/components/toastservice/ToastService.d.ts
+++ b/components/toastservice/ToastService.d.ts
@@ -2,8 +2,8 @@
*
* [Live Demo](https://www.primevue.org/toast/)
*
- * @module toastservice
- *
+ * @module toastservice-usetoast
+ * @todo 'use' is not a valid name for a module. Next release will change.
*/
import { Plugin } from 'vue';
import { ToastMessageOptions } from '../toast';
@@ -14,7 +14,7 @@ export default plugin;
/**
* Toast Service methods.
*
- * @group Interfaces
+ * @group Model
*
*/
export interface ToastServiceMethods {
diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
index 398c44888..e92a783e3 100644
--- a/doc/common/apidoc/index.json
+++ b/doc/common/apidoc/index.json
@@ -2973,7 +2973,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t value: any, // A value in the selection\n }",
+ "type": "{\n \t value: any, // A value in the selection\n }",
"description": "chip slot's params."
}
],
@@ -2986,7 +2986,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
+ "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
"description": "content slot's params."
}
],
@@ -3005,7 +3005,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "footer slot's params."
}
],
@@ -3018,7 +3018,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "header slot's params."
}
],
@@ -3031,7 +3031,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t item: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t item: any, // Option instance\n }",
"description": "item slot's params."
}
],
@@ -3044,7 +3044,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
+ "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
"description": "loader slot's params."
}
],
@@ -3057,7 +3057,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -3070,7 +3070,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t item: any, // undefined\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t item: any, // undefined\n \t option: any, // Option instance\n }",
"description": "option group slot's params."
}
],
@@ -3260,7 +3260,7 @@
"name": "severity",
"optional": true,
"readonly": false,
- "type": "\"success\" | \"info\" | \"warning\" | \"danger\"",
+ "type": "null | \"success\" | \"info\" | \"warning\" | \"danger\"",
"default": "",
"description": "Severity type of the badge."
},
@@ -3268,7 +3268,7 @@
"name": "size",
"optional": true,
"readonly": false,
- "type": "\"large\" | \"xlarge\"",
+ "type": "null | \"large\" | \"xlarge\"",
"default": "",
"description": "Size of the badge, valid options are 'large' and 'xlarge'."
},
@@ -3276,7 +3276,7 @@
"name": "value",
"optional": true,
"readonly": false,
- "type": "any",
+ "type": "string | number",
"default": "",
"description": "Value to display inside the badge."
}
@@ -3545,7 +3545,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -3767,7 +3767,7 @@
"values": {
"CalendarBlurEvent": {
"description": "Custom Calendar blur event.",
- "relatedProp": "undefined.blur",
+ "relatedProp": "CalendarEmits.blur",
"props": [
{
"name": "originalEvent",
@@ -3938,7 +3938,7 @@
},
"CalendarMonthChangeEvent": {
"description": "Custom Calendar month change event.",
- "relatedProp": "undefined.month-change",
+ "relatedProp": "CalendarEmits['month-change']]",
"props": [
{
"name": "month",
@@ -4440,7 +4440,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t date: undefined, // Value of the component.\n }"
+ "type": "{\n \t date: undefined, // Value of the component.\n }"
}
],
"returnType": "VNode[]",
@@ -4452,7 +4452,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t years: undefined, // An array containing the start and and year of a decade to display at header of the year picker.\n }"
+ "type": "{\n \t years: undefined, // An array containing the start and and year of a decade to display at header of the year picker.\n }"
}
],
"returnType": "VNode[]",
@@ -4474,7 +4474,7 @@
},
"CalendarYearChangeEvent": {
"description": "Custom Calendar year change event.",
- "relatedProp": "undefined.year-change",
+ "relatedProp": "CalendarEmits['year-change']]",
"props": [
{
"name": "month",
@@ -4792,7 +4792,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Data of the component\n \t index: number, // Index of the item\n }",
+ "type": "{\n \t data: any, // Data of the component\n \t index: number, // Index of the item\n }",
"description": "item slot's params."
}
],
@@ -4823,7 +4823,7 @@
"values": {
"CascadeSelectChangeEvent": {
"description": "Custom change event",
- "relatedProp": "undefined.change",
+ "relatedProp": "CascadeSelectEmits.change",
"props": [
{
"name": "originalEvent",
@@ -4956,7 +4956,7 @@
},
"CascadeSelectGroupChangeEvent": {
"description": "",
- "relatedProp": "undefined.change",
+ "relatedProp": "CascadeSelectEmits.change",
"props": [
{
"name": "originalEvent",
@@ -5266,7 +5266,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t option: any, // Option instance\n }",
+ "type": "{\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -5279,7 +5279,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t placeholder: string, // Placeholder text to show\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t placeholder: string, // Placeholder text to show\n \t value: any, // Value of the component\n }",
"description": "value slot's params."
}
],
@@ -5431,7 +5431,7 @@
},
"ChartSelectEvent": {
"description": "Custom select event.",
- "relatedProp": "undefined.select",
+ "relatedProp": "ChartEmits.select",
"props": [
{
"name": "dataset",
@@ -5805,8 +5805,8 @@
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ChipsAddEvent": {
- "description": "Custom remove event.",
- "relatedProp": "undefined.remove",
+ "description": "Custom add event.",
+ "relatedProp": "ChipsEmits.add",
"props": [
{
"name": "originalEvent",
@@ -5995,7 +5995,7 @@
},
"ChipsRemoveEvent": {
"description": "Custom remove event.",
- "relatedProp": "undefined.remove",
+ "relatedProp": "ChipsEmits.remove",
"props": [
{
"name": "originalEvent",
@@ -6028,7 +6028,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t value: any, // Value of the component\n }",
"description": "chip slot's params."
}
],
@@ -6059,7 +6059,7 @@
"values": {
"ColorPickerChangeEvent": {
"description": "Custom change event.",
- "relatedProp": "undefined.change",
+ "relatedProp": "ColorPickerEmits.change",
"props": [
{
"name": "originalEvent",
@@ -6280,7 +6280,7 @@
},
"ColumnLoadingOptions": {
"description": "Custom column loading metadata.",
- "relatedProp": "undefined.VirtualScrollerLoaderOptions",
+ "relatedProp": "",
"props": [
{
"name": "cellEven",
@@ -6760,7 +6760,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t node: any, // Row node data.\n \t editorInitCallback(): void, // Callback function\n }",
+ "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t node: any, // Row node data.\n \t editorInitCallback(): void, // Callback function\n }",
"description": "body slot's params."
}
],
@@ -6773,7 +6773,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t editorCancelCallback(): void, // Callback function\n \t editorSaveCallback(): void, // Callback function\n }",
+ "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t editorCancelCallback(): void, // Callback function\n \t editorSaveCallback(): void, // Callback function\n }",
"description": "editor slot's params."
}
],
@@ -6786,7 +6786,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
+ "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
"description": "filter slot's params."
}
],
@@ -6799,7 +6799,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
+ "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
"description": "filter apply slot's params."
}
],
@@ -6812,7 +6812,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
+ "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
"description": "filter clear slot's params."
}
],
@@ -6825,7 +6825,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
+ "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
"description": "filter footer slot's params."
}
],
@@ -6838,7 +6838,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
+ "type": "{\n \t field: string, // Column field.\n \t filterModel: ColumnFilterModelType, // Filter metadata\n \t filterCallback(): void, // Callback function\n }",
"description": "filter header slot's params."
}
],
@@ -6851,7 +6851,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t column: Column, // Column node.\n }",
+ "type": "{\n \t column: Column, // Column node.\n }",
"description": "footer slot's params."
}
],
@@ -6864,7 +6864,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t column: Column, // Column node.\n }",
+ "type": "{\n \t column: Column, // Column node.\n }",
"description": "header slot's params."
}
],
@@ -6877,7 +6877,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t loadingOptions: ColumnLoadingOptions, // Loading options.\n }",
+ "type": "{\n \t column: Column, // Column node.\n \t data: any, // Row data.\n \t field: string, // Column field.\n \t frozenRow: boolean, // Whether the row is frozen.\n \t index: number, // Row index.\n \t loadingOptions: ColumnLoadingOptions, // Loading options.\n }",
"description": "loading slot's params."
}
],
@@ -6960,6 +6960,13 @@
"description": "Confirmation Service options.",
"relatedProp": "",
"props": [
+ {
+ "name": "accept",
+ "optional": true,
+ "readonly": false,
+ "type": "Function",
+ "default": ""
+ },
{
"name": "acceptClass",
"optional": true,
@@ -7032,6 +7039,13 @@
"default": "",
"description": "Message of the confirmation."
},
+ {
+ "name": "onHide",
+ "optional": true,
+ "readonly": false,
+ "type": "Function",
+ "default": ""
+ },
{
"name": "position",
"optional": true,
@@ -7074,18 +7088,6 @@
}
],
"methods": [
- {
- "name": "accept",
- "parameters": [],
- "returnType": "void",
- "description": "Callback to execute when action is confirmed."
- },
- {
- "name": "onHide",
- "parameters": [],
- "returnType": "void",
- "description": "Callback to execute when dialog is hidden."
- },
{
"name": "reject",
"parameters": [],
@@ -7097,19 +7099,18 @@
}
}
},
- "confirmationservice": {
+ "confirmationservice-useconfirm": {
"description": "[Live Demo](https://www.primevue.org/confirmdialog/)",
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "ConfirmationServiceMethods": {
- "description": "Confirmation Service methods.",
- "relatedProp": "",
- "props": [],
- "methods": [
+ "model": {
+ "ConfirmationServiceMethods": {
+ "description": "Confirmation Service methods.",
+ "props": {
+ "description": "",
+ "values": []
+ },
+ "methods": {
+ "description": "",
+ "values": [
{
"name": "close",
"parameters": [],
@@ -7204,7 +7205,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t message: ConfirmationOptions, // undefined\n }",
+ "type": "{\n \t message: ConfirmationOptions, // undefined\n }",
"description": "message slot's params."
}
],
@@ -7265,7 +7266,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t message: ConfirmationOptions, // undefined\n }",
+ "type": "{\n \t message: ConfirmationOptions, // undefined\n }",
"description": "message slot's params."
}
],
@@ -7472,7 +7473,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -9515,7 +9516,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }",
+ "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }",
"description": "expansion slot's params."
}
],
@@ -9534,7 +9535,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }",
+ "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }",
"description": "group footer slot's params."
}
],
@@ -9547,7 +9548,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }"
+ "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }"
}
],
"returnType": "VNode[]",
@@ -9852,8 +9853,8 @@
]
},
"DataViewPageEvent": {
- "description": "Custom change event.",
- "relatedProp": "undefined.page",
+ "description": "Custom page event.",
+ "relatedProp": "DataViewEmits.page",
"props": [
{
"name": "first",
@@ -10048,7 +10049,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }",
+ "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }",
"description": "list slot's params."
}
],
@@ -10067,7 +10068,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }",
+ "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }",
"description": "list slot's params."
}
],
@@ -10553,27 +10554,38 @@
}
}
},
- "dialogservice": {
+ "dialogservice-usedialog": {
"description": "[Live Demo](https://www.primevue.org/dynamicdialog/)",
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "DialogServiceMethods": {
- "description": "Dynamic Dialog components methods.",
- "relatedProp": "",
- "props": [
+ "model": {
+ "DialogServiceMethods": {
+ "description": "Dynamic Dialog components methods.",
+ "props": {
+ "description": "",
+ "values": []
+ },
+ "methods": {
+ "description": "",
+ "values": [
{
"name": "open",
- "optional": false,
- "readonly": false,
- "type": "Function",
- "default": ""
+ "parameters": [
+ {
+ "name": "content",
+ "optional": false,
+ "type": "any",
+ "description": "Dynamic component for content template"
+ },
+ {
+ "name": "options",
+ "optional": true,
+ "type": "DynamicDialogOptions",
+ "description": "DynamicDialog Object"
+ }
+ ],
+ "returnType": "DynamicDialogInstance",
+ "description": "Displays the dialog using the dynamic dialog object options."
}
- ],
- "methods": []
+ ]
}
}
}
@@ -10795,7 +10807,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Custom content for icon.\n }",
+ "type": "{\n \t item: MenuItem, // Custom content for icon.\n }",
"description": "icon slot's params."
}
],
@@ -10808,7 +10820,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the menuitem\n \t item: MenuItem, // Custom content for item.\n }",
+ "type": "{\n \t index: number, // Index of the menuitem\n \t item: MenuItem, // Custom content for item.\n }",
"description": "item slot's params."
}
],
@@ -10868,7 +10880,7 @@
"values": {
"DropdownChangeEvent": {
"description": "Custom change event.",
- "relatedProp": "undefined.change",
+ "relatedProp": "DropdownEmits.change",
"props": [
{
"name": "originalEvent",
@@ -10987,7 +10999,7 @@
},
"DropdownFilterEvent": {
"description": "Custom filter event.",
- "relatedProp": "undefined.filter",
+ "relatedProp": "DropdownEmits.filter",
"props": [
{
"name": "originalEvent",
@@ -11394,7 +11406,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
+ "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
"description": "content slot's params."
}
],
@@ -11419,7 +11431,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "footer slot's params."
}
],
@@ -11432,7 +11444,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "header slot's params."
}
],
@@ -11451,7 +11463,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
+ "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
"description": "loader slot's params."
}
],
@@ -11464,7 +11476,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -11477,7 +11489,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option group slot's params."
}
],
@@ -11490,7 +11502,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }",
"description": "value slot's params."
}
],
@@ -11763,7 +11775,7 @@
},
"EditorLoadEvent": {
"description": "Custom load event.",
- "relatedProp": "undefined.load",
+ "relatedProp": "EditorEmits.load",
"props": [
{
"name": "instance",
@@ -11833,7 +11845,7 @@
},
"EditorSelectionChangeEvent": {
"description": "Custom selection change event.",
- "relatedProp": "undefined.selection-change",
+ "relatedProp": "EditorEmits['selection-change']",
"props": [
{
"name": "htmlValue",
@@ -11902,7 +11914,7 @@
},
"EditorTextChangeEvent": {
"description": "Custom text change event.",
- "relatedProp": "undefined.text-change",
+ "relatedProp": "EditorEmits['text-change']",
"props": [
{
"name": "delta",
@@ -12062,7 +12074,7 @@
},
"FieldsetToggleEvent": {
"description": "Custom toggle event.",
- "relatedProp": "undefined.toggle",
+ "relatedProp": "FieldsetEmits.toggle",
"props": [
{
"name": "originalEvent",
@@ -12105,7 +12117,7 @@
"values": {
"FileUploadBeforeSendEvent": {
"description": "Custom before send event.",
- "relatedProp": "undefined.before-send",
+ "relatedProp": "FileUploadEmits['before-send']",
"props": [
{
"name": "formData",
@@ -12128,7 +12140,7 @@
},
"FileUploadBeforeUploadEvent": {
"description": "Custom before upload event.",
- "relatedProp": "undefined.before-upload",
+ "relatedProp": "FileUploadEmits['before-upload']",
"props": [
{
"name": "formData",
@@ -12280,7 +12292,7 @@
},
"FileUploadErrorEvent": {
"description": "Custom error event.",
- "relatedProp": "undefined.error",
+ "relatedProp": "FileUploadEmits.error",
"props": [
{
"name": "files",
@@ -12303,7 +12315,7 @@
},
"FileUploadProgressEvent": {
"description": "Custom progress event.",
- "relatedProp": "undefined.progress",
+ "relatedProp": "FileUploadEmits.progress",
"props": [
{
"name": "originalEvent",
@@ -12533,7 +12545,7 @@
},
"FileUploadRemoveEvent": {
"description": "Custom remove event.",
- "relatedProp": "undefined.remove",
+ "relatedProp": "FileUploadEmits.remove",
"props": [
{
"name": "file",
@@ -12556,7 +12568,7 @@
},
"FileUploadRemoveUploadedFile": {
"description": "Custom remove upload file event.",
- "relatedProp": "undefined.removeUploadFile",
+ "relatedProp": "FileUploadEmits['remove-uploaded-file']",
"props": [
{
"name": "file",
@@ -12579,7 +12591,7 @@
},
"FileUploadSelectEvent": {
"description": "Custom select event.",
- "relatedProp": "undefined.select",
+ "relatedProp": "FileUploadEmits.select",
"props": [
{
"name": "files",
@@ -12611,7 +12623,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t files: File, // Files to upload.\n \t messages: undefined, // Status messages about upload process.\n \t progress: number, // Uploaded progress as number.\n \t uploadedFiles: File, // Uploaded files.\n \t removeFileCallback(index: number): void, // Function to remove a file.\n \t removeUploadedFileCallback(index: number): void, // Function to remove an uploaded file.\n }"
+ "type": "{\n \t files: File, // Files to upload.\n \t messages: undefined, // Status messages about upload process.\n \t progress: number, // Uploaded progress as number.\n \t uploadedFiles: File, // Uploaded files.\n \t removeFileCallback(index: number): void, // Function to remove a file.\n \t removeUploadedFileCallback(index: number): void, // Function to remove an uploaded file.\n }"
}
],
"returnType": "VNode[]",
@@ -12629,7 +12641,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t files: File, // Files to upload.\n \t uploadedFiles: File, // Uploaded files.\n \t chooseCallback(): void, // Choose function\n \t clearCallback(): void, // Clear function\n \t uploadCallback(): void, // Upload function\n }"
+ "type": "{\n \t files: File, // Files to upload.\n \t uploadedFiles: File, // Uploaded files.\n \t chooseCallback(): void, // Choose function\n \t clearCallback(): void, // Clear function\n \t uploadCallback(): void, // Upload function\n }"
}
],
"returnType": "VNode[]",
@@ -12639,7 +12651,7 @@
},
"FileUploadUploadEvent": {
"description": "Custom upload event.",
- "relatedProp": "undefined.upload",
+ "relatedProp": "FileUploadEmits.upload",
"props": [
{
"name": "files",
@@ -12662,7 +12674,7 @@
},
"FileUploadUploaderEvent": {
"description": "Custom uploader event.",
- "relatedProp": "undefined.uploader",
+ "relatedProp": "FileUploadEmits.uploader",
"props": [
{
"name": "files",
@@ -13069,7 +13081,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: any, // Item instance\n }",
+ "type": "{\n \t item: any, // Item instance\n }",
"description": "caption slot's params."
}
],
@@ -13094,7 +13106,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the indicator item\n }",
+ "type": "{\n \t index: number, // Index of the indicator item\n }",
"description": "indicator slot's params."
}
],
@@ -13107,7 +13119,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: any, // Item instance\n }",
+ "type": "{\n \t item: any, // Item instance\n }",
"description": "item slot's params."
}
],
@@ -13120,7 +13132,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: any, // Item instance\n }",
+ "type": "{\n \t item: any, // Item instance\n }",
"description": "thumbnail slot's params."
}
],
@@ -13590,7 +13602,7 @@
"values": {
"InputNumberBlurEvent": {
"description": "Custom blur event.",
- "relatedProp": "undefined.blur",
+ "relatedProp": "InputNumberEmits.blur",
"props": [
{
"name": "originalEvent",
@@ -13672,7 +13684,7 @@
},
"InputNumberInputEvent": {
"description": "Custom input event.",
- "relatedProp": "undefined.input",
+ "relatedProp": "InputNumberEmits.input",
"props": [
{
"name": "originalEvent",
@@ -14782,7 +14794,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
+ "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
"description": "content slot's params."
}
],
@@ -14807,7 +14819,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "footer slot's params."
}
],
@@ -14820,7 +14832,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "header slot's params."
}
],
@@ -14833,7 +14845,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
+ "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
"description": "loader slot's params."
}
],
@@ -14846,7 +14858,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -14859,7 +14871,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "optiongroup slot's params."
}
],
@@ -15001,7 +15013,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -15201,7 +15213,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -15306,7 +15318,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -16233,7 +16245,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t value: any, // A value in the selection\n }",
+ "type": "{\n \t value: any, // A value in the selection\n }",
"description": "chip slot's params."
}
],
@@ -16246,7 +16258,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
+ "type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n }",
"description": "content slot's params."
}
],
@@ -16271,7 +16283,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "footer slot's params."
}
],
@@ -16284,7 +16296,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }",
"description": "header slot's params."
}
],
@@ -16303,7 +16315,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
+ "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
"description": "loader slot's params."
}
],
@@ -16316,7 +16328,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -16329,7 +16341,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option group slot's params."
}
],
@@ -16342,7 +16354,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }",
+ "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }",
"description": "value slot's params."
}
],
@@ -16567,7 +16579,7 @@
},
"OrderListReorderEvent": {
"description": "Custom reorder event",
- "relatedProp": "undefined.reorder",
+ "relatedProp": "OrderListEmits.reorder",
"props": [
{
"name": "direction",
@@ -16598,7 +16610,7 @@
},
"OrderListSelectionChangeEvent": {
"description": "Custom selection change event",
- "relatedProp": "undefined.selection-change",
+ "relatedProp": "OrderListEmits['selection-change']",
"props": [
{
"name": "originalEvent",
@@ -16648,7 +16660,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the item.\n \t item: any, // Item of the component\n }",
+ "type": "{\n \t index: number, // Index of the item.\n \t item: any, // Item of the component\n }",
"description": "item slot's params."
}
],
@@ -17269,7 +17281,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t state: PageState, // Current state\n }",
+ "type": "{\n \t state: PageState, // Current state\n }",
"description": "end slot's params."
}
],
@@ -17282,7 +17294,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t state: PageState, // Current state\n }",
+ "type": "{\n \t state: PageState, // Current state\n }",
"description": "start slot's params."
}
],
@@ -17398,7 +17410,7 @@
},
"PanelToggleEvent": {
"description": "Custom toggle event.",
- "relatedProp": "undefined.toggle",
+ "relatedProp": "PanelEmits.toggle",
"props": [
{
"name": "originalEvent",
@@ -17596,7 +17608,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -18011,7 +18023,7 @@
},
"PickListMoveAllToSourceEvent": {
"description": "Custom move-all-to-source event.",
- "relatedProp": "undefined.move-to-target",
+ "relatedProp": "PickListEmits['move-all-to-target']",
"props": [
{
"name": "items",
@@ -18035,7 +18047,7 @@
},
"PickListMoveAllToTargetEvent": {
"description": "Custom move-all-to-target event.",
- "relatedProp": "undefined.move-to-target",
+ "relatedProp": "PickListEmits['move-all-to-target']",
"props": [
{
"name": "items",
@@ -18059,7 +18071,7 @@
},
"PickListMoveToSourceEvent": {
"description": "Custom move-to-source event.",
- "relatedProp": "undefined.move-to-target",
+ "relatedProp": "PickListEmits['move-all-to-target']",
"props": [
{
"name": "items",
@@ -18083,7 +18095,7 @@
},
"PickListMoveToTargetEvent": {
"description": "Custom move-to-target event.",
- "relatedProp": "undefined.move-to-target",
+ "relatedProp": "PickListEmits['move-to-target']",
"props": [
{
"name": "items",
@@ -18282,7 +18294,7 @@
},
"PickListReorderEvent": {
"description": "Custom reorder event.",
- "relatedProp": "undefined.reorder",
+ "relatedProp": "PickListEmits.reorder",
"props": [
{
"name": "direction",
@@ -18321,7 +18333,7 @@
},
"PickListSelectionChangeEvent": {
"description": "Custom selection change event.",
- "relatedProp": "undefined.selection-change",
+ "relatedProp": "PickListEmits['selection-change']",
"props": [
{
"name": "originalEvent",
@@ -18359,7 +18371,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the item\n \t item: any, // Item of the component\n }",
+ "type": "{\n \t index: number, // Index of the item\n \t item: any, // Item of the component\n }",
"description": "item slot's params."
}
],
@@ -18782,7 +18794,7 @@
"values": {
"RatingChangeEvent": {
"description": "Custom change event.",
- "relatedProp": "undefined.change",
+ "relatedProp": "RatingEmits.change",
"props": [
{
"name": "originalEvent",
@@ -18958,7 +18970,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t value: number, // Item value\n }",
+ "type": "{\n \t value: number, // Item value\n }",
"description": "off icon slot's params."
}
],
@@ -18971,7 +18983,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t value: number, // Item value\n }",
+ "type": "{\n \t value: number, // Item value\n }",
"description": "on icon slot's params."
}
],
@@ -19183,7 +19195,7 @@
"values": {
"SelectButtonChangeEvent": {
"description": "Custom change event.",
- "relatedProp": "undefined.change",
+ "relatedProp": "SelectButtonEmits.change",
"props": [
{
"name": "originalEvent",
@@ -19360,7 +19372,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
+ "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }",
"description": "option slot's params."
}
],
@@ -20044,7 +20056,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t toggle(): void, // Toggle metadata\n }",
+ "type": "{\n \t toggle(): void, // Toggle metadata\n }",
"description": "button slot's params."
}
],
@@ -20057,7 +20069,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -20409,7 +20421,7 @@
},
"SplitterResizeEndEvent": {
"description": "Custom resize end event.",
- "relatedProp": "undefined.resizeend",
+ "relatedProp": "undefined.PickListEmits.resizeend",
"props": [
{
"name": "originalEvent",
@@ -20432,7 +20444,7 @@
},
"SplitterResizeStartEvent": {
"description": "Custom resize start event.",
- "relatedProp": "undefined.resizestar",
+ "relatedProp": "SplitterEmits.resizestar",
"props": [
{
"name": "originalEvent",
@@ -20604,7 +20616,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -20840,7 +20852,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -20996,7 +21008,7 @@
"values": {
"TabViewChangeEvent": {
"description": "Custom tab change event.",
- "relatedProp": "undefined.tab-change",
+ "relatedProp": "TabViewEmits['tab-change']",
"props": [
{
"name": "index",
@@ -21020,7 +21032,7 @@
},
"TabViewClickEvent": {
"description": "Custom tab change event.",
- "relatedProp": "undefined.tab-click",
+ "relatedProp": "TabViewEmits['tab-click']",
"props": [
{
"name": "index",
@@ -21302,17 +21314,16 @@
},
"terminalservice": {
"description": "[Live Demo](https://www.primevue.org/terminal/)",
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "TerminalServiceOptions": {
- "description": "Confirmation Service methods.",
- "relatedProp": "",
- "props": [],
- "methods": [
+ "model": {
+ "TerminalServiceOptions": {
+ "description": "Confirmation Service methods.",
+ "props": {
+ "description": "",
+ "values": []
+ },
+ "methods": {
+ "description": "",
+ "values": [
{
"name": "emit",
"parameters": [
@@ -21612,7 +21623,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n }",
"description": "item slot's params."
}
],
@@ -21697,7 +21708,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }"
+ "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }"
}
],
"returnType": "VNode[]",
@@ -21709,7 +21720,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
+ "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
"description": "content slot's params."
}
],
@@ -21722,7 +21733,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
+ "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
"description": "marker slot's params."
}
],
@@ -21735,7 +21746,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
+ "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }",
"description": "opposite slot's params."
}
],
@@ -21765,6 +21776,7 @@
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ToastBreakpointsType": {
+ "description": "Defines breakpoints type in Toast component.",
"relatedProp": "",
"props": [
{
@@ -21777,11 +21789,40 @@
"methods": []
},
"ToastEmits": {
+ "description": "Defines valid emits in Toast component.",
"relatedProp": "",
"props": [],
- "methods": []
+ "methods": [
+ {
+ "name": "close",
+ "parameters": [
+ {
+ "name": "message",
+ "optional": false,
+ "type": "ToastMessageOptions",
+ "description": "Toast message."
+ }
+ ],
+ "returnType": "void",
+ "description": "Callback to invoke when the toast is closed."
+ },
+ {
+ "name": "life-end",
+ "parameters": [
+ {
+ "name": "message",
+ "optional": false,
+ "type": "ToastMessageOptions",
+ "description": "Toast message."
+ }
+ ],
+ "returnType": "void",
+ "description": "Callback to invoke when the toast's timeout is over."
+ }
+ ]
},
"ToastMessageOptions": {
+ "description": "Defines message options in Toast component.",
"relatedProp": "",
"props": [
{
@@ -21947,6 +21988,7 @@
"methods": []
},
"ToastSlots": {
+ "description": "Defines valid slot in Toast component.",
"relatedProp": "",
"props": [],
"methods": [
@@ -21956,7 +21998,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t message: any, // Message of the component\n }",
+ "type": "{\n \t message: any, // Message of the component\n }",
"description": "message slot's params."
}
],
@@ -21968,39 +22010,51 @@
}
}
},
- "toastservice/ToastService": {
- "interfaces": {
- "description": "Defines the custom interfaces used by the module.",
- "eventDescription": "Defines the custom events used by the component's emit.",
- "methodDescription": "Defines methods that can be accessed by the component's reference.",
- "typeDescription": "Defines the custom types used by the module.",
- "values": {
- "ToastServiceMethods": {
- "relatedProp": "",
- "props": [
+ "toastservice-usetoast": {
+ "description": "[Live Demo](https://www.primevue.org/toast/)",
+ "model": {
+ "ToastServiceMethods": {
+ "description": "Toast Service methods.",
+ "props": {
+ "description": "",
+ "values": []
+ },
+ "methods": {
+ "description": "",
+ "values": [
{
"name": "add",
- "optional": false,
- "readonly": false,
- "type": "Function",
- "default": ""
+ "parameters": [
+ {
+ "name": "message",
+ "optional": false,
+ "type": "ToastMessageOptions",
+ "description": "Message instance."
+ }
+ ],
+ "returnType": "void",
+ "description": "Displays the message in a suitable Toast component."
},
{
"name": "removeAllGroups",
- "optional": false,
- "readonly": false,
- "type": "Function",
- "default": ""
+ "parameters": [],
+ "returnType": "void",
+ "description": "Clears all the messages."
},
{
"name": "removeGroup",
- "optional": false,
- "readonly": false,
- "type": "Function",
- "default": ""
+ "parameters": [
+ {
+ "name": "group",
+ "optional": false,
+ "type": "string",
+ "description": "Name of the message group."
+ }
+ ],
+ "returnType": "void",
+ "description": "Clears the messages that belongs to the group."
}
- ],
- "methods": []
+ ]
}
}
}
@@ -23078,7 +23132,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }",
+ "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }",
"description": "footer slot's params."
}
],
@@ -23091,7 +23145,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }",
+ "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }",
"description": "header slot's params."
}
],
@@ -23110,7 +23164,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t placeholder: string, // Placeholder\n \t value: any, // Selected value\n }",
+ "type": "{\n \t placeholder: string, // Placeholder\n \t value: any, // Selected value\n }",
"description": "value slot's params."
}
],
@@ -23355,7 +23409,7 @@
},
"TreeTableFilterEvent": {
"description": "Custom filter event.",
- "relatedProp": "undefined.sort",
+ "relatedProp": "TreeTableEmits.sort",
"props": [
{
"name": "filterMatchModes",
@@ -23494,7 +23548,7 @@
},
"TreeTablePageEvent": {
"description": "Custom page event.",
- "relatedProp": "undefined.sort",
+ "relatedProp": "TreeTableEmits.sort",
"props": [
{
"name": "filterMatchModes",
@@ -23943,7 +23997,7 @@
},
"TreeTableSortEvent": {
"description": "Custom sort event.",
- "relatedProp": "undefined.sort",
+ "relatedProp": "TreeTableEmits.sort",
"props": [
{
"name": "filterMatchModes",
@@ -24433,7 +24487,7 @@
},
"VirtualScrollerLazyEvent": {
"description": "Custom lazy event.",
- "relatedProp": "undefined.scroll-index-change",
+ "relatedProp": "VirtualScrollerEmits['scroll-index-change']",
"props": [
{
"name": "first",
@@ -24742,7 +24796,7 @@
},
"VirtualScrollerScrollIndexChangeEvent": {
"description": "Custom scroll index change event.",
- "relatedProp": "undefined.scroll-index-change",
+ "relatedProp": "VirtualScrollerEmits['scroll-index-change']",
"props": [
{
"name": "first",
@@ -24775,7 +24829,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t both: boolean, // Whether the orientation is both.\n \t columns: undefined, // The number of the rendered columns.\n \t contentStyle: any, // The style of content element.\n \t horizontal: boolean, // Whether the orientation is horizontal.\n \t itemSize: undefined, // The height/width of item according to orientation.\n \t items: any, // An array of objects to display for virtualscroller\n \t loading: boolean, // Whether the data is loaded.\n \t rows: undefined, // The number of the rendered rows.\n \t spacerStyle: any, // The style of spacer element.\n \t styleClass: string, // Style class of the content\n \t vertical: boolean, // Whether the orientation is vertical.\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n \t getLoaderOptions(index: number, ext: any): VirtualScrollerLoaderOptions, // Loader options of the items while the data is loading.\n }",
+ "type": "{\n \t both: boolean, // Whether the orientation is both.\n \t columns: undefined, // The number of the rendered columns.\n \t contentStyle: any, // The style of content element.\n \t horizontal: boolean, // Whether the orientation is horizontal.\n \t itemSize: undefined, // The height/width of item according to orientation.\n \t items: any, // An array of objects to display for virtualscroller\n \t loading: boolean, // Whether the data is loaded.\n \t rows: undefined, // The number of the rendered rows.\n \t spacerStyle: any, // The style of spacer element.\n \t styleClass: string, // Style class of the content\n \t vertical: boolean, // Whether the orientation is vertical.\n \t contentRef(el: any): void, // Referance of the content\n \t getItemOptions(index: number): VirtualScrollerItemOptions, // Options of the items\n \t getLoaderOptions(index: number, ext: any): VirtualScrollerLoaderOptions, // Loader options of the items while the data is loading.\n }",
"description": "content slot's params."
}
],
@@ -24788,7 +24842,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: any, // Item data.\n \t options: VirtualScrollerItemOptions, // Item options.\n }",
+ "type": "{\n \t item: any, // Item data.\n \t options: VirtualScrollerItemOptions, // Item options.\n }",
"description": "item slot's params."
}
],
@@ -24801,7 +24855,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t options: VirtualScrollerLoaderOptions, // Loader options.\n }",
+ "type": "{\n \t options: VirtualScrollerLoaderOptions, // Loader options.\n }",
"description": "header slot's params."
}
],
@@ -24812,7 +24866,7 @@
},
"VirtualScrollerViewport": {
"description": "Custom virtualscroller viewport metadata.",
- "relatedProp": "undefined.scroll-index-change",
+ "relatedProp": "VirtualScrollerEmits['scroll-index-change']",
"props": [
{
"name": "first",
diff --git a/layouts/doc/DocApiSection.vue b/layouts/doc/DocApiSection.vue
index deb8cc8cb..f965350e9 100644
--- a/layouts/doc/DocApiSection.vue
+++ b/layouts/doc/DocApiSection.vue
@@ -48,18 +48,29 @@ export default {
docName: docName
};
- const values = APIDocs[moduleName].interfaces.values;
+ const values = APIDocs[moduleName]?.interfaces?.values;
const componentValues = APIDocs[moduleName]?.components;
+ const modelValues = APIDocs[moduleName]?.model;
+ let props = null;
+ let emits = null;
+ let slots = null;
+ let events = null;
+ let options = null;
+ let interfaces = null;
+
+ if (values) {
+ props = values[`${docName}Props`];
+ emits = values[`${docName}Emits`];
+ slots = values[`${docName}Slots`];
+ events = this.findEvents(values);
+ options = this.findOptions(values, docName); // MenuItem && ConfirmationOptions
+ interfaces = this.findOtherInterfaces(values, docName);
+ }
- const props = values[`${docName}Props`];
- const emits = values[`${docName}Emits`];
- const slots = values[`${docName}Slots`];
const methods = componentValues ? componentValues['default'].methods : null;
const types = APIDocs[moduleName]['types'];
- let events = this.findEvents(values);
- const interfaces = this.findOtherInterfaces(values, docName);
- const options = this.findOptions(values, docName); // Only for MenuItem
+ const services = modelValues; // (TerminalService && ConfirmationService && ToastService)
if (props && props.props.length) {
newDoc.children.push({
@@ -101,7 +112,7 @@ export default {
});
}
- if (events && events.length) {
+ if (events && events.length > 0) {
newDoc.children.push({
id: `api.${moduleName}.events`,
label: 'Events',
@@ -144,6 +155,17 @@ export default {
});
}
+ if (services) {
+ console.log(services);
+ newDoc.children.push({
+ id: `api.${moduleName}.services`,
+ label: 'Services',
+ component: DocApiTable,
+ data: this.setServicesData(moduleName, services),
+ description: Object.values(services)[0].description || null
+ });
+ }
+
newDocs.push(newDoc);
}
@@ -257,6 +279,27 @@ export default {
return data;
},
+ setServicesData(moduleName, services) {
+ const data = [];
+
+ for (const key of Object.keys(services)) {
+ const value = services[key];
+
+ value?.methods.values.forEach((method) => {
+ data.push({
+ name: method.name,
+ parameters: {
+ name: method.parameters[0]?.name,
+ type: method.parameters[0]?.type
+ },
+ returnType: method.returnType,
+ description: method.description
+ });
+ });
+ }
+
+ return data;
+ },
findEvents(values) {
const events = [];
diff --git a/layouts/doc/DocApiTable.vue b/layouts/doc/DocApiTable.vue
index 8e585c354..4fe5f960a 100644
--- a/layouts/doc/DocApiTable.vue
+++ b/layouts/doc/DocApiTable.vue
@@ -95,7 +95,7 @@ export default {
isLinkType(value) {
if (this.label === 'Slots') return false;
- return value.toLowerCase().includes(this.$route.hash.replace('#api.', '').split('.')[0].toLowerCase());
+ return value.toLowerCase().includes(this.id.split('.')[1]);
},
setLinkPath(value, type) {
const currentRoute = this.$router.currentRoute.value.name;
diff --git a/pages/confirmdialog/index.vue b/pages/confirmdialog/index.vue
index e62eec7d6..af257a33e 100644
--- a/pages/confirmdialog/index.vue
+++ b/pages/confirmdialog/index.vue
@@ -4,7 +4,7 @@
header="ConfirmDialog"
description="ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API."
:componentDocs="docs"
- :apiDocs="['ConfirmDialog', 'ConfirmationService', 'ConfirmationOptions']"
+ :apiDocs="['ConfirmDialog', 'ConfirmationService-UseConfirm', 'ConfirmationOptions']"
/>
diff --git a/pages/dialog/index.vue b/pages/dialog/index.vue
index 196157b19..5df3466b0 100755
--- a/pages/dialog/index.vue
+++ b/pages/dialog/index.vue
@@ -1,5 +1,5 @@
-
+