@orcado/yoyui 0.0.1

package/components/lib/column/column.d.ts

@@ -0,0 +1,1180 @@
+/**
+ *
+ * Column component defines various options to specify corresponding features.
+ * It is a helper component for DataTable and TreeTable.
+ *
+ * [Live Demo](https://www.primereact.org/datatable/)
+ *
+ * @module column
+ *
+ */
+import * as React from 'react';
+import { FilterMatchMode } from '../api/api';
+import { CheckboxPassThroughOptions } from '../checkbox/checkbox';
+import { ComponentHooks } from '../componentbase/componentbase';
+import { DataTablePassThroughOptions } from '../datatable/datatable';
+import { PassThroughOptions } from '../passthrough';
+import { RadioButtonPassThroughOptions } from '../radiobutton/radiobutton';
+import { TooltipOptions } from '../tooltip/tooltipoptions';
+import { IconType, PassThroughType } from '../utils/utils';
+
+export declare type ColumnPassThroughType<T> = PassThroughType<T, ColumnPassThroughMethodOptions>;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface ColumnPassThroughMethodOptions {
+    props: ColumnProps;
+    state: ColumnState;
+    context: ColumnContext;
+    parent: DataTablePassThroughOptions;
+}
+
+/**
+ * Defines current options in Column component.
+ */
+export interface ColumnContext {
+    /**
+     * Current checked state of row as a boolean.
+     * @defaultValue false
+     */
+    checked: boolean;
+    /**
+     * Current disabled state of row as a boolean.
+     * @defaultValue false
+     */
+    disabled: boolean;
+    /**
+     * Current index of the column.
+     */
+    index: number;
+    /**
+     * Current sort state of the column as a boolean.
+     * @defaultValue false
+     */
+    sorted: boolean;
+    /**
+     * Current resizable state of the column as a boolean.
+     * @defaultValue false
+     */
+    resizable: boolean;
+    /**
+     * Current size state of the table.
+     */
+    size: string;
+    /**
+     * Current gridlines state of the table as a boolean.
+     * @defaultValue false
+     */
+    showGridlines: boolean;
+    /**
+     * Current highlighted state of the filter row item as a boolean.
+     * @defaultValue false
+     */
+    highlighted: boolean;
+    /**
+     * Current hidden state of the filter clear button of a column as a boolean.
+     * @defaultValue false
+     */
+    hidden: boolean;
+    /**
+     * Current active state of the filter menu of a column as a boolean.
+     * @defaultValue false
+     */
+    active: boolean;
+}
+
+/**
+ * Defines current inline state in Column component.
+ */
+export interface ColumnState {
+    /**
+     * Current editing state of the body cell.
+     */
+    editing: boolean;
+    /**
+     * Current editing row data of the body cell.
+     */
+    editingRowData: any;
+    /**
+     * Current style of the body cell.
+     */
+    styleObject: object;
+    /**
+     * Current focused state as a boolean.
+     * @defaultValue false
+     */
+    focused: boolean;
+    /**
+     * Current visible state of the filter menu of a column as a boolean.
+     * @defaultValue false
+     */
+    overlayVisible: boolean;
+    /**
+     * Current style of the rowgroup header.
+     */
+    rowGroupHeaderStyleObject: object;
+    /**
+     * Current sortable disabled fields of the table header.
+     */
+    sortableDisabledFields: any[];
+    /**
+     * Current style of the table header.
+     * @defaultValue false
+     */
+    allSortableDisabled: boolean;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link ColumnProps.pt}
+ */
+export interface ColumnPassThroughOptions {
+    /**
+     * Uses to pass attributes to the root's DOM element.
+     */
+    root?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the header cell's DOM element.
+     */
+    headerCell?: ColumnPassThroughType<React.HTMLAttributes<HTMLTableCellElement>>;
+    /**
+     * Uses to pass attributes to the column resizer's DOM element.
+     */
+    columnResizer?: ColumnPassThroughType<React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the header content's DOM element.
+     */
+    headerContent?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the header title's DOM element.
+     */
+    headerTitle?: ColumnPassThroughType<React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the sort's DOM element.
+     */
+    sort?: ColumnPassThroughType<React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the sort's DOM element.
+     */
+    sortIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the sort badge's DOM element.
+     */
+    sortBadge?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the header checkbox's component.
+     */
+    headerCheckbox?: CheckboxPassThroughOptions;
+    /**
+     * Uses to pass attributes to the column filter's DOM element.
+     */
+    columnFilter?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter input's DOM element.
+     */
+    filterInput?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter menu button's DOM element.
+     */
+    filterMenuButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the header filter clear button's DOM element.
+     */
+    headerFilterClearButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the filter clear icon's DOM element.
+     */
+    filterClearIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the filter overlay's DOM element.
+     */
+    filterOverlay?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter row items' DOM element.
+     */
+    filterRowItems?: ColumnPassThroughType<React.HTMLAttributes<HTMLUListElement>>;
+    /**
+     * Uses to pass attributes to the filter row item's DOM element.
+     */
+    filterRowItem?: ColumnPassThroughType<React.HTMLAttributes<HTMLLIElement>>;
+    /**
+     * Uses to pass attributes to the filter separator's DOM element.
+     */
+    filterSeparator?: ColumnPassThroughType<React.HTMLAttributes<HTMLLIElement>>;
+    /**
+     * Uses to pass attributes to the filter operator's DOM element.
+     */
+    filterOperator?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the Dropdown component.
+     */
+    filterOperatorDropdown?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter constraints' DOM element.
+     */
+    filterConstraints?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter constraint's DOM element.
+     */
+    filterConstraint?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the Dropdown component.
+     */
+    filterMatchModeDropdown?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the filter remove button container's DOM element.
+     */
+    filterRemove?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the Button component.
+     */
+    filterRemoveButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the filter add rule's DOM element.
+     */
+    filterAddRule?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the Button component.
+     */
+    filterAddRuleButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the filter buttonbar's DOM element.
+     */
+    filterButtonbar?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the Button component.
+     */
+    filterClearButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the Button component.
+     */
+    filterApplyButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the body cell's DOM element.
+     */
+    bodyCell?: ColumnPassThroughType<React.HTMLAttributes<HTMLTableCellElement>>;
+    /**
+     * Uses to pass attributes to the footer cell's DOM element.
+     */
+    footerCell?: ColumnPassThroughType<React.HTMLAttributes<HTMLTableCellElement>>;
+    /**
+     * Uses to pass attributes to the rowgroup toggler's DOM element.
+     */
+    rowGroupToggler?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the rowgroup toggler icon's DOM element.
+     */
+    rowGroupTogglerIcon?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the column title's DOM element.
+     */
+    columnTitle?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the rowtoggler's DOM element.
+     */
+    rowToggler?: ColumnPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
+    /**
+     * Uses to pass attributes to the rowtoggler icon's DOM element.
+     */
+    rowTogglerIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row editor init button's DOM element.
+     */
+    rowEditorInitButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the row editor init icon's DOM element.
+     */
+    rowEditorInitIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row editor edit button's DOM element.
+     */
+    rowEditorEditButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the row editor edit icon's DOM element.
+     */
+    rowEditorEditIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row editor save button's DOM element.
+     */
+    rowEditorSaveButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the row editor save icon's DOM element.
+     */
+    rowEditorSaveIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row editor cancel button's DOM element.
+     */
+    rowEditorCancelButton?: ColumnPassThroughType<React.HTMLAttributes<HTMLButtonElement>>;
+    /**
+     * Uses to pass attributes to the row editor cancel icon's DOM element.
+     */
+    rowEditorCancelIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row reorder icon's DOM element.
+     */
+    rowReorderIcon?: ColumnPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
+    /**
+     * Uses to pass attributes to the row radiobutton component.
+     */
+    rowRadioButton?: RadioButtonPassThroughOptions;
+    /**
+     * Uses to pass attributes to the row checkbox component.
+     */
+    rowCheckbox?: CheckboxPassThroughOptions;
+    /**
+     * Used to manage all lifecycle hooks
+     * @see {@link ComponentHooks}
+     */
+    hooks?: ComponentHooks;
+}
+
+interface ColumnHeaderOptions {
+    /**
+     * Additional properties passed to the body component.
+     */
+    props: any;
+}
+
+/**
+ * Column Header Options
+ * @extends {ColumnHeaderOptions}
+ */
+interface ColumnFooterOptions extends ColumnHeaderOptions {}
+
+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;
+}
+
+interface ColumnBodyExpanderOptions {
+    /**
+     * 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;
+}
+
+interface ColumnBodyRowEditorOptions {
+    /**
+     * Whether row is in editing mode.
+     */
+    editing?: boolean;
+    /**
+     * Custom JSX element for the options.
+     */
+    element?: JSX.Element;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+}
+
+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;
+    /**
+     * Callback function triggered on editor change.
+     * @param {*} value - Browser event
+     */
+    editorCallback?(value: any): void;
+}
+
+interface ColumnFilterModelOptions {
+    /**
+     * Object containing key-value pairs of column filter metadata or metadata with constraint.
+     */
+    [key: string]: ColumnFilterMetaData | ColumnFilterMetaDataWithConstraint;
+}
+
+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;
+}
+
+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 {}
+
+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;
+}
+
+/**
+ * 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;
+}
+
+interface ColumnSortMetaData {
+    /**
+     * Field name of the column.
+     */
+    field: string;
+    /**
+     * Sort order of the column.
+     */
+    order: 1 | 0 | -1 | undefined | null;
+}
+
+/**
+ * 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[];
+}
+
+interface ColumnFilterMetaData {
+    /**
+     * Value of the filter.
+     */
+    value: any;
+    /**
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
+     */
+    matchMode: FilterMatchMode | string;
+}
+
+interface ColumnFilterMetaDataWithConstraint {
+    /**
+     * Logical operator for the constraints.
+     */
+    operator: 'and' | 'or';
+    /**
+     * Array of ColumnFilterMetaData objects representing the constraints.
+     */
+    constraints: ColumnFilterMetaData[];
+}
+
+/**
+ * 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[];
+}
+
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterMatchModeChange}
+ * @event
+ */
+interface ColumnFilterMatchModeChangeEvent {
+    /**
+     * Field name of the column.
+     */
+    field: string;
+    /**
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
+     */
+    matchMode: FilterMatchMode | string;
+}
+
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterOperatorChange}
+ * @event
+ */
+interface ColumnFilterOperatorChangeEvent {
+    /**
+     * Field name of the column.
+     */
+    field: string;
+    /**
+     * Logical operator for the filter.
+     */
+    operator: 'and' | 'or';
+}
+
+/**
+ * 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;
+}
+
+/**
+ * Custom filter event.
+ * @see {@link ColumnProps.onFilterConstraintRemove}
+ * @extends {ColumnFilterConstraintAddEvent}
+ * @event
+ */
+interface ColumnFilterConstraintRemoveEvent extends ColumnFilterConstraintAddEvent {}
+
+interface ColumnFilterMeta {
+    /**
+     * Filter metadata for specific columns.
+     */
+    [key: string]: ColumnFilterMetaData;
+}
+
+/**
+ * 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;
+    };
+}
+
+interface ColumnFilterMatchModeOptions {
+    /**
+     * The label to display for the match mode
+     */
+    label: string;
+    /**
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
+     */
+    value: FilterMatchMode | string;
+}
+
+/**
+ * Defines valid properties in ColumnProps component.
+ * @group Properties
+ */
+export interface ColumnProps {
+    /**
+     * 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;
+    /**
+     * When enabled and cellEditorValidator is set, force to call cellEditorValidator
+     * before cell editor is closed. If cellEditorValidator returns false, editor stays open.
+     * @defaultValue false
+     */
+    cellEditValidateOnClose?: boolean | 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;
+    /**
+     * Uses to pass attributes to DOM elements inside the component.
+     * @type {ColumnPassThroughOptions}
+     */
+    pt?: ColumnPassThroughOptions;
+    /**
+     * Used to configure passthrough(pt) options of the component.
+     * @type {PassThroughOptions}
+     */
+    ptOptions?: PassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
+    /**
+     * 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;
+    /**
+     * Custom export header of the column to be exported.
+     */
+    exportHeader?: 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", "notIn", "lt", "lte", "gt", "gte" and "custom".
+     */
+    filterMatchMode?: FilterMatchMode | string | undefined;
+    /**
+     * An array of label-value pairs to override the global match mode options.
+     */
+    filterMatchModeOptions?: ColumnFilterMatchModeOptions[];
+    /**
+     * 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 | ((data: any, options: ColumnBodyOptions) => boolean);
+    /**
+     * Whether this column displays an icon to reorder the rows.
+     * @defaultValue false
+     */
+    rowReorder?: boolean | undefined;
+    /**
+     * Icon of the drag handle to reorder rows.
+     */
+    rowReorderIcon?: IconType<ColumnProps> | 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. To prevent editor from showing return false or originalEvent.preventDefault().
+     * @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. To prevent editor from showing return false or originalEvent.preventDefault().
+     * @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;
+    /**
+     * 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**
+ *
+ * _Column is a helper component for DataTable and TreeTable._
+ *
+ * [Live Demo](https://www.primereact.org/column/)
+ * --- ---
+ * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
+export declare class Column extends React.Component<ColumnProps, any> {}