<Show> provides us a layout for displaying the page. It does not contain any logic and just adds extra functionalities like a refresh button or giving title to the page.
We will show what <Show> does using properties with examples.
title allows the addition of titles inside the <Show> component. If you don't pass title props it uses the "Show" prefix and the singular resource name by default. For example, for the "posts" resource, it will be "Show post".
localhost:3000/posts/show/123
import{Show}from"@refinedev/chakra-ui"; import{Heading}from"@chakra-ui/react"; constPostShow:React.FC=()=>{ return( <Showtitle={<Headingsize="lg">Custom Title</Heading>}> <p>Rest of your page here</p> </Show> ); };
The <Show> component reads the resource information from the route by default. If you want to use a custom resource for the <Show> component, you can use the resource prop.
localhost:3000/custom/123
import{Show}from"@refinedev/chakra-ui"; constCustomPage:React.FC=()=>{ return( <Showresource="categories"> <p>Rest of your page here</p> </Show> ); };
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.
canDelete and canEdit allows us to add the delete and edit buttons inside the <Show> component. If the resource has canDelete or canEdit property refine adds the buttons by default.
When clicked on, delete button executes the useDelete method provided by the dataProvider and the edit button redirects the user to the record edit page.
<Show> component reads the id information from the route by default. recordItemId is used when it cannot read from the URL (when used on a custom page, modal or drawer).
If not specified, refine will use the default data provider. If you have multiple data providers and want to use a different one, you can use the dataProviderName property.
To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @refinedev/chakra-ui package.
TIP
This feature can be managed globally via the <Refine> component's options
If you want to customize the wrapper of the <Show/> component, you can use the wrapperProps property. For @refinedev/chakra-ui wrapper element is <Box>s and wrapperProps can get every attribute that <Card> can get.
localhost:3000/posts/show/123
import{Show}from"@refinedev/chakra-ui"; constPostShow:React.FC=()=>{ return( <Show wrapperProps={{ borderColor:"blue", borderStyle:"dashed", borderWidth:"2px", p:"2", }} > <p>Rest of your page here</p> </Show> ); };
You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, deleteButtonProps, editButtonProps, listButtonProps, refreshButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.
CAUTION
If the "list" resource is not defined, the <ListButton> will not render and listButtonProps will be undefined.
If canDelete is false, the <DeleteButton> will not render and deleteButtonProps will be undefined.
If canEdit is false, <EditButton> will not render and editButtonProps will be undefined.
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 <ListButton>, <EditButton>, <DeleteButton>, and, <RefreshButton> components.
You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.