Table API

API reference docs for the React Table component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Table

Import

import Table from '@mui/joy/Table';
// or
import { Table } from '@mui/joy';

You can learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
borderAxis	'both' \| 'bothBetween' \| 'none' \| 'x' \| 'xBetween' \| 'y' \| 'yBetween' \| string	'xBetween'	The axis to display a border on the table cell.
children	node		Children of the table
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
hoverRow	bool	false	If `true`, the table row will shade on hover.
noWrap	bool	false	If `true`, the body cells will not wrap, but instead will truncate with a text overflow ellipsis. Note: Header cells are always truncated with overflow ellipsis.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
stickyHeader	bool	false	Set the header sticky. ⚠️ It doesn't work with IE11.
stripe	'odd' \| 'even' \| string		The odd or even row of the table body will have subtle background color.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'plain'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyTable to change the default props of this component with the theme.