diff --git a/api-generator/build-apidoc.js b/api-generator/build-apidoc.js index 92d23682c..6264801b6 100644 --- a/api-generator/build-apidoc.js +++ b/api-generator/build-apidoc.js @@ -47,12 +47,6 @@ if (project) { project.children.forEach((module) => { const { name, comment } = module; - /* if (name === 'knob') { - console.log('module', module); - } */ // REMOVE - - /* if (name !== 'autocomplete') return; */ // REMOVE - const description = comment && comment.summary.map((s) => s.text || '').join(' '); doc[name] = { @@ -265,7 +259,19 @@ if (project) { module_interfaces_group && module_interfaces_group.children.forEach((event) => { const event_props_description = event.comment && event.comment.summary.map((s) => s.text || '').join(' '); - const component_prop = event.comment && event.comment.getTag('@see') ? event.comment.getTag('@see').content[0].text : ''; // TODO: Check + let component_prop = ''; + + if (event.comment && event.comment.getTag('@see')) { + const tag = event.comment.getTag('@see'); + const content = tag.content[0]; + + if (content.text.includes("['")) { + component_prop = `${content.target.name}${content.text}`; + } else { + component_prop = `${content.text === content.target?.name ? content.target.parent.name : content.target?.name}.${content.text}`; + } + } + const event_extendedBy = event.extendedBy && event.extendedBy.toString(); const event_extendedTypes = event.extendedTypes && event.extendedTypes.toString(); diff --git a/assets/styles/layout/_doc.scss b/assets/styles/layout/_doc.scss index 34a2c9b42..f9f1d9950 100644 --- a/assets/styles/layout/_doc.scss +++ b/assets/styles/layout/_doc.scss @@ -256,6 +256,7 @@ border-bottom: 1px solid var(--surface-border); white-space: pre-wrap; line-height: 1.5; + scroll-margin-top: 6.5rem; &.doc-option-type { font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, Liberation Mono, monospace; diff --git a/components/confirmationoptions/ConfirmationOptions.d.ts b/components/confirmationoptions/ConfirmationOptions.d.ts index 78d4195a4..e5030eb81 100644 --- a/components/confirmationoptions/ConfirmationOptions.d.ts +++ b/components/confirmationoptions/ConfirmationOptions.d.ts @@ -8,8 +8,6 @@ /** * Confirmation Service options. - * - * @group Interfaces */ export interface ConfirmationOptions { /** diff --git a/components/confirmationservice/ConfirmationService.d.ts b/components/confirmationservice/ConfirmationService.d.ts index a329e1600..ed7aa39f4 100644 --- a/components/confirmationservice/ConfirmationService.d.ts +++ b/components/confirmationservice/ConfirmationService.d.ts @@ -22,11 +22,11 @@ export interface ConfirmationServiceMethods { * Displays the dialog using the confirmation object options. * @param {ConfirmationOptions} options - Confirmation Object */ - require: (options: ConfirmationOptions) => void; + require(options: ConfirmationOptions): void; /** * Hides the dialog without invoking accept or reject callbacks. */ - close: () => void; + close(): void; } declare module 'vue/types/vue' { diff --git a/components/datatable/DataTable.d.ts b/components/datatable/DataTable.d.ts index 3a17b43a5..ae7f8f2e8 100755 --- a/components/datatable/DataTable.d.ts +++ b/components/datatable/DataTable.d.ts @@ -103,7 +103,7 @@ export interface DataTableExportCSVOptions { /** * Custom tab open event. - * @see sort + * @see {@link DataTableEmits.sort} */ export interface DataTableSortEvent { /** @@ -143,7 +143,7 @@ export interface DataTableSortEvent { /** * Custom pagination event. - * @see page + * @see {@link DataTableEmits.page} * @extends DataTableSortEvent */ export interface DataTablePageEvent extends DataTableSortEvent { @@ -159,7 +159,7 @@ export interface DataTablePageEvent extends DataTableSortEvent { /** * Custom sort event. - * @see sort + * @see {@link DataTableEmits.sort} * @extends DataTableSortEvent */ export interface DataTableFilterEvent extends DataTableSortEvent { @@ -171,6 +171,7 @@ export interface DataTableFilterEvent extends DataTableSortEvent { /** * Custom row click event. + * @see {@link DataTableEmits['row-click']} */ export interface DataTableRowClickEvent { /** @@ -189,21 +190,21 @@ export interface DataTableRowClickEvent { /** * Custom row double click event. - * @see row-click + * @see {@link DataTableEmits['row-dblclick']]} * @extends DataTableRowClickEvent */ export interface DataTableRowDoubleClickEvent extends DataTableRowClickEvent {} /** * Custom context menu event. - * @see row-click + * @see {@link DataTableEmits['row-contextmenu']} * @extends DataTableRowClickEvent */ export interface DataTableRowContextMenuEvent extends DataTableRowClickEvent {} /** * Custom row select event. - * + * @see {@link DataTableEmits['row-select']} */ export interface DataTableRowSelectEvent { /** @@ -226,14 +227,14 @@ export interface DataTableRowSelectEvent { /** * Custom row unselect event. - * @see row-select + * @see {@link DataTableEmits['row-unselect']} * @extends DataTableRowSelectEvent */ export interface DataTableRowUnselectEvent extends DataTableRowSelectEvent {} /** * Custom row select all event. - * + * @see {@link DataTableEmits['row-select-all']} */ export interface DataTableRowSelectAllEvent { /** @@ -248,7 +249,7 @@ export interface DataTableRowSelectAllEvent { /** * Custom row unselect all event. - * + * @see {@link DataTableEmits['row-unselect-all']} */ export interface DataTableRowUnselectAllEvent { /** @@ -259,7 +260,7 @@ export interface DataTableRowUnselectAllEvent { /** * Custom row select all change event. - * + * @see {@link DataTableEmits['select-all-change']} */ export interface DataTableSelectAllChangeEvent { /** @@ -274,7 +275,7 @@ export interface DataTableSelectAllChangeEvent { /** * Custom row resize end event. - * + * @see {@link DataTableEmits['column-resize-end']} */ export interface DataTableColumnResizeEndEvent { /** @@ -289,7 +290,7 @@ export interface DataTableColumnResizeEndEvent { /** * Custom row column reorder event. - * + * @see {@link DataTableEmits['column-reorder']} */ export interface DataTableColumnReorderEvent { /** @@ -308,7 +309,7 @@ export interface DataTableColumnReorderEvent { /** * Custom row reorder event. - * + * @see {@link DataTableEmits['row-reorder']} */ export interface DataTableRowReorderEvent { /** @@ -331,7 +332,7 @@ export interface DataTableRowReorderEvent { /** * Custom row expand event. - * + * @see {@link DataTableEmits['row-expand']} */ export interface DataTableRowExpandEvent { /** @@ -346,14 +347,14 @@ export interface DataTableRowExpandEvent { /** * Custom row collapse event. - * @see rowgroup-collapse + * @see {@link DataTableEmits['row-expand']} * @extends DataTableRowExpandEvent */ export interface DataTableRowCollapseEvent extends DataTableRowExpandEvent {} /** * Custom cell edit init event. - * + * @see {@link DataTableEmits['cell-edit-init']} */ export interface DataTableCellEditInitEvent { /** @@ -376,14 +377,14 @@ export interface DataTableCellEditInitEvent { /** * Custom cell edit cancel event. - * @see cell-edit-init + * @see {@link DataTableEmits['cell-edit-cancel']} * @extends DataTableCellEditInitEvent */ export interface DataTableCellEditCancelEvent extends DataTableCellEditInitEvent {} /** * Custom cell edit complete event. - * + * @see {@link DataTableEmits['cell-edit-complete']} */ export interface DataTableCellEditCompleteEvent { /** @@ -422,7 +423,7 @@ export interface DataTableCellEditCompleteEvent { /** * Custom row edit complete event. - * + * @see {@link DataTableEmits['row-edit-init']} */ export interface DataTableRowEditInitEvent { /** @@ -449,21 +450,21 @@ export interface DataTableRowEditInitEvent { /** * Custom row edit init event. - * @see row-edit-init + * @see {@link DataTableEmits['row-edit-complete']} * @extends DataTableRowEditInitEvent */ export interface DataTableRowEditSaveEvent extends DataTableRowEditInitEvent {} /** * Custom row edit cancel event. - * @see row-edit-init + * @see {@link DataTableEmits['row-edit-cancel']} * @extends DataTableRowEditCancelEvent */ export interface DataTableRowEditCancelEvent extends DataTableRowEditInitEvent {} /** * Custom state event. - * + * @see {@link DataTableEmits['state-save']} */ export interface DataTableStateEvent { /** diff --git a/components/terminalservice/TerminalService.d.ts b/components/terminalservice/TerminalService.d.ts index 996f426bb..3d72de70a 100755 --- a/components/terminalservice/TerminalService.d.ts +++ b/components/terminalservice/TerminalService.d.ts @@ -14,15 +14,15 @@ export interface TerminalServiceOptions { /** * Displays the terminal using the action options. */ - on: (action: 'command' | 'response' | undefined, fn: any) => void; + on(action: 'command' | 'response' | undefined, fn: any): void; /** * Emits the terminal using the action options. */ - emit: (action: 'command' | 'response' | undefined, params?: any) => void; + emit(action: 'command' | 'response' | undefined, params?: any): void; /** * Closes the terminal using the action options. */ - off: (action: 'command' | 'response' | undefined, fn: any) => void; + off(action: 'command' | 'response' | undefined, fn: any): void; } declare const TerminalService: TerminalServiceOptions; diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 7fa7e6714..398c44888 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -15,12 +15,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "AccordionClickEvent": { "description": "Custom tab open event.", - "relatedProp": "tab-open", + "relatedProp": "AccordionEmits.tab-open", "props": [ { "name": "index", @@ -179,7 +177,7 @@ }, "AccordionTabCloseEvent": { "description": "Custom tab close event.", - "relatedProp": "tab-close", + "relatedProp": "AccordionEmits.tab-close", "props": [ { "name": "index", @@ -203,7 +201,7 @@ }, "AccordionTabOpenEvent": { "description": "Custom tab open event.", - "relatedProp": "tab-open", + "relatedProp": "AccordionEmits.tab-open", "props": [ { "name": "index", @@ -244,8 +242,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "AccordionTabEmits": { "description": "Defines valid emits in AcordionTab component.", @@ -360,8 +356,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "FilterMatchModeOptions": { "relatedProp": "", @@ -2366,12 +2360,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "AutoCompleteChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "AutoCompleteEmits.change", "props": [ { "name": "originalEvent", @@ -2394,7 +2386,7 @@ }, "AutoCompleteCompleteEvent": { "description": "Custom complete event.", - "relatedProp": "complete", + "relatedProp": "AutoCompleteEmits.complete", "props": [ { "name": "originalEvent", @@ -2417,7 +2409,7 @@ }, "AutoCompleteDropdownClickEvent": { "description": "Custom dropdown click event.", - "relatedProp": "['dropdown-click']", + "relatedProp": "AutoCompleteEmits['dropdown-click']", "props": [ { "name": "originalEvent", @@ -2581,7 +2573,7 @@ }, "AutoCompleteItemSelectEvent": { "description": "Custom item select event.", - "relatedProp": "['item-select']", + "relatedProp": "AutoCompleteEmits['item-select']", "props": [ { "name": "originalEvent", @@ -2605,7 +2597,7 @@ }, "AutoCompleteItemUnselectEvent": { "description": "Custom item unselect event.", - "relatedProp": "['item-unselect']", + "relatedProp": "AutoCompleteEmits['item-unselect']", "props": [ { "name": "originalEvent", @@ -2981,7 +2973,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t value: any, // A value in the selection\n }", "description": "chip slot's params." } ], @@ -2994,7 +2986,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -3013,7 +3005,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "footer slot's params." } ], @@ -3026,7 +3018,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t suggestions: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "header slot's params." } ], @@ -3039,7 +3031,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t item: any, // Option instance\n }", "description": "item slot's params." } ], @@ -3052,7 +3044,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }", "description": "loader slot's params." } ], @@ -3065,7 +3057,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -3078,7 +3070,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -3106,8 +3098,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "AvatarEmits": { "description": "Defines valid emits in Avatar component.", @@ -3217,8 +3207,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "AvatarGroupEmits": { "description": "Defines valid emits in AvatarGroup component.", @@ -3257,8 +3245,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "BadgeEmits": { "description": "Defines valid emits in Badge component.", @@ -3314,14 +3300,12 @@ } }, "badgedirective": { - "description": "Badge directive is a small status indicator for another element.\n\n- [Live Demo](https://primevue.org/badge)", + "description": "Badge directive is a small status indicator for another element.\n\n[Live Demo](https://primevue.org/badge)", "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "BadgeDirectiveBinding": { "description": "Binding of Badge directive.", @@ -3405,8 +3389,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "BlockUIEmits": { "description": "Defines valid emits in BlockUI component", @@ -3498,8 +3480,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "BreadcrumbEmits": { "description": "Defines valid emits in Breadcrumb component.", @@ -3565,7 +3545,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -3593,8 +3573,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ButtonEmits": { "description": "Defines valid emits in Button component.", @@ -3694,6 +3672,14 @@ "default": "false", "description": "Add a border class without a background initially." }, + { + "name": "plain", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a plain textual class to the button without a background initially." + }, { "name": "raised", "optional": true, @@ -3714,7 +3700,7 @@ "name": "severity", "optional": true, "readonly": false, - "type": "\"success\" | \"info\" | \"warning\" | \"danger\" | \"secondary\"", + "type": "\"success\" | \"help\" | \"info\" | \"warning\" | \"danger\" | \"secondary\"", "default": "", "description": "Defines the style of the button." }, @@ -3778,12 +3764,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "CalendarBlurEvent": { "description": "Custom Calendar blur event.", - "relatedProp": "blur", + "relatedProp": "undefined.blur", "props": [ { "name": "originalEvent", @@ -3954,7 +3938,7 @@ }, "CalendarMonthChangeEvent": { "description": "Custom Calendar month change event.", - "relatedProp": "month-change", + "relatedProp": "undefined.month-change", "props": [ { "name": "month", @@ -4456,7 +4440,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "type": "{\n \t date: undefined, // Value of the component.\n }" } ], "returnType": "VNode[]", @@ -4468,7 +4452,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "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[]", @@ -4490,7 +4474,7 @@ }, "CalendarYearChangeEvent": { "description": "Custom Calendar year change event.", - "relatedProp": "year-change", + "relatedProp": "undefined.year-change", "props": [ { "name": "month", @@ -4530,15 +4514,21 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { + "CardEmits": { + "description": "Defines valid emits in Card component.", + "relatedProp": "", + "props": [], + "methods": [] + }, "CardProps": { + "description": "Defines valid properties in Card component.", "relatedProp": "", "props": [], "methods": [] }, "CardSlots": { + "description": "Defines valid slots in Card component.", "relatedProp": "", "props": [], "methods": [ @@ -4573,12 +4563,6 @@ "description": "Custom title template." } ] - }, - "CardEmits": { - "description": "", - "relatedProp": "", - "props": [], - "methods": [] } } } @@ -4599,8 +4583,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "CarouselEmits": { "description": "Defines valid emits in Carousel component.", @@ -4810,7 +4792,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t data: any, // Data of the component\n \t index: number, // Index of the item\n }", "description": "item slot's params." } ], @@ -4838,12 +4820,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "CascadeSelectChangeEvent": { "description": "Custom change event", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -4976,7 +4956,7 @@ }, "CascadeSelectGroupChangeEvent": { "description": "", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -5286,7 +5266,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -5299,7 +5279,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t placeholder: string, // Placeholder text to show\n \t value: any, // Value of the component\n }", "description": "value slot's params." } ], @@ -5352,8 +5332,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ChartEmits": { "description": "Defines valid emits in Chart component.", @@ -5453,7 +5431,7 @@ }, "ChartSelectEvent": { "description": "Custom select event.", - "relatedProp": "select", + "relatedProp": "undefined.select", "props": [ { "name": "dataset", @@ -5506,8 +5484,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "CheckboxEmits": { "description": "Defines valid emits in Checkbox component.", @@ -5727,8 +5703,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ChipEmits": { "description": "Defines valid properties in Chip component.", @@ -5829,12 +5803,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ChipsAddEvent": { "description": "Custom remove event.", - "relatedProp": "remove", + "relatedProp": "undefined.remove", "props": [ { "name": "originalEvent", @@ -6023,7 +5995,7 @@ }, "ChipsRemoveEvent": { "description": "Custom remove event.", - "relatedProp": "remove", + "relatedProp": "undefined.remove", "props": [ { "name": "originalEvent", @@ -6056,7 +6028,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t value: any, // Value of the component\n }", "description": "chip slot's params." } ], @@ -6084,12 +6056,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ColorPickerChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -6266,8 +6236,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ColumnEmits": { "relatedProp": "", @@ -6312,7 +6280,7 @@ }, "ColumnLoadingOptions": { "description": "Custom column loading metadata.", - "relatedProp": "VirtualScrollerLoaderOptions", + "relatedProp": "undefined.VirtualScrollerLoaderOptions", "props": [ { "name": "cellEven", @@ -6792,7 +6760,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6805,7 +6773,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6818,7 +6786,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6831,7 +6799,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6844,7 +6812,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6857,7 +6825,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6870,7 +6838,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6883,7 +6851,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t column: Column, // Column node.\n }", "description": "footer slot's params." } ], @@ -6896,7 +6864,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t column: Column, // Column node.\n }", "description": "header slot's params." } ], @@ -6909,7 +6877,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -6937,8 +6905,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ColumnGroupEmits": { "description": "Defines valid emits in ColumnGroup component.", @@ -6982,25 +6948,18 @@ } } }, - "confirmationoptions/ConfirmationOptions": { + "confirmationoptions": { + "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ConfirmationOptions": { + "description": "Confirmation Service options.", "relatedProp": "", "props": [ - { - "name": "accept", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, { "name": "acceptClass", "optional": true, @@ -7073,27 +7032,13 @@ "default": "", "description": "Message of the confirmation." }, - { - "name": "onHide", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" - }, { "name": "position", "optional": true, "readonly": false, - "type": "ConfirmationPositionType", - "default": "", - "description": "Position of the dialog, options are 'center', 'top', 'bottom', 'left', 'right', 'topleft', 'topright', 'bottomleft' or 'bottomright'." - }, - { - "name": "reject", - "optional": true, - "readonly": false, - "type": "Function", - "default": "" + "type": "\"center\" | \"left\" | \"top\" | \"bottom\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\"", + "default": "'center'", + "description": "Position of the dialog." }, { "name": "rejectClass", @@ -7128,29 +7073,40 @@ "description": "Element to align the overlay." } ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "ConfirmationPositionType": { - "values": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\" | \"topleft\" | \"topright\" | \"bottomleft\" | \"bottomright\" | undefined" + "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": [], + "returnType": "void", + "description": "Callback to execute when action is rejected." + } + ] } } } }, - "confirmationservice/ConfirmationService": { + "confirmationservice": { + "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ConfirmationServiceMethods": { + "description": "Confirmation Service methods.", "relatedProp": "", "props": [], "methods": [ @@ -7194,8 +7150,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ConfirmDialogBreakpoints": { "description": "Breakpoint metadata.", @@ -7250,7 +7204,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t message: ConfirmationOptions, // undefined\n }", "description": "message slot's params." } ], @@ -7278,8 +7232,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ConfirmPopupEmits": { "description": "Defines valid emits in ConfirmPopup component.", @@ -7313,7 +7265,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t message: ConfirmationOptions, // undefined\n }", "description": "message slot's params." } ], @@ -7372,8 +7324,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ContextMenuEmits": { "description": "Defines valid emits in ContextMenu component.", @@ -7522,7 +7472,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -7563,476 +7513,15 @@ } } }, - "events": { - "description": "Defines the custom events used by the component's emit.", - "values": { - "DataTableCellEditCompleteEvent": { - "description": "Custom cell edit complete event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "description": "New row data after editing." - }, - { - "name": "newValue", - "optional": false, - "readonly": false, - "type": "any", - "description": "Field value of new row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - }, - { - "name": "type", - "optional": false, - "readonly": false, - "type": "string", - "description": "Type of completion such as 'enter', 'outside' or 'tab'." - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any", - "description": "Field value of row data to edit." - } - ] - }, - "DataTableCellEditInitEvent": { - "description": "Custom cell edit init event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the row data to edit." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ], - "extendedBy": "DataTableCellEditCancelEvent" - }, - "DataTableColumnReorderEvent": { - "description": "Custom row column reorder event.", - "relatedProp": "", - "props": [ - { - "name": "dragIndex", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the dragged column" - }, - { - "name": "dropIndex", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the dropped column" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ] - }, - "DataTableColumnResizeEndEvent": { - "description": "Custom row resize end event.", - "relatedProp": "", - "props": [ - { - "name": "delta", - "optional": false, - "readonly": false, - "type": "any", - "description": "Change in column width" - }, - { - "name": "element", - "optional": false, - "readonly": false, - "type": "HTMLElement", - "description": "DOM element of the resized column." - } - ] - }, - "DataTableRowClickEvent": { - "description": "Custom row click event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Selected row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "description": "Row index." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event." - } - ], - "extendedBy": "DataTableRowDoubleClickEvent,DataTableRowContextMenuEvent" - }, - "DataTableRowEditInitEvent": { - "description": "Custom row edit complete event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Row data to edit." - }, - { - "name": "field", - "optional": false, - "readonly": false, - "type": "string", - "description": "Field name of the row data." - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the row data to edit." - }, - { - "name": "newData", - "optional": false, - "readonly": false, - "type": "any", - "description": "New row data after editing." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ], - "extendedBy": "DataTableRowEditSaveEvent,DataTableRowEditCancelEvent" - }, - "DataTableRowExpandEvent": { - "description": "Custom row expand event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any[]", - "description": "Expanded row data" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ], - "extendedBy": "DataTableRowCollapseEvent" - }, - "DataTableRowReorderEvent": { - "description": "Custom row reorder event.", - "relatedProp": "", - "props": [ - { - "name": "dragIndex", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the dragged row" - }, - { - "name": "dropIndex", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of the dropped row" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - }, - { - "name": "value", - "optional": false, - "readonly": false, - "type": "any[]", - "description": "Reordered value" - } - ] - }, - "DataTableRowSelectAllEvent": { - "description": "Custom row select all event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Selected dataset" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ] - }, - "DataTableRowSelectEvent": { - "description": "Custom row select event.", - "relatedProp": "", - "props": [ - { - "name": "data", - "optional": false, - "readonly": false, - "type": "any", - "description": "Selected row data" - }, - { - "name": "index", - "optional": false, - "readonly": false, - "type": "number", - "description": "Row index" - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - }, - { - "name": "type", - "optional": false, - "readonly": false, - "type": "string", - "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." - } - ], - "extendedBy": "DataTableRowUnselectEvent" - }, - "DataTableRowUnselectAllEvent": { - "description": "Custom row unselect all event.", - "relatedProp": "", - "props": [ - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ] - }, - "DataTableSelectAllChangeEvent": { - "description": "Custom row select all change event.", - "relatedProp": "", - "props": [ - { - "name": "checked", - "optional": false, - "readonly": false, - "type": "boolean", - "description": "Whether all data is selected." - }, - { - "name": "originalEvent", - "optional": false, - "readonly": false, - "type": "Event", - "description": "Browser event" - } - ] - }, - "DataTableStateEvent": { - "description": "Custom state event.", - "relatedProp": "", - "props": [ - { - "name": "columWidths", - "optional": false, - "readonly": false, - "type": "string[]", - "description": "Comma separated list of column widths" - }, - { - "name": "columnOrder", - "optional": false, - "readonly": false, - "type": "string[]", - "description": "Order of the columns" - }, - { - "name": "expandedRowGroups", - "optional": false, - "readonly": false, - "type": "any[] | DataTableExpandedRows", - "description": "Instances of rows in expanded state" - }, - { - "name": "expandedRowKeys", - "optional": false, - "readonly": false, - "type": "any[]", - "description": "Keys of rows in expanded state" - }, - { - "name": "expandedRows", - "optional": false, - "readonly": false, - "type": "any[] | DataTableExpandedRows", - "description": "Instances of rows in expanded state" - }, - { - "name": "filters", - "optional": false, - "readonly": false, - "type": "DataTableFilterMeta", - "description": "Collection of active filters" - }, - { - "name": "first", - "optional": false, - "readonly": false, - "type": "number", - "description": "Index of first record" - }, - { - "name": "multiSortMeta", - "optional": false, - "readonly": false, - "type": "undefined | DataTableSortMeta[]", - "description": "MultiSort metadata" - }, - { - "name": "rows", - "optional": false, - "readonly": false, - "type": "number", - "description": "Number of rows to display in new page" - }, - { - "name": "selection", - "optional": false, - "readonly": false, - "type": "any", - "description": "Selected rows" - }, - { - "name": "selectionKeys", - "optional": false, - "readonly": false, - "type": "any[]", - "description": "Keys of selected rows" - }, - { - "name": "sortField", - "optional": false, - "readonly": false, - "type": "string", - "description": "Field to sort against" - }, - { - "name": "sortOrder", - "optional": false, - "readonly": false, - "type": "undefined | null | 0 | 1 | -1", - "description": "Sort order as integer" - } - ] - } - } - }, "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DataTableCellEditCancelEvent": { "description": "Custom cell edit cancel event.", - "relatedProp": "cell-edit-init", + "relatedProp": "DataTableEmits['cell-edit-cancel']", "props": [ { "name": "data", @@ -8070,6 +7559,171 @@ "methods": [], "extendedTypes": "DataTableCellEditInitEvent" }, + "DataTableCellEditCompleteEvent": { + "description": "Custom cell edit complete event.", + "relatedProp": "DataTableEmits['cell-edit-complete']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "newValue", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Field value of new row data after editing." + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "type", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of completion such as 'enter', 'outside' or 'tab'." + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Field value of row data to edit." + } + ], + "methods": [] + }, + "DataTableCellEditInitEvent": { + "description": "Custom cell edit init event.", + "relatedProp": "DataTableEmits['cell-edit-init']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [], + "extendedBy": "DataTableCellEditCancelEvent" + }, + "DataTableColumnReorderEvent": { + "description": "Custom row column reorder event.", + "relatedProp": "DataTableEmits['column-reorder']", + "props": [ + { + "name": "dragIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dragged column" + }, + { + "name": "dropIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dropped column" + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [] + }, + "DataTableColumnResizeEndEvent": { + "description": "Custom row resize end event.", + "relatedProp": "DataTableEmits['column-resize-end']", + "props": [ + { + "name": "delta", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Change in column width" + }, + { + "name": "element", + "optional": false, + "readonly": false, + "type": "HTMLElement", + "default": "", + "description": "DOM element of the resized column." + } + ], + "methods": [] + }, "DataTableEditingRows": { "description": "Custom datatable editing rows.", "relatedProp": "", @@ -8636,7 +8290,7 @@ }, "DataTableFilterEvent": { "description": "Custom sort event.", - "relatedProp": "sort", + "relatedProp": "DataTableEmits.sort", "props": [ { "name": "filterMatchModes", @@ -8775,7 +8429,7 @@ }, "DataTablePageEvent": { "description": "Custom pagination event.", - "relatedProp": "page", + "relatedProp": "DataTableEmits.page", "props": [ { "name": "filterMatchModes", @@ -8878,7 +8532,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'960px'", + "default": "960px", "description": "The breakpoint to define the maximum width boundary when using stack responsive layout." }, { @@ -8886,7 +8540,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'pi-chevron-right'", + "default": "pi-chevron-right", "description": "Icon of the row toggler to display the row as collapsed." }, { @@ -8894,7 +8548,7 @@ "optional": true, "readonly": false, "type": "\"fit\" | \"expand\"", - "default": "'fit'", + "default": "fit", "description": "Defines whether the overall table width." }, { @@ -8902,7 +8556,7 @@ "optional": true, "readonly": false, "type": "\"equals\" | \"deepEquals\"", - "default": "'deepEquals'", + "default": "deepEquals", "description": "Algorithm to define if a row is selected." }, { @@ -8926,7 +8580,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "','", + "default": ",", "description": "Character to use as the csv separator." }, { @@ -8934,7 +8588,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'({currentPage} of {totalPages})'", + "default": "({currentPage} of {totalPages})", "description": "Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;\n\n- {currentPage}\n- {totalPages}\n- {rows}\n- {first}\n- {last}\n- {totalRecords}" }, { @@ -8990,7 +8644,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'pi-chevron-down'", + "default": "pi-chevron-down", "description": "Icon of the row toggler to display the row as expanded." }, { @@ -9006,7 +8660,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'download'", + "default": "download", "description": "Name of the exported file." }, { @@ -9094,7 +8748,7 @@ "optional": true, "readonly": false, "type": "string", - "default": "'pi pi-spinner'", + "default": "pi pi-spinner", "description": "The icon to show while indicating data load is in progress." }, { @@ -9142,7 +8796,7 @@ "optional": true, "readonly": false, "type": "any", - "default": "'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'", + "default": "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown", "description": "Template of the paginator. It can be customized using the template property using the predefined keys.\n\n- FirstPageLink\n- PrevPageLink\n- PageLinks\n- NextPageLink\n- LastPageLink\n- RowsPerPageDropdown\n- JumpToPageDropdown\n- JumpToPageInput\n- CurrentPageReport" }, { @@ -9277,7 +8931,7 @@ "optional": true, "readonly": false, "type": "\"multiple\" | \"single\"", - "default": "'single'", + "default": "single", "description": "Defines whether sorting works on single column or on multiple columns." }, { @@ -9301,7 +8955,7 @@ "optional": true, "readonly": false, "type": "\"local\" | \"session\"", - "default": "'session'", + "default": "session", "description": "Defines where a stateful table keeps its state." }, { @@ -9376,9 +9030,41 @@ } ] }, + "DataTableRowClickEvent": { + "description": "Custom row click event.", + "relatedProp": "DataTableEmits['row-click']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index." + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event." + } + ], + "methods": [], + "extendedBy": "DataTableRowDoubleClickEvent,DataTableRowContextMenuEvent" + }, "DataTableRowCollapseEvent": { "description": "Custom row collapse event.", - "relatedProp": "rowgroup-collapse", + "relatedProp": "DataTableEmits['row-expand']", "props": [ { "name": "data", @@ -9402,7 +9088,7 @@ }, "DataTableRowContextMenuEvent": { "description": "Custom context menu event.", - "relatedProp": "row-click", + "relatedProp": "DataTableEmits['row-contextmenu']", "props": [ { "name": "data", @@ -9434,7 +9120,7 @@ }, "DataTableRowDoubleClickEvent": { "description": "Custom row double click event.", - "relatedProp": "row-click", + "relatedProp": "DataTableEmits['row-dblclick']]", "props": [ { "name": "data", @@ -9466,7 +9152,7 @@ }, "DataTableRowEditCancelEvent": { "description": "Custom row edit cancel event.", - "relatedProp": "row-edit-init", + "relatedProp": "DataTableEmits['row-edit-cancel']", "props": [ { "name": "data", @@ -9512,9 +9198,57 @@ "methods": [], "extendedTypes": "DataTableRowEditInitEvent" }, + "DataTableRowEditInitEvent": { + "description": "Custom row edit complete event.", + "relatedProp": "DataTableEmits['row-edit-init']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Row data to edit." + }, + { + "name": "field", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field name of the row data." + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the row data to edit." + }, + { + "name": "newData", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "New row data after editing." + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [], + "extendedBy": "DataTableRowEditSaveEvent,DataTableRowEditCancelEvent" + }, "DataTableRowEditSaveEvent": { "description": "Custom row edit init event.", - "relatedProp": "row-edit-init", + "relatedProp": "DataTableEmits['row-edit-complete']", "props": [ { "name": "data", @@ -9560,9 +9294,150 @@ "methods": [], "extendedTypes": "DataTableRowEditInitEvent" }, + "DataTableRowExpandEvent": { + "description": "Custom row expand event.", + "relatedProp": "DataTableEmits['row-expand']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Expanded row data" + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [], + "extendedBy": "DataTableRowCollapseEvent" + }, + "DataTableRowReorderEvent": { + "description": "Custom row reorder event.", + "relatedProp": "DataTableEmits['row-reorder']", + "props": [ + { + "name": "dragIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dragged row" + }, + { + "name": "dropIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the dropped row" + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Reordered value" + } + ], + "methods": [] + }, + "DataTableRowSelectAllEvent": { + "description": "Custom row select all event.", + "relatedProp": "DataTableEmits['row-select-all']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected dataset" + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [] + }, + "DataTableRowSelectEvent": { + "description": "Custom row select event.", + "relatedProp": "DataTableEmits['row-select']", + "props": [ + { + "name": "data", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected row data" + }, + { + "name": "index", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Row index" + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + }, + { + "name": "type", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Type of the selection, valid values are 'row', 'radio' or 'checkbox'." + } + ], + "methods": [], + "extendedBy": "DataTableRowUnselectEvent" + }, + "DataTableRowUnselectAllEvent": { + "description": "Custom row unselect all event.", + "relatedProp": "DataTableEmits['row-unselect-all']", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [] + }, "DataTableRowUnselectEvent": { "description": "Custom row unselect event.", - "relatedProp": "row-select", + "relatedProp": "DataTableEmits['row-unselect']", "props": [ { "name": "data", @@ -9600,6 +9475,29 @@ "methods": [], "extendedTypes": "DataTableRowSelectEvent" }, + "DataTableSelectAllChangeEvent": { + "description": "Custom row select all change event.", + "relatedProp": "DataTableEmits['select-all-change']", + "props": [ + { + "name": "checked", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether all data is selected." + }, + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "Browser event" + } + ], + "methods": [] + }, "DataTableSlots": { "description": "Defines valid slots in DataTable component.", "relatedProp": "", @@ -9617,7 +9515,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", "description": "expansion slot's params." } ], @@ -9636,7 +9534,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }", "description": "group footer slot's params." } ], @@ -9649,7 +9547,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "type": "{\n \t data: any, // Row data\n \t index: number, // Row index\n }" } ], "returnType": "VNode[]", @@ -9683,7 +9581,7 @@ }, "DataTableSortEvent": { "description": "Custom tab open event.", - "relatedProp": "sort", + "relatedProp": "DataTableEmits.sort", "props": [ { "name": "filterMatchModes", @@ -9775,6 +9673,117 @@ } ], "methods": [] + }, + "DataTableStateEvent": { + "description": "Custom state event.", + "relatedProp": "DataTableEmits['state-save']", + "props": [ + { + "name": "columWidths", + "optional": false, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Comma separated list of column widths" + }, + { + "name": "columnOrder", + "optional": false, + "readonly": false, + "type": "string[]", + "default": "", + "description": "Order of the columns" + }, + { + "name": "expandedRowGroups", + "optional": false, + "readonly": false, + "type": "any[] | DataTableExpandedRows", + "default": "", + "description": "Instances of rows in expanded state" + }, + { + "name": "expandedRowKeys", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Keys of rows in expanded state" + }, + { + "name": "expandedRows", + "optional": false, + "readonly": false, + "type": "any[] | DataTableExpandedRows", + "default": "", + "description": "Instances of rows in expanded state" + }, + { + "name": "filters", + "optional": false, + "readonly": false, + "type": "DataTableFilterMeta", + "default": "", + "description": "Collection of active filters" + }, + { + "name": "first", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of first record" + }, + { + "name": "multiSortMeta", + "optional": false, + "readonly": false, + "type": "undefined | DataTableSortMeta[]", + "default": "", + "description": "MultiSort metadata" + }, + { + "name": "rows", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Number of rows to display in new page" + }, + { + "name": "selection", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Selected rows" + }, + { + "name": "selectionKeys", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Keys of selected rows" + }, + { + "name": "sortField", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Field to sort against" + }, + { + "name": "sortOrder", + "optional": false, + "readonly": false, + "type": "undefined | null | 0 | 1 | -1", + "default": "", + "description": "Sort order as integer" + } + ], + "methods": [] } } } @@ -9795,8 +9804,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DataViewEmits": { "description": "Defines valid slots in DataView component.", @@ -9846,7 +9853,7 @@ }, "DataViewPageEvent": { "description": "Custom change event.", - "relatedProp": "page", + "relatedProp": "undefined.page", "props": [ { "name": "first", @@ -10041,7 +10048,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", "description": "list slot's params." } ], @@ -10060,7 +10067,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t data: any, // Value of the component\n \t index: number, // Index of the grid\n }", "description": "list slot's params." } ], @@ -10084,16 +10091,45 @@ } } }, - "dataviewlayoutoptions/DataViewLayoutOptions": { + "dataviewlayoutoptions": { + "description": "The helper DataViewLayoutOptions component can be used to switch between the modes however this component is optional and you may use your own UI to switch modes as well.\n\n[Live Demo](https://www.primevue.org/dataview/)", + "components": { + "default": { + "description": "The helper DataViewLayoutOptions component can be used to switch between the modes however this component is optional and you may use your own UI to switch modes as well.", + "methods": { + "description": "Defines methods that can be accessed by the component's reference.", + "values": [] + } + } + }, "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { + "DataViewLayoutOptionsEmits": { + "description": "Defines valid emits in DataViewLayoutOptions component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + } + ] + }, "DataViewLayoutOptionsProps": { + "description": "Defines valid properties in DataViewLayoutOptions component.", "relatedProp": "", "props": [ { @@ -10108,19 +10144,12 @@ "methods": [] }, "DataViewLayoutOptionsSlots": { + "description": "Defines valid propslotserties in DataViewLayoutOptions component.", "relatedProp": "", "props": [], "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DataViewLayoutOptionsEmits": { - "values": "{\n \"update:modelValue\": \"Function, \"\n}" - } - } } }, "deferredcontent": { @@ -10139,8 +10168,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DeferredContentEmits": { "description": "Defines valid emits in DeferredContent component.", @@ -10192,8 +10219,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DialogBreakpoints": { "description": "Custom breakpoint metadata.", @@ -10528,16 +10553,16 @@ } } }, - "dialogservice/DialogService": { + "dialogservice": { + "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DialogServiceMethods": { + "description": "Dynamic Dialog components methods.", "relatedProp": "", "props": [ { @@ -10569,8 +10594,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DividerEmits": { "relatedProp": "", @@ -10640,8 +10663,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DockEmits": { "description": "Defines valid emits in Dock component.", @@ -10774,7 +10795,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Custom content for icon.\n }", "description": "icon slot's params." } ], @@ -10787,7 +10808,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the menuitem\n \t item: MenuItem, // Custom content for item.\n }", "description": "item slot's params." } ], @@ -10844,12 +10865,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DropdownChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -10967,8 +10986,8 @@ ] }, "DropdownFilterEvent": { - "description": "Custom filetr event.", - "relatedProp": "filter", + "description": "Custom filter event.", + "relatedProp": "undefined.filter", "props": [ { "name": "originalEvent", @@ -11375,7 +11394,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -11400,7 +11419,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "footer slot's params." } ], @@ -11413,7 +11432,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "header slot's params." } ], @@ -11432,7 +11451,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }", "description": "loader slot's params." } ], @@ -11445,7 +11464,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -11458,7 +11477,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option group slot's params." } ], @@ -11471,7 +11490,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }", "description": "value slot's params." } ], @@ -11484,7 +11503,7 @@ } }, "dynamicdialog": { - "description": "DynamicDialogs can be created dynamically with any component as the content using a DialogService.\n\n- [Live Demo](https://primevue.org/dynamicdialog)", + "description": "DynamicDialogs can be created dynamically with any component as the content using a DialogService.\n\n[Live Demo](https://primevue.org/dynamicdialog)", "components": { "default": { "description": "DynamicDialogs can be created dynamically with any component as the content using a DialogService.", @@ -11499,8 +11518,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DynamicDialogEmits": { "description": "Defines valid emits in DynamicDialog component.", @@ -11523,16 +11540,16 @@ } } }, - "dynamicdialogoptions/DynamicDialogOptions": { + "dynamicdialogoptions": { + "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "DynamicDialogCloseOptions": { + "description": "Dynamic Dialog close method options.", "relatedProp": "", "props": [ { @@ -11547,7 +11564,7 @@ "name": "type", "optional": false, "readonly": false, - "type": "DynamicDialogCloseType", + "type": "undefined | \"config-close\" | \"dialog-close\"", "default": "", "description": "Close type" } @@ -11555,6 +11572,7 @@ "methods": [] }, "DynamicDialogInstance": { + "description": "Custom Dynamic Dialog options.", "relatedProp": "", "props": [ { @@ -11592,6 +11610,7 @@ "methods": [] }, "DynamicDialogOptions": { + "description": "Custom Dynamic Dialog options.", "relatedProp": "", "props": [ { @@ -11641,6 +11660,7 @@ ] }, "DynamicDialogTemplates": { + "description": "Custom dialog templates.", "relatedProp": "", "props": [ { @@ -11663,14 +11683,6 @@ "methods": [] } } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { - "DynamicDialogCloseType": { - "values": "\"config-close\" | \"dialog-close\" | undefined" - } - } } }, "editor": { @@ -11689,8 +11701,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "EditorEmits": { "description": "Defines valid emits in Editor component.", @@ -11753,7 +11763,7 @@ }, "EditorLoadEvent": { "description": "Custom load event.", - "relatedProp": "load", + "relatedProp": "undefined.load", "props": [ { "name": "instance", @@ -11823,7 +11833,7 @@ }, "EditorSelectionChangeEvent": { "description": "Custom selection change event.", - "relatedProp": "selection-change", + "relatedProp": "undefined.selection-change", "props": [ { "name": "htmlValue", @@ -11892,7 +11902,7 @@ }, "EditorTextChangeEvent": { "description": "Custom text change event.", - "relatedProp": "text-change", + "relatedProp": "undefined.text-change", "props": [ { "name": "delta", @@ -11956,8 +11966,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "FieldsetEmits": { "description": "Defines valid emits in Fildset component.", @@ -12016,9 +12024,9 @@ "name": "toggleButtonProps", "optional": true, "readonly": false, - "type": "object", + "type": "AnchorHTMLAttributes", "default": "", - "description": "Uses to pass the custom value to read for the anchor inside the component." + "description": "Uses to pass the custom value to read for the AnchorHTMLAttributes inside the component." }, { "name": "toggleable", @@ -12054,7 +12062,7 @@ }, "FieldsetToggleEvent": { "description": "Custom toggle event.", - "relatedProp": "toggle", + "relatedProp": "undefined.toggle", "props": [ { "name": "originalEvent", @@ -12094,12 +12102,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "FileUploadBeforeSendEvent": { "description": "Custom before send event.", - "relatedProp": "before-send", + "relatedProp": "undefined.before-send", "props": [ { "name": "formData", @@ -12122,7 +12128,7 @@ }, "FileUploadBeforeUploadEvent": { "description": "Custom before upload event.", - "relatedProp": "before-upload", + "relatedProp": "undefined.before-upload", "props": [ { "name": "formData", @@ -12274,7 +12280,7 @@ }, "FileUploadErrorEvent": { "description": "Custom error event.", - "relatedProp": "error", + "relatedProp": "undefined.error", "props": [ { "name": "files", @@ -12297,7 +12303,7 @@ }, "FileUploadProgressEvent": { "description": "Custom progress event.", - "relatedProp": "progress", + "relatedProp": "undefined.progress", "props": [ { "name": "originalEvent", @@ -12527,7 +12533,7 @@ }, "FileUploadRemoveEvent": { "description": "Custom remove event.", - "relatedProp": "remove", + "relatedProp": "undefined.remove", "props": [ { "name": "file", @@ -12550,7 +12556,7 @@ }, "FileUploadRemoveUploadedFile": { "description": "Custom remove upload file event.", - "relatedProp": "removeUploadFile", + "relatedProp": "undefined.removeUploadFile", "props": [ { "name": "file", @@ -12573,7 +12579,7 @@ }, "FileUploadSelectEvent": { "description": "Custom select event.", - "relatedProp": "select", + "relatedProp": "undefined.select", "props": [ { "name": "files", @@ -12605,7 +12611,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "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[]", @@ -12623,7 +12629,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "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[]", @@ -12633,7 +12639,7 @@ }, "FileUploadUploadEvent": { "description": "Custom upload event.", - "relatedProp": "upload", + "relatedProp": "undefined.upload", "props": [ { "name": "files", @@ -12656,7 +12662,7 @@ }, "FileUploadUploaderEvent": { "description": "Custom uploader event.", - "relatedProp": "uploader", + "relatedProp": "undefined.uploader", "props": [ { "name": "files", @@ -12673,14 +12679,12 @@ } }, "focustrap": { - "description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n- [Live Demo](https://primevue.org/focustrap)", + "description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n[Live Demo](https://primevue.org/focustrap)", "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "FocusTrapDirectiveBinding": { "description": "Binding of FocusTrap directive.", @@ -12722,8 +12726,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "FullCalendarProps": { "relatedProp": "", @@ -12777,8 +12779,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "GalleriaEmits": { "description": "Defines valid emits in Galleria component.", @@ -13069,7 +13069,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: any, // Item instance\n }", "description": "caption slot's params." } ], @@ -13094,7 +13094,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the indicator item\n }", "description": "indicator slot's params." } ], @@ -13107,7 +13107,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: any, // Item instance\n }", "description": "item slot's params." } ], @@ -13120,7 +13120,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: any, // Item instance\n }", "description": "thumbnail slot's params." } ], @@ -13167,8 +13167,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ImageEmits": { "relatedProp": "", @@ -13238,8 +13236,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InlineMessageEmits": { "relatedProp": "", @@ -13293,8 +13289,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InplaceEmits": { "description": "Defines valid emits in Inplace component.", @@ -13435,8 +13429,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InputMaskEmits": { "description": "Defines valid emits in InputMask component.", @@ -13595,12 +13587,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InputNumberBlurEvent": { "description": "Custom blur event.", - "relatedProp": "blur", + "relatedProp": "undefined.blur", "props": [ { "name": "originalEvent", @@ -13682,7 +13672,7 @@ }, "InputNumberInputEvent": { "description": "Custom input event.", - "relatedProp": "input", + "relatedProp": "undefined.input", "props": [ { "name": "originalEvent", @@ -14007,8 +13997,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InputSwitchEmits": { "description": "Defines valid emits in InputSwitch component.", @@ -14172,8 +14160,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "InputTextEmits": { "description": "Defines valid emits in InputText component.", @@ -14227,8 +14213,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "KnobEmits": { "description": "Defines valid emits in Knob component.", @@ -14421,12 +14405,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ListboxChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "ListboxEmits.change", "props": [ { "name": "originalEvent", @@ -14521,7 +14503,7 @@ }, "ListboxFilterEvent": { "description": "Custom filter event.", - "relatedProp": "filter", + "relatedProp": "ListboxEmits.filter", "props": [ { "name": "originalEvent", @@ -14800,7 +14782,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -14825,7 +14807,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "footer slot's params." } ], @@ -14838,7 +14820,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "header slot's params." } ], @@ -14851,7 +14833,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }", "description": "loader slot's params." } ], @@ -14864,7 +14846,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -14877,7 +14859,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "optiongroup slot's params." } ], @@ -14905,8 +14887,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MegaMenuEmits": { "description": "Defines valid emits in MegaMenu component.", @@ -15021,7 +15001,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -15091,8 +15071,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MenuEmits": { "description": "Defines valid emits in Menu component.", @@ -15223,7 +15201,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -15257,8 +15235,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MenubarEmits": { "description": "Defines valid emits in Menubar component.", @@ -15330,7 +15306,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -15355,8 +15331,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MenuItem": { "description": "Defines model of MenuItem API.", @@ -15483,7 +15457,7 @@ }, "MenuItemCommandEvent": { "description": "Custom command event.", - "relatedProp": "command", + "relatedProp": "MenuItem.command", "props": [ { "name": "item", @@ -15529,8 +15503,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MessageEmits": { "description": "Defines valid emits in Message component.", @@ -15672,12 +15644,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "MultiSelectAllChangeEvent": { "description": "Custom all change event.", - "relatedProp": "['selectall-change']", + "relatedProp": "MultiSelectEmits['selectall-change']", "props": [ { "name": "checked", @@ -15700,7 +15670,7 @@ }, "MultiSelectChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "MultiSelectEmits.change", "props": [ { "name": "originalEvent", @@ -15832,7 +15802,7 @@ }, "MultiSelectFilterEvent": { "description": "Custom filter event", - "relatedProp": "filter", + "relatedProp": "MultiSelectEmits.filter", "props": [ { "name": "originalEvent", @@ -16263,7 +16233,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t value: any, // A value in the selection\n }", "description": "chip slot's params." } ], @@ -16276,7 +16246,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -16301,7 +16271,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "footer slot's params." } ], @@ -16314,7 +16284,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Displayed options\n \t value: any, // Value of the component\n }", "description": "header slot's params." } ], @@ -16333,7 +16303,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }", "description": "loader slot's params." } ], @@ -16346,7 +16316,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -16359,7 +16329,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option group slot's params." } ], @@ -16372,7 +16342,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t placeholder: string, // Placeholder prop value\n \t value: any, // Value of the component\n }", "description": "value slot's params." } ], @@ -16385,7 +16355,7 @@ } }, "orderlist": { - "description": "OrderList is used to managed the order of a collection.\n\n- [Live Demo](https://primevue.org/orderlist)", + "description": "OrderList is used to managed the order of a collection.\n\n[Live Demo](https://primevue.org/orderlist)", "components": { "default": { "description": "OrderList is used to sort a collection.", @@ -16400,8 +16370,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "OrderListEmits": { "description": "Defines valid slots in OrderList component.", @@ -16599,7 +16567,7 @@ }, "OrderListReorderEvent": { "description": "Custom reorder event", - "relatedProp": "reorder", + "relatedProp": "undefined.reorder", "props": [ { "name": "direction", @@ -16630,7 +16598,7 @@ }, "OrderListSelectionChangeEvent": { "description": "Custom selection change event", - "relatedProp": "selection-change", + "relatedProp": "undefined.selection-change", "props": [ { "name": "originalEvent", @@ -16680,7 +16648,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the item.\n \t item: any, // Item of the component\n }", "description": "item slot's params." } ], @@ -16708,8 +16676,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "OrganizationChartCollapsedKeys": { "relatedProp": "", @@ -16959,7 +16925,7 @@ } }, "overlaypanel": { - "description": "OverlayPanel is a container component positioned as connected to its target.\n\n- [Live Demo](https://primevue.org/overlaypanel)", + "description": "OverlayPanel is a container component positioned as connected to its target.\n\n[Live Demo](https://primevue.org/overlaypanel)", "components": { "default": { "description": "OverlayPanel, also known as Popover, is a container component that can overlay other components on page.", @@ -17015,8 +16981,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "OverlayPanelBreakpoints": { "description": "OverlayPanel breakpoint metadata.", @@ -17137,8 +17101,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PageState": { "description": "Paginator page state metadata.", @@ -17307,7 +17269,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t state: PageState, // Current state\n }", "description": "end slot's params." } ], @@ -17320,7 +17282,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t state: PageState, // Current state\n }", "description": "start slot's params." } ], @@ -17348,8 +17310,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PanelEmits": { "description": "Defines valid emits in Panel component.", @@ -17438,7 +17398,7 @@ }, "PanelToggleEvent": { "description": "Custom toggle event.", - "relatedProp": "toggle", + "relatedProp": "undefined.toggle", "props": [ { "name": "originalEvent", @@ -17478,8 +17438,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PanelMenuEmits": { "description": "Defines valid emits in PanelMenu component.", @@ -17529,7 +17487,7 @@ }, "PanelMenuExpandedKeys": { "description": "Custom expanded keys metadata.", - "relatedProp": "expandedKeys", + "relatedProp": "PanelMenuProps.expandedKeys", "props": [ { "name": "[key: string]", @@ -17542,7 +17500,7 @@ }, "PanelMenuPanelCloseEvent": { "description": "Custom panel close event.", - "relatedProp": "['panel-close']", + "relatedProp": "PanelMenuEmits['panel-close']", "props": [ { "name": "item", @@ -17566,7 +17524,7 @@ }, "PanelMenuPanelOpenEvent": { "description": "Custom panel open event.", - "relatedProp": "['panel-open']", + "relatedProp": "PanelMenuEmits['panel-open']", "props": [ { "name": "item", @@ -17638,7 +17596,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -17666,8 +17624,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PasswordEmits": { "description": "Defines valid emits in Password component.", @@ -17926,7 +17882,7 @@ } }, "picklist": { - "description": "PickList is used to reorder items between different lists.\n\n- [Live Demo](https://primevue.org/picklist)", + "description": "PickList is used to reorder items between different lists.\n\n[Live Demo](https://primevue.org/picklist)", "components": { "default": { "description": "PickList is used to reorder items between different lists.", @@ -17941,8 +17897,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PickListEmits": { "description": "Defines valid emits in PickList component.", @@ -18057,7 +18011,7 @@ }, "PickListMoveAllToSourceEvent": { "description": "Custom move-all-to-source event.", - "relatedProp": "move-to-target", + "relatedProp": "undefined.move-to-target", "props": [ { "name": "items", @@ -18081,7 +18035,7 @@ }, "PickListMoveAllToTargetEvent": { "description": "Custom move-all-to-target event.", - "relatedProp": "move-to-target", + "relatedProp": "undefined.move-to-target", "props": [ { "name": "items", @@ -18105,7 +18059,7 @@ }, "PickListMoveToSourceEvent": { "description": "Custom move-to-source event.", - "relatedProp": "move-to-target", + "relatedProp": "undefined.move-to-target", "props": [ { "name": "items", @@ -18129,7 +18083,7 @@ }, "PickListMoveToTargetEvent": { "description": "Custom move-to-target event.", - "relatedProp": "move-to-target", + "relatedProp": "undefined.move-to-target", "props": [ { "name": "items", @@ -18328,7 +18282,7 @@ }, "PickListReorderEvent": { "description": "Custom reorder event.", - "relatedProp": "reorder", + "relatedProp": "undefined.reorder", "props": [ { "name": "direction", @@ -18367,7 +18321,7 @@ }, "PickListSelectionChangeEvent": { "description": "Custom selection change event.", - "relatedProp": "selection-change", + "relatedProp": "undefined.selection-change", "props": [ { "name": "originalEvent", @@ -18405,7 +18359,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the item\n \t item: any, // Item of the component\n }", "description": "item slot's params." } ], @@ -18471,8 +18425,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "PortalProps": { "relatedProp": "", @@ -18536,8 +18488,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ProgressBarEmits": { "description": "Defines valid emits in ProgressBar component.", @@ -18608,8 +18558,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ProgressSpinnerEmits": { "description": "Defines valid emits in ProgressSpinner component.", @@ -18673,8 +18621,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "RadioButtonEmits": { "description": "Defines valid emits in RadioButton component.", @@ -18833,12 +18779,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "RatingChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -19014,7 +18958,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t value: number, // Item value\n }", "description": "off icon slot's params." } ], @@ -19027,7 +18971,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t value: number, // Item value\n }", "description": "on icon slot's params." } ], @@ -19040,14 +18984,12 @@ } }, "ripple": { - "description": "Ripple directive adds ripple effect to the host element.\n\n- [Live Demo](https://primevue.org/ripple)", + "description": "Ripple directive adds ripple effect to the host element.\n\n[Live Demo](https://primevue.org/ripple)", "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "RippleDirectiveBinding": { "description": "Binding of Ripple directive.", @@ -19075,8 +19017,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "RowEmits": { "description": "Defines valid emits in Row component.", @@ -19115,8 +19055,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ScrollPanelEmits": { "relatedProp": "", @@ -19171,8 +19109,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ScrollTopEmits": { "description": "Defines valid emits in ScrollTop component.", @@ -19244,12 +19180,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SelectButtonChangeEvent": { "description": "Custom change event.", - "relatedProp": "change", + "relatedProp": "undefined.change", "props": [ { "name": "originalEvent", @@ -19426,7 +19360,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of the option\n \t option: any, // Option instance\n }", "description": "option slot's params." } ], @@ -19439,7 +19373,7 @@ } }, "sidebar": { - "description": "Sidebar is a panel component displayed as an overlay at the edges of the screen.\n\n- [Live Demo](https://primevue.org/sidebar)", + "description": "Sidebar is a panel component displayed as an overlay at the edges of the screen.\n\n[Live Demo](https://primevue.org/sidebar)", "components": { "default": { "description": "Sidebar is a panel component displayed as an overlay.", @@ -19454,8 +19388,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SidebarEmits": { "description": "Defines valid emits in Sidebar component.", @@ -19606,8 +19538,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SkeletonEmits": { "description": "Defines valid emits in Skeleton component.", @@ -19695,8 +19625,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SliderEmits": { "description": "Defines valid emits in Slider component.", @@ -19833,7 +19761,7 @@ }, "SliderSlideEndEvent": { "description": "Custom slide end event.", - "relatedProp": "slideend", + "relatedProp": "SliderEmits.slideend", "props": [ { "name": "originalEvent", @@ -19879,8 +19807,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SpeedDialEmits": { "description": "Defines valid emits in SpeedDial component.", @@ -20118,7 +20044,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t toggle(): void, // Toggle metadata\n }", "description": "button slot's params." } ], @@ -20131,7 +20057,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -20142,7 +20068,7 @@ }, "SpeedDialTooltipOptions": { "description": "Defines tooltip options.", - "relatedProp": "tooltipOptions", + "relatedProp": "SpeedDialProps.tooltipOptions", "props": [ { "name": "event", @@ -20188,8 +20114,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SplitButtonEmits": { "description": "Defines valid emits in SplitButton component.", @@ -20303,6 +20227,54 @@ "default": "", "description": "MenuModel instance to define the overlay items." }, + { + "name": "outlined", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a border class without a background initially." + }, + { + "name": "plain", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a plain textual class to the button without a background initially." + }, + { + "name": "raised", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a shadow to indicate elevation." + }, + { + "name": "rounded", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a circular border radius to the button." + }, + { + "name": "severity", + "optional": true, + "readonly": false, + "type": "\"success\" | \"help\" | \"info\" | \"warning\" | \"danger\" | \"secondary\"", + "default": "", + "description": "Defines the style of the button." + }, + { + "name": "size", + "optional": true, + "readonly": false, + "type": "\"small\" | \"large\"", + "default": "", + "description": "Defines the size of the button." + }, { "name": "style", "optional": true, @@ -20310,6 +20282,14 @@ "type": "any", "default": "", "description": "Inline style of the component." + }, + { + "name": "text", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Add a textual class to the button without a background initially." } ], "methods": [] @@ -20346,8 +20326,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SplitterEmits": { "description": "Defines valid emits in Splitter component.", @@ -20431,7 +20409,7 @@ }, "SplitterResizeEndEvent": { "description": "Custom resize end event.", - "relatedProp": "resizeend", + "relatedProp": "undefined.resizeend", "props": [ { "name": "originalEvent", @@ -20454,7 +20432,7 @@ }, "SplitterResizeStartEvent": { "description": "Custom resize start event.", - "relatedProp": "resizestar", + "relatedProp": "undefined.resizestar", "props": [ { "name": "originalEvent", @@ -20507,8 +20485,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "SplitterPanelEmits": { "relatedProp": "", @@ -20571,8 +20547,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "StepsEmits": { "description": "Defines valid emits in Steps component.", @@ -20630,7 +20604,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -20643,14 +20617,12 @@ } }, "styleclass": { - "description": "StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.\n\n- [Live Demo](https://primevue.org/styleclass)", + "description": "StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.\n\n[Live Demo](https://primevue.org/styleclass)", "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "StyleClassDirectiveBinding": { "description": "Binding of StyleClass directive.", @@ -20766,12 +20738,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TabMenuChangeEvent": { "description": "Custom change event.", - "relatedProp": "['tab-change']", + "relatedProp": "TabMenuEmits['tab-change']", "props": [ { "name": "index", @@ -20870,7 +20840,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -20898,8 +20868,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TabPanelEmits": { "relatedProp": "", @@ -21025,12 +20993,10 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TabViewChangeEvent": { "description": "Custom tab change event.", - "relatedProp": "tab-change", + "relatedProp": "undefined.tab-change", "props": [ { "name": "index", @@ -21054,7 +21020,7 @@ }, "TabViewClickEvent": { "description": "Custom tab change event.", - "relatedProp": "tab-click", + "relatedProp": "undefined.tab-click", "props": [ { "name": "index", @@ -21217,8 +21183,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TagEmits": { "description": "Defines valid emits in Tag component.", @@ -21297,8 +21261,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TerminalEmits": { "description": "Defines valid emits in Terminal component.", @@ -21338,16 +21300,16 @@ } } }, - "terminalservice/TerminalService": { + "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TerminalServiceOptions": { + "description": "Confirmation Service methods.", "relatedProp": "", "props": [], "methods": [ @@ -21357,7 +21319,7 @@ { "name": "action", "optional": false, - "type": "TerminalServiceActionType" + "type": "undefined | \"command\" | \"response\"" }, { "name": "params", @@ -21365,7 +21327,8 @@ "type": "any" } ], - "returnType": "void" + "returnType": "void", + "description": "Emits the terminal using the action options." }, { "name": "off", @@ -21373,7 +21336,7 @@ { "name": "action", "optional": false, - "type": "TerminalServiceActionType" + "type": "undefined | \"command\" | \"response\"" }, { "name": "fn", @@ -21381,7 +21344,8 @@ "type": "any" } ], - "returnType": "void" + "returnType": "void", + "description": "Closes the terminal using the action options." }, { "name": "on", @@ -21389,7 +21353,7 @@ { "name": "action", "optional": false, - "type": "TerminalServiceActionType" + "type": "undefined | \"command\" | \"response\"" }, { "name": "fn", @@ -21397,7 +21361,8 @@ "type": "any" } ], - "returnType": "void" + "returnType": "void", + "description": "Displays the terminal using the action options." } ] } @@ -21420,8 +21385,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TextareaEmits": { "description": "Defines valid emits in Textarea component.", @@ -21493,8 +21456,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TieredMenuEmits": { "description": "Defines valid emits in TieredMenuMenu component.", @@ -21651,7 +21612,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: MenuItem, // Menuitem instance\n }", "description": "item slot's params." } ], @@ -21664,7 +21625,7 @@ } }, "timeline": { - "description": "Timeline visualizes a series of chained events.\n\n- [Live Demo](https://primevue.org/timeline)", + "description": "Timeline visualizes a series of chained events.\n\n[Live Demo](https://primevue.org/timeline)", "components": { "default": { "description": "Timeline visualizes a series of chained events.", @@ -21679,8 +21640,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TimelineEmits": { "description": "Defines valid emits in Timeline component.", @@ -21738,7 +21697,7 @@ { "name": "scope", "optional": false, - "type": "Object" + "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }" } ], "returnType": "VNode[]", @@ -21750,7 +21709,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", "description": "content slot's params." } ], @@ -21763,7 +21722,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", "description": "marker slot's params." } ], @@ -21776,7 +21735,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t index: number, // Index of item\n \t item: any, // Item data\n }", "description": "opposite slot's params." } ], @@ -21804,8 +21763,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ToastBreakpointsType": { "relatedProp": "", @@ -21999,7 +21956,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t message: any, // Message of the component\n }", "description": "message slot's params." } ], @@ -22017,8 +21974,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ToastServiceMethods": { "relatedProp": "", @@ -22066,8 +22021,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ToggleButtonEmits": { "description": "Defines valid emits in ToggleButton component.", @@ -22272,8 +22225,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "ToolbarEmits": { "description": "Defines valid emits in Toolbar component.", @@ -22325,14 +22276,12 @@ } }, "tooltip": { - "description": "Tooltip directive provides advisory information for a component.\n\n- [Live Demo](https://primevue.org/tooltip)", + "description": "Tooltip directive provides advisory information for a component.\n\n[Live Demo](https://primevue.org/tooltip)", "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TooltipDirectiveBinding": { "description": "Binding of Tooltip directive.", @@ -22479,8 +22428,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TreeEmits": { "description": "Defines valid slots in Tree component.", @@ -22853,8 +22800,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TreeSelectEmits": { "description": "Defines valid emits in TreeSelect component.", @@ -23133,7 +23078,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }", "description": "footer slot's params." } ], @@ -23146,7 +23091,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: TreeNode, // An array of treenodes.\n \t value: any, // Selected value\n }", "description": "header slot's params." } ], @@ -23165,7 +23110,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t placeholder: string, // Placeholder\n \t value: any, // Selected value\n }", "description": "value slot's params." } ], @@ -23193,8 +23138,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TreeTableEmits": { "description": "Defines valid emits in TreeTable component.", @@ -23412,7 +23355,7 @@ }, "TreeTableFilterEvent": { "description": "Custom filter event.", - "relatedProp": "sort", + "relatedProp": "undefined.sort", "props": [ { "name": "filterMatchModes", @@ -23551,7 +23494,7 @@ }, "TreeTablePageEvent": { "description": "Custom page event.", - "relatedProp": "sort", + "relatedProp": "undefined.sort", "props": [ { "name": "filterMatchModes", @@ -24000,7 +23943,7 @@ }, "TreeTableSortEvent": { "description": "Custom sort event.", - "relatedProp": "sort", + "relatedProp": "undefined.sort", "props": [ { "name": "filterMatchModes", @@ -24112,8 +24055,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "TriStateCheckboxEmits": { "description": "Defines valid emits in TriStateCheckbox component.", @@ -24368,8 +24309,6 @@ "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.", - "emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", - "slotDescription": "Defines the slots used by the component.", "values": { "VirtualScrollerEmits": { "description": "Defines valid emits in VirtualScroller component.", @@ -24494,7 +24433,7 @@ }, "VirtualScrollerLazyEvent": { "description": "Custom lazy event.", - "relatedProp": "scroll-index-change", + "relatedProp": "undefined.scroll-index-change", "props": [ { "name": "first", @@ -24518,7 +24457,7 @@ }, "VirtualScrollerLoaderOptions": { "description": "Custom virtualscroller loader options", - "relatedProp": "VirtualScrollerItemOptions", + "relatedProp": "undefined.VirtualScrollerItemOptions", "props": [ { "name": "count", @@ -24803,7 +24742,7 @@ }, "VirtualScrollerScrollIndexChangeEvent": { "description": "Custom scroll index change event.", - "relatedProp": "scroll-index-change", + "relatedProp": "undefined.scroll-index-change", "props": [ { "name": "first", @@ -24836,7 +24775,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "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." } ], @@ -24849,7 +24788,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t item: any, // Item data.\n \t options: VirtualScrollerItemOptions, // Item options.\n }", "description": "item slot's params." } ], @@ -24862,7 +24801,7 @@ { "name": "scope", "optional": false, - "type": "Object", + "type": "{\n \t options: VirtualScrollerLoaderOptions, // Loader options.\n }", "description": "header slot's params." } ], @@ -24873,7 +24812,7 @@ }, "VirtualScrollerViewport": { "description": "Custom virtualscroller viewport metadata.", - "relatedProp": "scroll-index-change", + "relatedProp": "undefined.scroll-index-change", "props": [ { "name": "first", diff --git a/layouts/doc/DocApiSection.vue b/layouts/doc/DocApiSection.vue index c8852d2d0..deb8cc8cb 100644 --- a/layouts/doc/DocApiSection.vue +++ b/layouts/doc/DocApiSection.vue @@ -4,7 +4,7 @@

{{ header }} API

API defines helper props, events and others for the PrimeVue {{ header }} module.

- + @@ -44,7 +44,8 @@ export default { id: `api.${moduleName}`, label: docName, description: APIDocs[moduleName]?.description.replace(regex, '') || null, - children: [] + children: [], + docName: docName }; const values = APIDocs[moduleName].interfaces.values; @@ -279,12 +280,14 @@ export default { return interfaces; }, findOptions(values, docName) { - if (docName !== 'MenuItem') return; + const validOptionsDocNames = ['MenuItem', 'ConfirmationOptions']; + + if (!validOptionsDocNames.includes(docName)) return; const options = []; for (const key of Object.keys(values)) { - if (key === 'MenuItem') { + if (key === 'MenuItem' || key === 'ConfirmationOptions') { options.push({ key, values: values[key] }); } } diff --git a/layouts/doc/DocApiTable.vue b/layouts/doc/DocApiTable.vue index f30dfd7f1..fd63e1948 100644 --- a/layouts/doc/DocApiTable.vue +++ b/layouts/doc/DocApiTable.vue @@ -1,68 +1,64 @@