@payfit/unity-components
Version:
30 lines (29 loc) • 1.82 kB
TypeScript
import { default as React, PropsWithChildren } from 'react';
import { VariantProps } from '@payfit/unity-themes';
export declare const tableHeader: import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, string[], {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, string[], unknown, unknown, undefined>>;
export type TableHeaderProps = PropsWithChildren<VariantProps<typeof tableHeader>>;
/**
* The `TableHeader` component renders the header section of a table, containing column headers.
* It automatically processes its children to add row indices and applies appropriate styling.
* @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>
* ```
* @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').TVReturnType<unknown, undefined, string[], unknown, unknown, undefined>>> & {
children?: React.ReactNode | undefined;
} & React.RefAttributes<HTMLTableSectionElement>>>;
export { TableHeader };