primereact 8.7.2 → 9.0.0-beta.1

package/column/column.d.ts

@@ -1,274 +1,876 @@
+/**
+ *
+ * Column component defines various options to specify corresponding features.
+ * It is a helper component for DataTable and TreeTable.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/datatable/)
+ *
+ * @module column
+ *
+ */
 import * as React from 'react';
-import TooltipOptions from '../tooltip/tooltipoptions';
-
-type ColumnHeaderType = React.ReactNode | ((options: ColumnHeaderOptions) => React.ReactNode);
-
-type ColumnBodyType = React.ReactNode | ((data: any, options: ColumnBodyOptions) => React.ReactNode);
-
-type ColumnBodyClassType = string | ((data: any, options: ColumnBodyOptions) => string);
-
-type ColumnExpanderType = boolean | ((data: any, options: ColumnBodyOptions) => boolean);
-
-type ColumnFooterType = React.ReactNode | ((options: ColumnFooterOptions) => React.ReactNode);
-
-type ColumnEditorType = React.ReactNode | ((options: ColumnEditorOptions) => React.ReactNode);
-
-type ColumnFilterMatchModeType = 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom';
-
-type ColumnSelectionModeType = 'single' | 'multiple';
-
-type ColumnSortOrderType = 1 | 0 | -1 | undefined | null;
-
-type ColumnDataType = 'text' | 'numeric' | 'date' | string;
-
-type ColumnAlignType = 'left' | 'right' | 'center' | undefined | null;
-
-type ColumnAlignFrozenType = 'left' | 'right';
-
-type ColumnFilterOperatorType = 'and' | 'or';
-
-type ColumnFilterClearType = React.ReactNode | ((options: ColumnFilterClearTemplateOptions) => React.ReactNode);
-
-type ColumnFilterApplyType = React.ReactNode | ((options: ColumnFilterApplyTemplateOptions) => React.ReactNode);
-
-type ColumnFilterHeaderType = React.ReactNode | ((options: ColumnFilterHeaderTemplateOptions) => React.ReactNode);
-
-type ColumnFilterFooterType = React.ReactNode | ((options: ColumnFilterFooterTemplateOptions) => React.ReactNode);
-
-type ColumnFilterElementType = React.ReactNode | ((options: ColumnFilterElementTemplateOptions) => React.ReactNode);
-
-type ColumnFilterModelType = ColumnFilterMetaData | ColumnFilterMetaDataWithConstraint;
+import { TooltipOptions } from '../tooltip/tooltipoptions';
 
+/**
+ * @group misc
+ */
 interface ColumnHeaderOptions {
+    /**
+     * Additional properties passed to the body component.
+     */
     props: any;
 }
 
+/**
+ * Column Header Options
+ * @extends {ColumnHeaderOptions}
+ */
 interface ColumnFooterOptions extends ColumnHeaderOptions {}
 
