gestalt/dist/TableSortableHeaderCell.d.ts

A set of React UI components which enforce Pinterest's design language

import { ReactNode } from 'react';
type Props = {
    /**
     * Sets the alignment of the cell content and reverses the sort icon position.
     */
    align?: 'start' | 'end';
    /**
     * The content of the table cell.
     */
    children: ReactNode;
    /**
     * `colSpan` defines the number of columns a cell should span.
     */
    colSpan?: number;
    /**
     * Callback fired when the sort button component is clicked.
     */
    onSortChange: (arg1: {
        event: React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>;
    }) => void;
    /**
     * Private prop required for sticky columns
     */
    previousTotalWidth?: number;
    /**
     * `rowSpan` defines the number of rows a cell should span.
     */
    rowSpan?: number;
    /**
     * The scope attribute specifies whether a header cell is a header for a column, row, or group of columns or rows. The scope attribute has no visual effect in ordinary web browsers, but can be used by screen readers.
     */
    scope?: 'col' | 'colgroup' | 'row' | 'rowgroup';
    /**
     * Private prop required for sticky columns
     */
    shouldBeSticky?: boolean;
    /**
     * Private prop required for sticky columns
     */
    shouldHaveShadow?: boolean;
    /**
     * Sets the sorting direction: `sortOrder="asc"` is ascending (A to Z) and `sortOrder="desc"` is descending (Z to A):
     */
    sortOrder: 'asc' | 'desc';
    /**
     * Disables the sorting functionality for a column.
     */
    status: 'active' | 'inactive';
};
/**
 * Use [Table.SortableHeaderCell](https://gestalt.pinterest.systems/web/table#Table.SortableHeaderCell) to define a header cell with sorting functionality in Table.
 */
declare function TableSortableHeaderCell({ align, children, colSpan, onSortChange, previousTotalWidth, rowSpan, scope, shouldBeSticky, shouldHaveShadow, status, sortOrder, }: Props): import("react/jsx-runtime").JSX.Element;
declare namespace TableSortableHeaderCell {
    var displayName: string;
}
export default TableSortableHeaderCell;