DocsGuides

Guides

Sticky Header/Footer Guide

How to use and customize the sticky header feature in Shadcn Table

The sticky header and footer feature allows you to keep the header and footer of the table visible while scrolling through the table. This is useful when you have a large table and want to keep the header and footer visible at all times.

Relevant Table Options

#
Prop Name
Type
Default Value
More Info Links
1boolean
2boolean

Enable Sticky Header

Enabling the sticky header is as simple as setting the enableStickyHeader table option to true. This will make the header of the table stick to the top and remain visible while scrolling through the table.

When the sticky header is enabled, you will probably also want to give the table a maxHeight so that the table can scroll vertically and keep the header visible. You can do this by styling the table container with the stTableContainerProps table option.

If no maxHeight is specified, the table container will default to a 100vh maxHeight when enableStickyHeader is enabled.

<ShadcnTable
  columns={columns}
  data={data}
  enableStickyHeader
  stTableContainerProps={{ style: { maxHeight: '500px' } }}
/>

Similarly, enabling the sticky footer is as simple as setting the enableStickyFooter table option to true. This will make the footer of the table stick to the bottom of the table and always be visible, even before the table is scrolled to the bottom.

<ShadcnTable columns={columns} data={data} enableStickyFooter />
Loading example

View Extra Storybook Examples

On this page