Skip to content
Edit this page

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:

Import

import Table from '@mui/joy/Table';
// or
import { Table } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

borderAxis

The axis to display a border on the table cell.

Type:

'both' | 'bothBetween' | 'none' | 'x' | 'xBetween' | 'y' | 'yBetween' | string

Default:

'xBetween'
children

Children of the table

Type:

node
color

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
hoverRow

If true, the table row will shade on hover.

Type:

bool

Default:

false
noWrap

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.

Type:

bool

Default:

false
size

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.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}
slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ root?: elementType }

Default:

{}
stickyFooter

If true, the footer always appear at the bottom of the overflow table.
⚠️ It doesn't work with IE11.

Type:

bool

Default:

false
stickyHeader

If true, the header always appear at the top of the overflow table.
⚠️ It doesn't work with IE11.

Type:

bool

Default:

false
stripe

The odd or even row of the table body will have subtle background color.

Type:

'odd' | 'even' | string
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'plain'
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.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Default: 'table'

Global class: .MuiTable-root

You can override the style of the component using one of these customization options:

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiTable-borderAxisBoth

Class name applied to the root element if borderAxis="both".

.MuiTable-borderAxisBothBetween

Class name applied to the root element if borderAxis="bothBetween".

.MuiTable-borderAxisNone

Class name applied to the root element if borderAxis="none".

.MuiTable-borderAxisX

Class name applied to the root element if borderAxis="x".

.MuiTable-borderAxisXBetween

Class name applied to the root element if borderAxis="xBetween".

.MuiTable-borderAxisY

Class name applied to the root element if borderAxis="y".

.MuiTable-borderAxisYBetween

Class name applied to the root element if borderAxis="yBetween".

.MuiTable-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiTable-colorDanger

Class name applied to the root element if color="danger".

.MuiTable-colorNeutral

Class name applied to the root element if color="neutral".

.MuiTable-colorPrimary

Class name applied to the root element if color="primary".

.MuiTable-colorSuccess

Class name applied to the root element if color="success".

.MuiTable-colorWarning

Class name applied to the root element if color="warning".

.MuiTable-hoverRow

Class name applied to the root element if hoverRow is true.

.MuiTable-noWrap

Class name applied to the root element if noWrap is true.

.MuiTable-sizeLg

Class name applied to the root element if size="lg".

.MuiTable-sizeMd

Class name applied to the root element if size="md".

.MuiTable-sizeSm

Class name applied to the root element if size="sm".

.MuiTable-stickyFooter

Class name applied to the root element if stickyFooter is true.

.MuiTable-stickyHeader

Class name applied to the root element if stickyHeader is true.

.MuiTable-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiTable-variantPlain

Class name applied to the root element if variant="plain".

.MuiTable-variantSoft

Class name applied to the root element if variant="soft".

.MuiTable-variantSolid

Class name applied to the root element if variant="solid".