Here is a brief overview of how to use Mantine React Table. This is a very simple example and will not cover all features of the library, but should be a great starting point.
To start using MantineReactTable, you first need to install
mantine-react-table and the necessary Mantine dependencies.
There are additional steps and customizations you can do with your Mantine Theme, if you have not set it up in your application already. Check out the Mantine docs for more information.
Import MantineReactTable and useMantineReactTable
Once you have everything installed, you can import from
mantine-react-table like this:
MantineReactTable is the main component that you will use to render your table.
useMantineReactTable is the React hook that you will use to define all the columns, data, and other options for your table.
Your data must be an array of objects that have properties matching the accessors in your column definitions. The objects themselves can theoretically be in any shape, but it will be easier to set up your columns if your data is already in a flat object format like the example below, but it is not required.
Common Gotcha: When defining
datathat will be passed to a
useMantineReactTablehook, make sure that the
datais memoized or stable (i.e.
useMemo, defined outside of your table component, etc.). Otherwise you may get infinite renders.
Simple Data Example
Your data does NOT have to be created statically like this, of course. More than likely, your data is being fetched from a backend API. Check out the Remote Data examples to see how you can fetch data and pass it to your tables.
There are several different ways to define columns, depending on your needs. Let's create some basic
"data" columns. That is, columns that connect to our data. Most of the time, we can simply use the
accessorKey property to access the data if the data is in a simple format. Alternatively, if some data in a column needs some logic or processing, you can use the
accessorFn property to define a function that returns the data for each cell.
Simple Column Definition Example
Note: Do NOT have your accessors resolve JSX or markup. That's what custom
Cellrenders are for. Accessors should only return primitive data so that the table can sort, filter, search, and group properly.
Full Simple Example
Put it all together, and you have a basic table! You can also play around and enable some features, either per column in the column definitions, or as table options passed to
Note: Again, it is very important that the columns and data definitions are memoized or stable. Otherwise, the entire table will be re-rendered during every react re-render in your application, which can lead to performance issues. To make a variable stable, store it in
useState, wrap it in
useMemo, define it outside of a component, or in your state management tool of choice so it does not get recreated on every render and cause an infinite re-render loop.
Live Code Sandbox Example
There are numerous ways you can customize the behavior and look and feel of your Mantine React Table. View some of the examples to see how you can customize your table, and visit the props page to see all the props that you can use to turn features on and off and customize the look and feel of your table.
Also, be sure to check out all the Fundamental Guides and any of the Advanced Feature Guides you may be interested in to learn more about the different features you can toggle on and off, or customize.