Table

A Table component is a structured UI element that organizes and displays data in rows and columns, making it easy to read and compare information. Tables can include features like sorting, filtering, pagination, and inline editing, allowing users to interact with the data efficiently. They are commonly used to present datasets, such as user information, product listings, or any structured content that benefits from a grid-like layout.

Demo

NameEmailRole
Alicealice@example.comAdmin
Bobbob@example.comUser
Charliecharlie@example.comEditor

Usage

import { NTable } from '@nayan-ui/react';
const CustomComponent = ({row, col, ...remaining}: any) => {
return <div className="text-accent">Oops</div>;
};
const Table = () => {
const columnDef = [
{ name: 'invoice', title: 'Invoice', className: 'w-[100px]' },
{ name: 'status', title: 'Status' },
{ name: 'method', title: 'Method' },
{ name: 'amount', title: 'Amount', className: 'text-right' },
{ name: 'custom', title: 'Custom', className: 'text-right', component: CustomComponent }
];
const data = [
{ invoice: '10001', status: 'Completed', method: 'Credit Card', amount: '$1000' },
{ invoice: '10002', status: 'In progress', method: 'Net Banking', amount: '$500' }
];
return <NTable className="bg-surface" caption="Invoice table" columnDef={columnDef} data={data} />;
};
export default Table;

Attributes

NameTypeDefaultDetails
classNamestring' 'You can customise by passing tailwind classes.
captionClassNamestring' 'You can customise by passing tailwind classes.
headerClassNamestring' 'You can customise by passing tailwind classes.
headerRowClassNamestring' 'You can customise by passing tailwind classes.
headerCellClassNamestring' 'You can customise by passing tailwind classes.
bodyClassNamestring' 'You can customise by passing tailwind classes.
bodyRowClassNamestring' 'You can customise by passing tailwind classes.
bodyCellClassNamestring' 'You can customise by passing tailwind classes.
captionstringOptionalCaption for the table.
columnsNTableColumn<T>[]RequiredArray of table columns.
dataT[]RequiredArray of table data.
tablePropsReact.TableHTMLAttributes<HTMLTableElement>OptionalProps for table element.
rowProps(row: T, rowIndex: number) => React.HTMLAttributes<HTMLTableRowElement>OptionalFunction to get row props.
cellProps(row: T, col: NTableColumn<T>, rowIndex: number, colIndex: number) => React.TdHTMLAttributes<HTMLTableCellElement>OptionalFunction to get cell props.