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

Column d.ts updated

pull/3689/head
Tuğçe Küçükoğlu 2023-02-28 17:20:59 +03:00
parent 47186d3a35
commit 698ec627ce
2 changed files with 67 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
components/column/Column.d.ts vendored
View File

@ -1,14 +1,15 @@
/** /**
*
* Column component defines various options to specify corresponding features.
* It is a helper component for DataTable and TreeTable.
*
* [Live Demo](https://www.primevue.org/datatable/)
*
* @module column * @module column
*/ */
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
import { VirtualScrollerLoaderOptions } from '../virtualscroller'; import { VirtualScrollerLoaderOptions } from '../virtualscroller';
type ColumnFieldType = string | ((item: any) => string) | undefined;
type ColumnSelectionModeType = 'single' | 'multiple' | undefined;
type ColumnAlignFrozenType = 'left' | 'right' | undefined;
export interface ColumnFilterModelType { export interface ColumnFilterModelType {
/** /**
@ -63,19 +64,16 @@ export interface ColumnProps {
columnKey?: string | undefined; columnKey?: string | undefined;
/** /**
* Property represented by the column. * Property represented by the column.
* @see ColumnFieldType
*/ */
field?: ColumnFieldType; field?: string | ((item: any) => string) | undefined;
/** /**
* Property name to use in sorting, defaults to field. * Property name to use in sorting, defaults to field.
* @see ColumnFieldType
*/ */
sortField?: ColumnFieldType; sortField?: string | ((item: any) => string) | undefined;
/** /**
* Property name to use in filtering, defaults to field. * Property name to use in filtering, defaults to field.
* @see ColumnFieldType
*/ */
filterField?: ColumnFieldType; filterField?: string | ((item: any) => string) | undefined;
/** /**
* Type of data. It's value is related to PrimeVue.filterMatchModeOptions config. * Type of data. It's value is related to PrimeVue.filterMatchModeOptions config.
*/ */
@ -126,32 +124,32 @@ export interface ColumnProps {
footerClass?: any; footerClass?: any;
/** /**
* Whether to display the filter overlay. * Whether to display the filter overlay.
* Default value is true. * @defaultValue true
*/ */
showFilterMenu?: boolean | undefined; showFilterMenu?: boolean | undefined;
/** /**
* When enabled, match all and match any operator selector is displayed. * When enabled, match all and match any operator selector is displayed.
* Default value is true. * @defaultValue true
*/ */
showFilterOperator?: boolean | undefined; showFilterOperator?: boolean | undefined;
/** /**
* Displays a button to clear the column filtering. * Displays a button to clear the column filtering.
* Default value is true. * @defaultValue true
*/ */
showClearButton?: boolean | undefined; showClearButton?: boolean | undefined;
/** /**
* Displays a button to apply the column filtering. * Displays a button to apply the column filtering.
* Default value is true. * @defaultValue true
*/ */
showApplyButton?: boolean | undefined; showApplyButton?: boolean | undefined;
/** /**
* Whether to show the match modes selector. * Whether to show the match modes selector.
* Default value is true. * @defaultValue true
*/ */
showFilterMatchModes?: boolean | undefined; showFilterMatchModes?: boolean | undefined;
/** /**
* When enabled, a button is displayed to add more rules. * When enabled, a button is displayed to add more rules.
* Default value is true. * @defaultValue true
*/ */
showAddButton?: boolean | undefined; showAddButton?: boolean | undefined;
/** /**
@ -160,7 +158,7 @@ export interface ColumnProps {
filterMatchModeOptions?: ColumnFilterMatchModeOptions[]; filterMatchModeOptions?: ColumnFilterMatchModeOptions[];
/** /**
* Maximum number of constraints for a column filter. * Maximum number of constraints for a column filter.
* Default value is 2. * @defaultValue 2
*/ */
maxConstraints?: number | undefined; maxConstraints?: number | undefined;
/** /**
@ -184,10 +182,9 @@ export interface ColumnProps {
*/ */
filterMenuClass?: any; filterMenuClass?: any;
/** /**
* Defines column based selection mode, options are 'single' and 'multiple'. * Defines column based selection mode.
* @see ColumnSelectionModeType
*/ */
selectionMode?: ColumnSelectionModeType; selectionMode?: 'single' | 'multiple' | undefined;
/** /**
* Displays an icon to toggle row expansion. * Displays an icon to toggle row expansion.
*/ */
@ -206,7 +203,7 @@ export interface ColumnProps {
rowReorder?: boolean | undefined; rowReorder?: boolean | undefined;
/** /**
* Icon of the drag handle to reorder rows. * Icon of the drag handle to reorder rows.
* Default value is 'pi pi-bars'. * @defaultValue pi pi-bars
*/ */
rowReorderIcon?: string | undefined; rowReorderIcon?: string | undefined;
/** /**
@ -223,10 +220,9 @@ export interface ColumnProps {
frozen?: boolean | undefined; frozen?: boolean | undefined;
/** /**
* Position of a frozen column, valid values are left and right. * Position of a frozen column, valid values are left and right.
* @see ColumnAlignFrozenType * @defaultValue left
* Default value is 'left'.
*/ */
alignFrozen?: ColumnAlignFrozenType; alignFrozen?: 'left' | 'right' | undefined;
/** /**
* Whether the column is included in data export. * Whether the column is included in data export.
*/ */
@ -468,7 +464,18 @@ export interface ColumnSlots {
export interface ColumnEmits {} export interface ColumnEmits {}
declare class Column extends ClassComponent<ColumnProps, ColumnSlots, ColumnEmits> {} /**
* **PrimeVue - Column**
*
* _Column is a helper component for DataTable and TreeTable._
*
* [Live Demo](https://www.primevue.org/column/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
export declare class Column extends ClassComponent<ColumnProps, ColumnSlots, ColumnEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
interface GlobalComponents { interface GlobalComponents {
@ -476,14 +483,4 @@ declare module '@vue/runtime-core' {
} }
} }
/**
*
* Column is a helper component for DataTable and TreeTable.
*
* Demos:
*
* - [DataTable](https://www.primefaces.org/primevue/datatable)
* - [TreeTable](https://www.primefaces.org/primevue/treetable)
*
*/
export default Column; export default Column;

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

@ -5256,7 +5256,16 @@
} }
}, },
"column": { "column": {
"description": "", "description": "Column component defines various options to specify corresponding features.\nIt is a helper component for DataTable and TreeTable.\n\n[Live Demo](https://www.primevue.org/datatable/)",
"components": {
"Column": {
"description": "Column is a helper component for DataTable and TreeTable.",
"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.",
@ -5352,7 +5361,7 @@
"name": "column", "name": "column",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "default", "type": "Column",
"default": "", "default": "",
"description": "Column instance" "description": "Column instance"
}, },
@ -5423,8 +5432,8 @@
"name": "alignFrozen", "name": "alignFrozen",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "ColumnAlignFrozenType", "type": "\"left\" | \"right\"",
"default": "", "default": "left",
"description": "Position of a frozen column, valid values are left and right." "description": "Position of a frozen column, valid values are left and right."
}, },
{ {
@ -5519,7 +5528,7 @@
"name": "field", "name": "field",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "ColumnFieldType", "type": "string | Function",
"default": "", "default": "",
"description": "Property represented by the column." "description": "Property represented by the column."
}, },
@ -5527,7 +5536,7 @@
"name": "filterField", "name": "filterField",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "ColumnFieldType", "type": "string | Function",
"default": "", "default": "",
"description": "Property name to use in filtering, defaults to field." "description": "Property name to use in filtering, defaults to field."
}, },
@ -5648,8 +5657,8 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "number", "type": "number",
"default": "", "default": "2",
"description": "Maximum number of constraints for a column filter.\nDefault value is 2." "description": "Maximum number of constraints for a column filter."
}, },
{ {
"name": "reorderableColumn", "name": "reorderableColumn",
@ -5680,8 +5689,8 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "pi pi-bars",
"description": "Icon of the drag handle to reorder rows.\nDefault value is 'pi pi-bars'." "description": "Icon of the drag handle to reorder rows."
}, },
{ {
"name": "rowspan", "name": "rowspan",
@ -5695,63 +5704,63 @@
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "ColumnSelectionModeType", "type": "\"multiple\" | \"single\"",
"default": "", "default": "",
"description": "Defines column based selection mode, options are 'single' and 'multiple'." "description": "Defines column based selection mode."
}, },
{ {
"name": "showAddButton", "name": "showAddButton",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "When enabled, a button is displayed to add more rules.\nDefault value is true." "description": "When enabled, a button is displayed to add more rules."
}, },
{ {
"name": "showApplyButton", "name": "showApplyButton",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "Displays a button to apply the column filtering.\nDefault value is true." "description": "Displays a button to apply the column filtering."
}, },
{ {
"name": "showClearButton", "name": "showClearButton",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "Displays a button to clear the column filtering.\nDefault value is true." "description": "Displays a button to clear the column filtering."
}, },
{ {
"name": "showFilterMatchModes", "name": "showFilterMatchModes",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "Whether to show the match modes selector.\nDefault value is true." "description": "Whether to show the match modes selector."
}, },
{ {
"name": "showFilterMenu", "name": "showFilterMenu",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "Whether to display the filter overlay.\nDefault value is true." "description": "Whether to display the filter overlay."
}, },
{ {
"name": "showFilterOperator", "name": "showFilterOperator",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "true",
"description": "When enabled, match all and match any operator selector is displayed.\nDefault value is true." "description": "When enabled, match all and match any operator selector is displayed."
}, },
{ {
"name": "sortField", "name": "sortField",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "ColumnFieldType", "type": "string | Function",
"default": "", "default": "",
"description": "Property name to use in sorting, defaults to field." "description": "Property name to use in sorting, defaults to field."
}, },