vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

DataTable d.ts updates

pull/3689/head
Tuğçe Küçükoğlu 2023-03-01 09:00:39 +03:00
parent 0bf8507230
commit bc0f312772
2 changed files with 101 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/datatable/DataTable.d.ts vendored
View File

@ -190,12 +190,14 @@ export interface DataTableRowClickEvent {
/** /**
* Custom row double click event. * Custom row double click event.
* @see {@link DataTableEmits.row-click}
* @extends DataTableRowClickEvent * @extends DataTableRowClickEvent
*/ */
export interface DataTableRowDoubleClickEvent extends DataTableRowClickEvent {} export interface DataTableRowDoubleClickEvent extends DataTableRowClickEvent {}
/** /**
* Custom context menu event. * Custom context menu event.
* @see {@link DataTableEmits.row-click}
* @extends DataTableRowClickEvent * @extends DataTableRowClickEvent
*/ */
export interface DataTableRowContextMenuEvent extends DataTableRowClickEvent {} export interface DataTableRowContextMenuEvent extends DataTableRowClickEvent {}
@ -225,6 +227,7 @@ export interface DataTableRowSelectEvent {
/** /**
* Custom row unselect event. * Custom row unselect event.
* @see {@link DataTableEmits.row-select}
* @extends DataTableRowSelectEvent * @extends DataTableRowSelectEvent
*/ */
export interface DataTableRowUnselectEvent extends DataTableRowSelectEvent {} export interface DataTableRowUnselectEvent extends DataTableRowSelectEvent {}
@ -488,7 +491,6 @@ export interface DataTableStateEvent {
multiSortMeta: DataTableSortMeta[] | undefined; multiSortMeta: DataTableSortMeta[] | undefined;
/** /**
* Collection of active filters * Collection of active filters
* @see DataTableFilterMeta
*/ */
filters: DataTableFilterMeta; filters: DataTableFilterMeta;
/** /**
@ -501,7 +503,6 @@ export interface DataTableStateEvent {
columnOrder: string[]; columnOrder: string[];
/** /**
* Instances of rows in expanded state * Instances of rows in expanded state
* @see DataTableExpandedRows
*/ */
expandedRows: any[] | DataTableExpandedRows; expandedRows: any[] | DataTableExpandedRows;
/** /**
@ -708,7 +709,6 @@ export interface DataTableProps {
exportFilename?: string | undefined; exportFilename?: string | undefined;
/** /**
* Custom function to export data. * Custom function to export data.
* @see DataTableExportFunctionOptions
*/ */
exportFunction?(options: DataTableExportFunctionOptions): any; exportFunction?(options: DataTableExportFunctionOptions): any;
/** /**
@ -728,7 +728,6 @@ export interface DataTableProps {
reorderableColumns?: boolean | undefined; reorderableColumns?: boolean | undefined;
/** /**
* A collection of row data display as expanded. * A collection of row data display as expanded.
* @see DataTableExpandedRows
*/ */
expandedRows?: any[] | DataTableExpandedRows | null; expandedRows?: any[] | DataTableExpandedRows | null;
/** /**
@ -756,7 +755,6 @@ export interface DataTableProps {
expandableRowGroups?: boolean | undefined; expandableRowGroups?: boolean | undefined;
/** /**
* An array of group field values whose groups would be rendered as expanded. * An array of group field values whose groups would be rendered as expanded.
* @see DataTableExpandedRows
*/ */
expandedRowGroups?: any[] | DataTableExpandedRows; expandedRowGroups?: any[] | DataTableExpandedRows;
/** /**
@ -774,7 +772,6 @@ export interface DataTableProps {
editMode?: 'cell' | 'row' | undefined; editMode?: 'cell' | 'row' | undefined;
/** /**
* A collection of rows to represent the current editing data in row edit mode. * A collection of rows to represent the current editing data in row edit mode.
* @see DataTableEditingRows
*/ */
editingRows?: any[] | DataTableEditingRows; editingRows?: any[] | DataTableEditingRows;
/** /**
@ -797,7 +794,6 @@ export interface DataTableProps {
/** /**
* Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it. * Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.
* Note: Currently only vertical orientation mode is supported. * Note: Currently only vertical orientation mode is supported.
* @see VirtualScroller.VirtualScrollerProps
*/ */
virtualScrollerOptions?: VirtualScrollerProps; virtualScrollerOptions?: VirtualScrollerProps;
/** /**

149
doc/common/apidoc/index.json
View File

@ -3409,9 +3409,9 @@
"name": "appendTo", "name": "appendTo",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "CalendarAppendToType", "type": "string | HTMLElement",
"default": "", "default": "body",
"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." "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
}, },
{ {
"name": "aria-label", "name": "aria-label",
@ -3505,9 +3505,9 @@
"name": "hourFormat", "name": "hourFormat",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "CalendarHourFormatType", "type": "\"12\" | \"24\"",
"default": "", "default": "",
"description": "Specifies 12 or 24 hour format." "description": "Specifies hour format."
}, },
{ {
"name": "icon", "name": "icon",
@ -3609,8 +3609,8 @@
"name": "modelValue", "name": "modelValue",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "CalendarValueType", "type": "null | string | string[] | Date | Date[]",
"default": "", "default": "null",
"description": "Value of the component." "description": "Value of the component."
}, },
{ {
@ -3705,9 +3705,9 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "CalendarSelectionModeType", "type": "\"multiple\" | \"range\" | \"single\"",
"default": "", "default": "single",
"description": "Defines the quantity of the selection, valid values are 'single', 'multiple' and 'range'." "description": "Defines the quantity of the selection."
}, },
{ {
"name": "shortYearCutoff", "name": "shortYearCutoff",
@ -3825,9 +3825,9 @@
"name": "view", "name": "view",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "CalendarViewType", "type": "\"month\" | \"year\" | \"date\"",
"default": "", "default": "date",
"description": "Type of view to display, valid values are 'date', 'month' and 'year'." "description": "Type of view to display."
}, },
{ {
"name": "yearNavigator", "name": "yearNavigator",
@ -8277,7 +8277,7 @@
}, },
"DataTableRowContextMenuEvent": { "DataTableRowContextMenuEvent": {
"description": "Custom context menu event.", "description": "Custom context menu event.",
"relatedProp": "", "relatedProp": "row-click",
"props": [ "props": [
{ {
"name": "data", "name": "data",
@ -8309,7 +8309,7 @@
}, },
"DataTableRowDoubleClickEvent": { "DataTableRowDoubleClickEvent": {
"description": "Custom row double click event.", "description": "Custom row double click event.",
"relatedProp": "", "relatedProp": "row-click",
"props": [ "props": [
{ {
"name": "data", "name": "data",
@ -8437,7 +8437,7 @@
}, },
"DataTableRowUnselectEvent": { "DataTableRowUnselectEvent": {
"description": "Custom row unselect event.", "description": "Custom row unselect event.",
"relatedProp": "", "relatedProp": "row-select",
"props": [ "props": [
{ {
"name": "data", "name": "data",
@ -16844,7 +16844,17 @@
} }
} }
}, },
"splitter/Splitter": { "splitter": {
"description": "Splitter is utilized to separate and resize panels.\n\n[Live Demo](https://www.primevue.org/splitter/)",
"components": {
"Splitter": {
"description": "Splitter is utilized to separate and resize panels.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.", "eventDescription": "Defines the custom events used by the component's emit.",
@ -16853,7 +16863,41 @@
"emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "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.", "slotDescription": "Defines the slots used by the component.",
"values": { "values": {
"SplitterEmits": {
"description": "Defines valid emits in Splitter component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "resizeend",
"parameters": [
{
"name": "event",
"optional": false,
"type": "SplitterResizeEndEvent",
"description": "Custom resize end event."
}
],
"returnType": "void",
"description": "Callback to invoke when resize ends."
},
{
"name": "resizestar",
"parameters": [
{
"name": "event",
"optional": false,
"type": "SplitterResizeStartEvent",
"description": "Custom resize start event."
}
],
"returnType": "void",
"description": "Callback to invoke when resize starts."
}
]
},
"SplitterProps": { "SplitterProps": {
"description": "Defines valid properties in Splitter component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
@ -16861,15 +16905,15 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "number", "type": "number",
"default": "", "default": "4",
"description": "Size of the divider in pixels.\nDefault value is 4." "description": "Size of the divider in pixels."
}, },
{ {
"name": "layout", "name": "layout",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "SplitterLayoutType", "type": "\"horizontal\" | \"vertical\"",
"default": "", "default": "horizontal",
"description": "Orientation of the panels." "description": "Orientation of the panels."
}, },
{ {
@ -16884,8 +16928,8 @@
"name": "stateStorage", "name": "stateStorage",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "SplitterStateStorageType", "type": "\"local\" | \"session\"",
"default": "", "default": "session",
"description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage." "description": "Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage."
}, },
{ {
@ -16893,14 +16937,15 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "number", "type": "number",
"default": "", "default": "1",
"description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys.\nDefault value is 1." "description": "Step factor to increment/decrement the size of the panels while pressing the arrow keys."
} }
], ],
"methods": [] "methods": []
}, },
"SplitterResizeEndEvent": { "SplitterResizeEndEvent": {
"relatedProp": "", "description": "Custom resize end event.",
"relatedProp": "resizeend",
"props": [ "props": [
{ {
"name": "originalEvent", "name": "originalEvent",
@ -16922,7 +16967,8 @@
"methods": [] "methods": []
}, },
"SplitterResizeStartEvent": { "SplitterResizeStartEvent": {
"relatedProp": "", "description": "Custom resize start event.",
"relatedProp": "resizestar",
"props": [ "props": [
{ {
"name": "originalEvent", "name": "originalEvent",
@ -16944,30 +16990,32 @@
"methods": [] "methods": []
}, },
"SplitterSlots": { "SplitterSlots": {
"description": "Defines valid slots in Splitter slots.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [],
"methods": [
{ {
"name": "default", "name": "default",
"optional": false, "parameters": [],
"readonly": false, "returnType": "VNode<RendererNode, RendererElement, Object>[]",
"type": "Function", "description": "Default slot to detect SplitterPanel components."
"default": ""
} }
], ]
"methods": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"SplitterEmits": {
"values": "{\n \"resizeend\": \"Function, \",\n \"resizestar\": \"Function, \"\n}"
} }
} }
} }
}, },
"splitterpanel/SplitterPanel": { "splitterpanel": {
"description": "SplitterPanel is a helper component for Splitter component.\n\n[Live Demo](https://www.primevue.org/splitter/)",
"components": {
"SplitterPanel": {
"description": "SplitterPanel is a helper component for Splitter component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": { "interfaces": {
"description": "Defines the custom interfaces used by the module.", "description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.", "eventDescription": "Defines the custom events used by the component's emit.",
@ -16976,7 +17024,13 @@
"emitDescription": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "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.", "slotDescription": "Defines the slots used by the component.",
"values": { "values": {
"SplitterPanelEmits": {
"relatedProp": "",
"props": [],
"methods": []
},
"SplitterPanelProps": { "SplitterPanelProps": {
"description": "Defines valid properties in SplitterPanel component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
@ -16999,6 +17053,7 @@
"methods": [] "methods": []
}, },
"SplitterPanelSlots": { "SplitterPanelSlots": {
"description": "Defines valid slots in SplitterPanel slots.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
@ -17012,14 +17067,6 @@
"methods": [] "methods": []
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"SplitterPanelEmits": {
"values": "{}"
}
}
} }
}, },
"steps/Steps": { "steps/Steps": {