diff --git a/components/column/Column.d.ts b/components/column/Column.d.ts index ae2a543ec..9b7473090 100755 --- a/components/column/Column.d.ts +++ b/components/column/Column.d.ts @@ -6,11 +6,16 @@ * [Live Demo](https://www.primevue.org/datatable/) * * @module column + * */ + import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { VirtualScrollerLoaderOptions } from '../virtualscroller'; +/** + * Filter model metadata. + */ export interface ColumnFilterModelType { /** * Value of filterModel. @@ -22,10 +27,17 @@ export interface ColumnFilterModelType { matchMode: string; } +/** + * Filter match modes for specific columns. + */ export interface ColumnFilterMatchModeOptions { [key: string]: string; } +/** + * Custom column loading metadata. + * @see {@link VirtualScrollerLoaderOptions} + */ export interface ColumnLoadingOptions extends VirtualScrollerLoaderOptions { /** * Cell index @@ -57,6 +69,9 @@ export interface ColumnLoadingOptions extends VirtualScrollerLoaderOptions { field: string; } +/** + * Defines valid properties in Column component. + */ export interface ColumnProps { /** * Identifier of a column if field property is not defined. @@ -245,6 +260,9 @@ export interface ColumnProps { hidden?: boolean | undefined; } +/** + * Defines valid slots in Column component. + */ export interface ColumnSlots { /** * Custom body template. @@ -469,7 +487,7 @@ export interface ColumnEmits {} * * _Column is a helper component for DataTable and TreeTable._ * - * [Live Demo](https://www.primevue.org/column/) + * [Live Demo](https://www.primevue.org/datatable/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 46201b285..e8e9bcff4 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -3400,9 +3400,9 @@ "name": "appendTo", "optional": true, "readonly": false, - "type": "CalendarAppendToType", - "default": "", - "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself." + "type": "string | HTMLElement", + "default": "body", + "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." }, { "name": "aria-label", @@ -3496,9 +3496,9 @@ "name": "hourFormat", "optional": true, "readonly": false, - "type": "CalendarHourFormatType", + "type": "\"12\" | \"24\"", "default": "", - "description": "Specifies 12 or 24 hour format." + "description": "Specifies hour format." }, { "name": "icon", @@ -3600,8 +3600,8 @@ "name": "modelValue", "optional": true, "readonly": false, - "type": "CalendarValueType", - "default": "", + "type": "null | string | string[] | Date | Date[]", + "default": "null", "description": "Value of the component." }, { @@ -3696,9 +3696,9 @@ "name": "selectionMode", "optional": true, "readonly": false, - "type": "CalendarSelectionModeType", - "default": "", - "description": "Defines the quantity of the selection, valid values are 'single', 'multiple' and 'range'." + "type": "\"multiple\" | \"range\" | \"single\"", + "default": "single", + "description": "Defines the quantity of the selection." }, { "name": "shortYearCutoff", @@ -3816,9 +3816,9 @@ "name": "view", "optional": true, "readonly": false, - "type": "CalendarViewType", - "default": "", - "description": "Type of view to display, valid values are 'date', 'month' and 'year'." + "type": "\"month\" | \"year\" | \"date\"", + "default": "date", + "description": "Type of view to display." }, { "name": "yearNavigator", @@ -3928,7 +3928,17 @@ } } }, - "card/Card": { + "card": { + "description": "Card is a flexible container component.\n\n[Live Demo](https://www.primevue.org/card/)", + "components": { + "Card": { + "description": "Card is a flexible container component.", + "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.", @@ -3944,52 +3954,45 @@ }, "CardSlots": { "relatedProp": "", - "props": [ + "props": [], + "methods": [ { "name": "content", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom content template." }, { "name": "footer", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom footer template." }, { "name": "header", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom header template." }, { "name": "subtitle", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom subtitle template." }, { "name": "title", - "optional": false, - "readonly": false, - "type": "Function", - "default": "" + "parameters": [], + "returnType": "VNode[]", + "description": "Custom title template." } - ], - "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { + ] + }, "CardEmits": { - "values": "{}" + "description": "", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -5280,6 +5283,7 @@ "methods": [] }, "ColumnFilterMatchModeOptions": { + "description": "Filter match modes for specific columns.", "relatedProp": "", "props": [ { @@ -5292,6 +5296,7 @@ "methods": [] }, "ColumnFilterModelType": { + "description": "Filter model metadata.", "relatedProp": "", "props": [ { @@ -5314,8 +5319,8 @@ "methods": [] }, "ColumnLoadingOptions": { - "description": "", - "relatedProp": "", + "description": "Custom column loading metadata.", + "relatedProp": "VirtualScrollerLoaderOptions", "props": [ { "name": "cellEven", @@ -5426,6 +5431,7 @@ "extendedTypes": "VirtualScrollerLoaderOptions" }, "ColumnProps": { + "description": "Defines valid properties in Column component.", "relatedProp": "", "props": [ { @@ -5784,6 +5790,7 @@ "methods": [] }, "ColumnSlots": { + "description": "Defines valid slots in Column component.", "relatedProp": "", "props": [], "methods": [ @@ -5950,15 +5957,12 @@ "relatedProp": "", "props": [], "methods": [] - } - } - }, - "types": { - "description": "Defines the custom types used by the module.", - "values": { + }, "ColumnGroupEmits": { - "values": "{}", - "description": "" + "description": "", + "relatedProp": "", + "props": [], + "methods": [] } } } @@ -7724,7 +7728,7 @@ "extendedTypes": "DataTableSortEvent" }, "DataTableProps": { - "description": "Defines valid properties in Datatable component.", + "description": "Defines valid properties in DataTable component.", "relatedProp": "", "props": [ { @@ -8463,7 +8467,7 @@ "extendedTypes": "DataTableRowSelectEvent" }, "DataTableSlots": { - "description": "Defines valid slots in Datatable component.", + "description": "Defines valid slots in DataTable component.", "relatedProp": "", "props": [], "methods": [