This is documentation for Refine 4.xx.xx, which is no longer actively maintained.
For up-to-date documentation, see the latest version (5.xx.xx).
Version: 4.xx.xx
Swizzle Ready
List
<List> provides us a layout to display the page. It does not contain any logic and just adds extra functionalities like a create button or giving the page titles.
We will show what <List> does using properties with examples.
localhost:3000/posts
Live previews only work with the latest documentation.
title allows the addition of titles inside the <List> component. If you don't pass title props it uses the plural resource name by default. For example, for the /posts resource, it will be "Posts".
localhost:3000/posts
Live previews only work with the latest documentation.
import{List}from"@refinedev/mui"; import{Typography}from"@mui/material"; constListPage:React.FC=()=>{ return( <List title={<Typographyvariant="h5">Custom Title</Typography>} > <span>Rest of your page here</span> </List> ); };
The <List> component reads the resource information from the route by default. If you want to use a custom resource for the <List> component, you can use the resource prop.
localhost:3000/custom
Live previews only work with the latest documentation.
import{List}from"@refinedev/mui"; constCustomPage:React.FC=()=>{ return( <Listresource="posts"> <span>Rest of your page here</span> </List> ); };
If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.
canCreate allows us to add the create button inside the <List> component. If resource is passed a create component, Refine adds the create button by default. If you want to customize this button you can use createButtonProps property like the code below.
Create button redirects to the create page of the resource according to the value it reads from the URL.
localhost:3000/posts
Live previews only work with the latest documentation.
By default, the <List/> component has a <CreateButton> at the header.
You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, createButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.
If "create" resource is not defined or canCreate is false, the <CreateButton> will not render and createButtonProps will be undefined.
localhost:3000/posts
Live previews only work with the latest documentation.
Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use createButtonProps to utilize the default values of the <CreateButton> component.
localhost:3000/posts
Live previews only work with the latest documentation.