+/**
+ * @group misc
+ */
 interface ColumnBodyOptions {
+    /**
+     * Column of the options.
+     */
     column: Column;
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Index of the row.
+     */
     rowIndex: number;
+    /**
+     * Additional properties passed to the body component.
+     */
     props?: any;
+    /**
+     * Whether the row is frozen or not.
+     */
     frozenRow?: boolean;
+    /**
+     * Options for the expander component.
+     */
     expander?: ColumnBodyExpanderOptions;
+    /**
+     * Options for the row editor component.
+     */
     rowEditor?: ColumnBodyRowEditorOptions;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnBodyExpanderOptions {
-    onClick?(e: any): void;
+    /**
+     * Event on click of the expander.
+     * @param {*} event -  Browser event.
+     */
+    onClick?(event: any): void;
+    /**
+     * Class name of the options.
+     */
     className?: string;
+    /**
+     * Class name of the options icon.
+     */
     iconClassName?: string;
+    /**
+     * Custom JSX element for the options.
+     */
     element?: JSX.Element;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnBodyRowEditorOptions {
+    /**
+     * Whether row is in editing mode.
+     */
     editing?: boolean;
+    /**
+     * Custom JSX element for the options.
+     */
     element?: JSX.Element;
-    onSaveClick?(e: any): void;
+    /**
+     * Event on save click of the row editor.
+     * @param {*} event  - Browser event.
+     */
+    onSaveClick?(event: any): void;
+    /**
+     * Class name of the save button.
+     */
     saveClassName?: string;
+    /**
+     * Class name of the save icon.
+     */
     saveIconClassName?: string;
-    onCancelClick?(e: any): void;
+    /**
+     * Event on cancel click of the row editor.
+     * @param {*} event  - Browser event.
+     */
+    onCancelClick?(event: any): void;
+    /**
+     * Class name of the cancel button.
+     */
     cancelClassName?: string;
+    /**
+     * Class name of the cancel icon.
+     */
     cancelIconClassName?: string;
-    onInitClick?(e: any): void;
+    /**
+     * Event on init click of the row editor.
+     * @param {*} event  - Browser event.
+     */
+    onInitClick?(event: any): void;
+    /**
+     * Class name of the init button.
+     */
     initClassName?: string;
+    /**
+     * Class name of the init icon.
+     */
     initIconClassName?: string;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnEditorOptions {
+    /**
+     * Node element of the editor.
+     */
     node?: any;
+    /**
+     * Data of the edited row.
+     */
     rowData: any;
+    /**
+     * Value of the editor.
+     */
     value: any;
+    /**
+     * Column of the editor.
+     */
     column: Column;
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Index of the edited row.
+     */
     rowIndex: number;
+    /**
+     * Whether the row is frozen or not.
+     */
     frozenRow?: boolean;
+    /**
+     * Additional properties passed to the body component.
+     */
     props: any;
-    editorCallback?(val: any): void;
+    /**
+     * Callback function triggered on editor change.
+     * @param {*} value - Browser event
+     */
+    editorCallback?(value: any): void;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterModelOptions {
-    [key: string]: ColumnFilterModelType;
+    /**
+     * Object containing key-value pairs of column filter metadata or metadata with constraint.
+     */
+    [key: string]: ColumnFilterMetaData | ColumnFilterMetaDataWithConstraint;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterClearTemplateOptions {
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Object containing column filter model options.
+     */
     filterModel: ColumnFilterModelOptions;
+    /**
+     * Callback function to clear the filters.
+     */
     filterClearCallback(): void;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterApplyTemplateOptions {
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Object containing column filter model options.
+     */
     filterModel: ColumnFilterModelOptions;
+    /**
+     * Callback function to apply the filters with optional value and index parameters.
+     * @param {*} value - Value of the filter.
+     * @param {number} index - Index of the filter.
+     */
     filterApplyCallback(value?: any, index?: number): void;
 }
 
+/**
+ * Column Filter Header Template Opitons
+ * @extends {ColumnFilterApplyTemplateOptions}
+ */
 interface ColumnFilterHeaderTemplateOptions extends ColumnFilterApplyTemplateOptions {}
 
+/**
+ * Column Filter Footer Template Opitons
+ * @extends {ColumnFilterApplyTemplateOptions}
+ */
 interface ColumnFilterFooterTemplateOptions extends ColumnFilterApplyTemplateOptions {}
 
+/**
+ * @group misc
+ */
 interface ColumnFilterElementTemplateOptions {
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Index of the filter.
+     */
     index: number;
+    /**
+     * Object containing column filter model options.
+     */
     filterModel: ColumnFilterModelOptions;
+    /**
+     * Value of the filter.
+     */
     value: any;
+    /**
+     * Callback function to apply the filters with optional value and index parameters.
+     * @param {*} value - Value of the filter.
+     * @param {number} index - Index of the filter.
+     */
     filterApplyCallback(value?: any, index?: number): void;
+    /**
+     * Callback function with optional value and index parameters.
+     * @param {*} value - Value of the filter.
+     * @param {number} index - Index of the filter.
+     */
     filterCallback(value?: any, index?: number): void;
 }
 
-interface ColumnEventParams {
+/**
+ * Custom event.
+ * @see {@link ColumnProps.cellEditValidator}, {@link ColumnProps.onBeforeCellEditHide}, {@link ColumnProps.onBeforeCellEditShow}, {@link ColumnProps.onCellEditCancel}, {@link ColumnProps.onCellEditComplete}, {@link ColumnProps.onCellEditInit}
+ * @event
+ */
+interface ColumnEvent {
+    /**
+     * Original event triggered.
+     */
     originalEvent: React.SyntheticEvent;
+    /**
+     * Value of the element.
+     */
     value: any;
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Data of the selected row.
+     */
     rowData: any;
+    /**
+     * Index of the selected row.
+     */
     rowIndex: number;
+    /**
+     * Index of the selected cell.
+     */
     cellIndex: number;
+    /**
+     * Whether the element is selected or not.
+     */
     selected: boolean;
+    /**
+     * Column of the element.
+     */
     column: Column;
+    /**
+     * New data of the row.
+     */
     newRowData: any;
+    /**
+     * New value of the element.
+     */
     newValue: any;
 }
 
+/**
+ * @group misc
+ */
 interface ColumnSortMetaData {
+    /**
+     * Field name of the column.
+     */
     field: string;
-    order: ColumnSortOrderType;
+    /**
+     * Sort order of the column.
+     */
+    order: 1 | 0 | -1 | undefined | null;
 }
 
-interface ColumnSortParams extends ColumnSortMetaData {
+/**
+ * Custom sort event.
+ * @see {@link ColumnProps.sortFunction}
+ * @event
+ */
+interface ColumnSortEvent extends ColumnSortMetaData {
+    /**
+     * Data to be sorted.
+     */
     data: any;
+    /**
+     * Array of multiple sort metadata for multi-column sorting.
+     */
     multiSortMeta?: ColumnSortMetaData[];
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterMetaData {
+    /**
+     * Value of the filter.
+     */
     value: any;
-    matchMode: ColumnFilterMatchModeType;
+    /**
+     * Type of filter match.
+     */
+    matchMode: 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom';
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterMetaDataWithConstraint {
-    operator: ColumnFilterOperatorType;
+    /**
+     * Logical operator for the constraints.
+     */
+    operator: 'and' | 'or';
+    /**
+     * Array of ColumnFilterMetaData objects representing the constraints.
+     */
     constraints: ColumnFilterMetaData[];
 }
 
-interface ColumnFilterApplyClickParams {
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterApplyClick}
+ * @event
+ */
+interface ColumnFilterApplyClickEvent {
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Array of ColumnFilterMetaData objects representing the constraints.
+     */
     constraints: ColumnFilterMetaData[];
 }
 
-interface ColumnFilterMatchModeChangeParams {
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterMatchModeChange}
+ * @event
+ */
+interface ColumnFilterMatchModeChangeEvent {
+    /**
+     * Field name of the column.
+     */
     field: string;
-    matchMode: ColumnFilterMatchModeType;
+    /**
+     * Type of filter match.
+     */
+    matchMode: 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom';
 }
 
-interface ColumnFilterOperatorChangeParams {
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterOperatorChange}
+ * @event
+ */
+interface ColumnFilterOperatorChangeEvent {
+    /**
+     * Field name of the column.
+     */
     field: string;
-    operator: ColumnFilterOperatorType;
+    /**
+     * Logical operator for the filter.
+     */
+    operator: 'and' | 'or';
 }
 
-interface ColumnFilterConstraintAddParams {
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterConstraintAdd}
+ * @event
+ */
+interface ColumnFilterConstraintAddEvent {
+    /**
+     * Field name of the column.
+     */
     field: string;
+    /**
+     * Array of ColumnFilterMetaData objects representing the constraints.
+     */
     constraint: ColumnFilterMetaData;
 }
 
-interface ColumnFilterConstraintRemoveParams extends ColumnFilterConstraintAddParams {}
-
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterConstraintRemove}
+ * @extends {ColumnFilterConstraintAddEvent}
+ * @event
+ */
+interface ColumnFilterConstraintRemoveEvent extends ColumnFilterConstraintAddEvent {}
+
+/**
+ * @group misc
+ */
 interface ColumnFilterMeta {
+    /**
+     * Filter metadata for specific columns.
+     */
     [key: string]: ColumnFilterMetaData;
 }
 
-interface ColumnFilterParams {
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.filterFunction}
+ * @event
+ */
+interface ColumnFilterEvent {
+    /**
+     * Data of the current row."
+     */
     rowData: any;
+    /**
+     * Object containing filter metadata for all columns.
+     */
     filters: ColumnFilterMeta;
+    /**
+     * Additional properties passed to the filter function.
+     */
     props: any;
+    /**
+     * Object containing metadata for the current column, including filter metadata, field name, and column properties.
+     */
     column: {
+        /**
+         * Filter metadata for the current column.
+         */
         filterMeta: object | undefined | null;
+        /**
+         * Field name of the current column.
+         */
         filterField: string;
+        /**
+         * Properties of the current column.
+         */
         props: ColumnProps;
     };
 }
 
+/**
+ * @group misc
+ */
 interface ColumnFilterMatchModeOptions {
+    /**
+     * Filter match modes for specific columns.
+     */
     [key: string]: string;
 }
 
+/**
+ * Defines valid properties in ColumnProps component.
+ * @group Properties
+ */
 export interface ColumnProps {
-    align?: ColumnAlignType;
-    alignFrozen?: ColumnAlignFrozenType;
-    alignHeader?: ColumnAlignType;
-    body?: ColumnBodyType;
-    bodyClassName?: ColumnBodyClassType;
-    bodyStyle?: React.CSSProperties;
-    cellEditValidatorEvent?: string;
-    children?: React.ReactNode;
-    className?: string;
-    colSpan?: number;
-    columnKey?: string;
-    dataType?: ColumnDataType;
-    editor?: ColumnEditorType;
-    excludeGlobalFilter?: boolean;
-    expander?: ColumnExpanderType;
-    exportable?: boolean;
-    exportField?: string;
-    field?: string;
-    filter?: boolean;
-    filterApply?: ColumnFilterApplyType;
-    filterClear?: ColumnFilterClearType;
-    filterElement?: ColumnFilterElementType;
-    filterField?: string;
-    filterFooter?: ColumnFilterFooterType;
-    filterHeader?: ColumnFilterHeaderType;
-    filterHeaderClassName?: string;
-    filterHeaderStyle?: React.CSSProperties;
-    filterMatchMode?: ColumnFilterMatchModeType;
+    /**
+     * Aligns the content of the column, valid values are left, right and center.
+     */
+    align?: 'left' | 'right' | 'center' | undefined | null;
+    /**
+     * Position of a frozen column, valid values are left and right.
+     */
+    alignFrozen?: 'left' | 'right' | undefined;
+    /**
+     * Aligns the header of the column, valid values are left, right and center.
+     */
+    alignHeader?: 'left' | 'right' | 'center' | undefined | null;
+    /**
+     * Body content of the column.
+     */
+    body?: React.ReactNode | ((data: any, options: ColumnBodyOptions) => React.ReactNode);
+    /**
+     * Style class of the body. If using a function must return a string.
+     */
+    bodyClassName?: string | ((data: any, options: ColumnBodyOptions) => string);
+    /**
+     * Inline style of the body.
+     */
+    bodyStyle?: React.CSSProperties | undefined;
+    /**
+     * Event to trigger the validation, possible values are "click" and "blur".
+     * @defaultValue click
+     */
+    cellEditValidatorEvent?: string | undefined;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
+    /**
+     * Style class of the component.
+     */
+    className?: string | undefined;
+    /**
+     * Number of columns to span for grouping.
+     */
+    colSpan?: number | undefined;
+    /**
+     * Identifier of a column if field property is not defined. Only utilized by reorderableColumns feature at the moment.
+     */
+    columnKey?: string | undefined;
+    /**
+     * Depending on the dataType of the column, suitable match modes are displayed.
+     */
+    dataType?: 'text' | 'numeric' | 'date' | string | undefined;
+    /**
+     * Function to provide the cell editor input.
+     */
+    editor?: React.ReactNode | ((options: ColumnEditorOptions) => React.ReactNode);
+    /**
+     * Whether to exclude from global filtering or not.
+     * @defaultValue false
+     */
+    excludeGlobalFilter?: boolean | undefined;
+    /**
+     * Displays an icon to toggle row expansion.
+     * @defaultValue false
+     */
+    expander?: boolean | ((data: any, options: ColumnBodyOptions) => boolean);
+    /**
+     * Defines whether the column is exported or not.
+     * @defaultValue true
+     */
+    exportable?: boolean | undefined;
+    /**
+     * Property of a row data used for exporting, defaults to field.
+     */
+    exportField?: string | undefined;
+    /**
+     * Property of a row data.
+     */
+    field?: string | undefined;
+    /**
+     * Defines if a column can be filtered.
+     * @defaultValue false
+     */
+    filter?: boolean | undefined;
+    /**
+     * Template of apply element in menu.
+     */
+    filterApply?: React.ReactNode | ((options: ColumnFilterApplyTemplateOptions) => React.ReactNode);
+    /**
+     * Template of clear element in menu.
+     */
+    filterClear?: React.ReactNode | ((options: ColumnFilterClearTemplateOptions) => React.ReactNode);
+    /**
+     * Element for custom filtering.
+     */
+    filterElement?: React.ReactNode | ((options: ColumnFilterElementTemplateOptions) => React.ReactNode);
+    /**
+     * Property of a row data used for filtering, defaults to field.
+     */
+    filterField?: string | undefined;
+    /**
+     * Template of footer element in menu.
+     */
+    filterFooter?: React.ReactNode | ((options: ColumnFilterFooterTemplateOptions) => React.ReactNode);
+    /**
+     * Template of header element in menu.
+     */
+    filterHeader?: React.ReactNode | ((options: ColumnFilterHeaderTemplateOptions) => React.ReactNode);
+    /**
+     * Style class of the filter header.
+     */
+    filterHeaderClassName?: string | undefined;
+    /**
+     * Inline style of the filter header.
+     */
+    filterHeaderStyle?: React.CSSProperties | undefined;
+    /**
+     * Defines filterMatchMode; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "lt", "lte", "gt", "gte" and "custom".
+     */
+    filterMatchMode?: 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom' | undefined;
+    /**
+     * An array of label-value pairs to override the global match mode options.
+     */
     filterMatchModeOptions?: ColumnFilterMatchModeOptions[];
-    filterMaxLength?: number;
-    filterMenuClassName?: string;
-    filterMenuStyle?: React.CSSProperties;
-    filterPlaceholder?: string;
-    filterType?: string;
-    footer?: ColumnFooterType;
-    footerClassName?: string;
-    footerStyle?: React.CSSProperties;
-    frozen?: boolean;
-    header?: ColumnHeaderType;
-    headerClassName?: string;
-    headerStyle?: React.CSSProperties;
-    headerTooltip?: string;
-    headerTooltipOptions?: TooltipOptions;
-    hidden?: boolean;
-    maxConstraints?: number;
-    reorderable?: boolean;
-    resizeable?: boolean;
-    rowEditor?: boolean;
-    rowReorder?: boolean;
-    rowReorderIcon?: string;
-    rowSpan?: number;
-    selectionMode?: ColumnSelectionModeType;
-    showAddButton?: boolean;
-    showApplyButton?: boolean;
-    showClearButton?: boolean;
-    showFilterMatchModes?: boolean;
-    showFilterMenu?: boolean;
-    showFilterMenuOptions?: boolean;
-    showFilterOperator?: boolean;
-    sortField?: string;
-    sortable?: boolean;
-    sortableDisabled?: boolean;
-    style?: React.CSSProperties;
-    cellEditValidator?(e: ColumnEventParams): boolean;
-    filterFunction?(value: any, filter: any, filterLocale: string, params: ColumnFilterParams): void;
-    onBeforeCellEditHide?(e: ColumnEventParams): void;
-    onBeforeCellEditShow?(e: ColumnEventParams): void;
-    onCellEditCancel?(e: ColumnEventParams): void;
-    onCellEditComplete?(e: ColumnEventParams): void;
-    onCellEditInit?(e: ColumnEventParams): void;
-    onFilterApplyClick?(e: ColumnFilterApplyClickParams): void;
+    /**
+     * Specifies the maximum number of characters allowed in the filter element.
+     */
+    filterMaxLength?: number | undefined;
+    /**
+     * Style class of the column filter overlay.
+     */
+    filterMenuClassName?: string | undefined;
+    /**
+     * Inline style of the column filter overlay.
+     */
+    filterMenuStyle?: React.CSSProperties | undefined;
+    /**
+     * Defines placeholder of the input fields.
+     */
+    filterPlaceholder?: string | undefined;
+    /**
+     * Type of the filter input field.
+     * @defaultValue text
+     */
+    filterType?: string | undefined;
+    /**
+     * Footer content of the table.
+     */
+    footer?: React.ReactNode | ((options: ColumnFooterOptions) => React.ReactNode);
+    /**
+     * Style class of the footer.
+     */
+    footerClassName?: string | undefined;
+    /**
+     * Inline style of the footer.
+     */
+    footerStyle?: React.CSSProperties | undefined;
+    /**
+     * Whether the column is fixed in horizontal scrolling or not.
+     * @defaultValue false
+     */
+    frozen?: boolean | undefined;
+    /**
+     * Header content of the table.
+     */
+    header?: React.ReactNode | ((options: ColumnHeaderOptions) => React.ReactNode);
+    /**
+     * Style class of the header.
+     */
+    headerClassName?: string | undefined;
+    /**
+     * Inline style of the header.
+     */
+    headerStyle?: React.CSSProperties | undefined;
+    /**
+     * Content of the header tooltip.
+     */
+    headerTooltip?: string | undefined;
+    /**
+     * Configuration of the header tooltip, refer to the tooltip documentation for more information.
+     */
+    headerTooltipOptions?: TooltipOptions | undefined;
+    /**
+     * Whether the column is rendered.
+     * @defaultValue false
+     */
+    hidden?: boolean | undefined;
+    /**
+     * Maximum number of constraints for a column filter.
+     * @defaultValue 2
+     */
+    maxConstraints?: number | undefined;
+    /**
+     * Used to defined reorderableColumns per column when reorderableColumns of table is enabled, defaults to value of reorderableColumns.
+     */
+    reorderable?: boolean | undefined;
+    /**
+     * Used to defined resizeableColumns per column when resizeableColumns of table is enabled, defaults to value of resizeableColumns.
+     */
+    resizeable?: boolean | undefined;
+    /**
+     * Displays icons to edit row.
+     * @defaultValue false
+     */
+    rowEditor?: boolean | undefined;
+    /**
+     * Whether this column displays an icon to reorder the rows.
+     * @defaultValue false
+     */
+    rowReorder?: boolean | undefined;
+    /**
+     * Icon of the drag handle to reorder rows.
+     * @defaultValue pi pi-bars
+     */
+    rowReorderIcon?: string | undefined;
+    /**
+     * Number of rows to span for grouping.
+     */
+    rowSpan?: number | undefined;
+    /**
+     * Specifies the selection mode, valid values are "single", "multiple", "radiobutton" and "checkbox".
+     */
+    selectionMode?: 'single' | 'multiple' | undefined;
+    /**
+     * When enabled, a button is displayed to add more rules.
+     * @defaultValue true
+     */
+    showAddButton?: boolean | undefined;
+    /**
+     * Displays a button to apply the column filtering.
+     * @defaultValue true
+     */
+    showApplyButton?: boolean | undefined;
+    /**
+     * Displays a button to clear the column filtering.
+     * @defaultValue true
+     */
+    showClearButton?: boolean | undefined;
+    /**
+     * Whether to show the match modes selector.
+     * @defaultValue true
+     */
+    showFilterMatchModes?: boolean | undefined;
+    /**
+     * Whether to display the filter overlay.
+     * @defaultValue true
+     */
+    showFilterMenu?: boolean | undefined;
+    /**
+     * Whether to show the match modes selector and match operator selector.
+     * @defaultValue true
+     */
+    showFilterMenuOptions?: boolean | undefined;
+    /**
+     * When enabled, match all and match any operator selector is displayed.
+     * @defaultValue true
+     */
+    showFilterOperator?: boolean | undefined;
+    /**
+     * Name of the field to sort data by default.
+     */
+    sortField?: string | undefined;
+    /**
+     * Defines if a column is sortable.
+     * @defaultValue false
+     */
+    sortable?: boolean | undefined;
+    /**
+     * When enabled, the data of columns with this property cannot be sorted or changed by the user.
+     * @defaultValue false
+     */
+    sortableDisabled?: boolean | undefined;
+    /**
+     * Inline style of the component.
+     */
+    style?: React.CSSProperties | undefined;
+    /**
+     * Validator function to validate the cell input value.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    cellEditValidator?(event: ColumnEvent): boolean;
+    /**
+     * Custom filter function.
+     * @param {*} value - Value of the filter event.
+     * @param {*} filter - Filter of the filter event.
+     * @param {*} filterLocale - Filter locale of the event.
+     * @param {*} params - Params of the filter event.
+     */
+    filterFunction?(value: any, filter: any, filterLocale: string, params: ColumnFilterEvent): void;
+    /**
+     * Callback to invoke before the cell editor is hidden.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    onBeforeCellEditHide?(event: ColumnEvent): void;
+    /**
+     * Callback to invoke before the cell editor is shown.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    onBeforeCellEditShow?(event: ColumnEvent): void;
+    /**
+     * Callback to execute when editor is cancelled.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    onCellEditCancel?(event: ColumnEvent): void;
+    /**
+     * Callback to execute when editor is submitted.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    onCellEditComplete?(event: ColumnEvent): void;
+    /**
+     * Callback to invoke when cell edit is initiated.
+     * @param {ColumnEvent} event - Custom event.
+     */
+    onCellEditInit?(event: ColumnEvent): void;
+    /**
+     * Callback to invoke when the apply button is clicked.
+     * @param {ColumnFilterApplyClickEvent} event - Custom filter event.
+     */
+    onFilterApplyClick?(event: ColumnFilterApplyClickEvent): void;
+    /**
+     * Callback to invoke when the filter meta is cleared.
+     */
     onFilterClear?(): void;
-    onFilterConstraintAdd?(e: ColumnFilterConstraintAddParams): void;
-    onFilterConstraintRemove?(e: ColumnFilterConstraintRemoveParams): void;
-    onFilterMatchModeChange?(e: ColumnFilterMatchModeChangeParams): void;
-    onFilterOperatorChange?(e: ColumnFilterOperatorChangeParams): void;
-    sortFunction?(e: ColumnSortParams): void;
+    /**
+     * Callback to invoke when a new constraint is added.
+     * @param {ColumnFilterConstraintAddEvent} event - Custom filter event.
+     */
+    onFilterConstraintAdd?(event: ColumnFilterConstraintAddEvent): void;
+    /**
+     * Callback to invoke when a constraint is removed.
+     * @param {ColumnFilterConstraintRemoveEvent} event - Custom filter event.
+     */
+    onFilterConstraintRemove?(event: ColumnFilterConstraintRemoveEvent): void;
+    /**
+     * Callback to invoke when the match mode option is changed.
+     * @param {ColumnFilterMatchModeChangeEvent} event - Custom filter event.
+     */
+    onFilterMatchModeChange?(event: ColumnFilterMatchModeChangeEvent): void;
+    /**
+     * Callback to invoke when the filter operator option is changed.
+     * @param {ColumnFilterOperatorChangeEvent} event - Custom filter event.
+     */
+    onFilterOperatorChange?(event: ColumnFilterOperatorChangeEvent): void;
+    /**
+     * Sort function for custom sorting.
+     * @param {ColumnSortEvent} event - Custom sort event.
+     */
+    sortFunction?(event: ColumnSortEvent): void;
 }
 
+/**
+ * **PrimeReact - Column**
+ *
+ * _It is a helper component for DataTable and TreeTable._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/column/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class Column extends React.Component<ColumnProps, any> {}