Show
<ShowButton>
uses Chakra UI's <Button>
component. It uses the show
method from useNavigation
under the hood. It can be useful when redirecting the app to the show page with the record id route of resource.
You can swizzle this component to customize it with the refine CLI
Usage
Properties
recordItemId
recordItemId
is used to append the record id to the end of the route path.
Clicking the button will trigger the show
method of useNavigation
and then redirect the app to the show
action path of the resource, filling the necessary parameters in the route.
<ShowButton>
component reads the id information from the route by default.
resource
Redirection endpoint is defined by the resource
's show
action path. By default, <ShowButton>
uses the inferred resource from the route.
Clicking the button will trigger the show
method of useNavigation
and then redirect the app to the show
action path of the resource, filling the necessary parameters in the route.
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.
For more information, refer to the
identifier
section of the<Refine/>
component documentation →
meta
It is used to pass additional parameters to the show
method of useNavigation
. By default, existing parameters in the route are used by the show
method. You can pass additional parameters or override the existing ones using the meta
prop.
If the show
action route is defined by the pattern: /posts/:authorId/show/:id
, the meta
prop can be used as follows:
const MyComponent = () => {
return (
<ShowButton meta={{ authorId: "10" }} />
);
};
hideText
It is used to show and not show the text of the button. When true
, only the button icon is visible.
accessControl
The accessControl
prop can be used to skip the access control check with its enabled
property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized
property. This is relevant only when an accessControlProvider
is provided to <Refine/>
import { ShowButton } from "@refinedev/chakra-ui";
export const MyListComponent = () => {
return (
<ShowButton
accessControl={{ enabled: true, hideIfUnauthorized: true }}
/>
);
};
resourceNameOrRouteName
deprecated
resourceNameOrRouteName
resourceNameOrRouteName
prop is deprecated. Useresource
prop instead.
Redirection endpoint(resourceNameOrRouteName/show
) is defined by resourceNameOrRouteName
property. By default, <ShowButton>
uses name
property of the resource object as an endpoint to redirect after clicking.
Clicking the button will trigger the show
method of useNavigation
and then redirect the app to /categories/show/2
.