UNPKG

@payfit/unity-components

Version:

45 lines (44 loc) 2.28 kB
import { default as React, PropsWithChildren, ReactNode } from 'react'; import { VariantProps } from '@payfit/unity-themes'; export declare const tableHeader: import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, string[], {} | {}, undefined, import('tailwind-variants').TVReturnTypeLike<unknown, undefined>>; export type TableHeaderProps = PropsWithChildren<VariantProps<typeof tableHeader>>; /** * The `TableHeader` component renders the header section of a table, containing column headers. * It accepts column headers directly for a single row, or explicit `tr` elements for grouped headers. * It automatically assigns row and column indices while preserving indices set by consumers. * @param {TableHeaderProps} props - The props for the `TableHeader` component * @param {ReactNode} props.children - The column headers to render (typically TableColumnHeader components) * @example * ```tsx * import { TableHeader, TableColumnHeader } from '@payfit/unity-components' * * <TableHeader> * <TableColumnHeader>Name</TableColumnHeader> * <TableColumnHeader>Email</TableColumnHeader> * <TableColumnHeader>Department</TableColumnHeader> * </TableHeader> * ``` * @example * ```tsx * // Grouped column headers * <TableHeader> * <tr> * <TableColumnHeader scope="col" rowSpan={2}>Employee</TableColumnHeader> * <TableColumnHeader scope="colgroup" colSpan={2}>Contact</TableColumnHeader> * </tr> * <tr> * <TableColumnHeader scope="col">Email</TableColumnHeader> * <TableColumnHeader scope="col">Phone</TableColumnHeader> * </tr> * </TableHeader> * ``` * @see {@link TableHeaderProps} for all available props * @see {@link TableColumnHeader} for the column header component * @remarks * {@link https://unity-components.payfit.io/?path=/story/data-table-tableheader--docs|API and Demos} • * {@link https://payfit.design|Design docs} */ declare const TableHeader: React.MemoExoticComponent<React.ForwardRefExoticComponent<VariantProps<import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, string[], {} | {}, undefined, import('tailwind-variants').TVReturnTypeLike<unknown, undefined>>> & { children?: ReactNode | undefined; } & React.RefAttributes<HTMLTableSectionElement>>>; export { TableHeader };