List
<ListButton>
is using Material UI's <Button>
component. It uses the list
method from useNavigation
under the hood. It can be useful when redirecting the app to the list page route of resource.
You can swizzle this component with the refine CLI to customize it.
Usage
The button text is defined automatically by refine based on the resource object name property.
Properties
resource
Redirection endpoint is defined by the resource
's list
action path. By default, <ListButton>
uses the inferred resource from the route.
Clicking the button will trigger the list
method of useNavigation
and then redirect the app to the list
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 list
method of useNavigation
. By default, existing parameters in the route are used by the list
method. You can pass additional parameters or override the existing ones using the meta
prop.
If the list
action route is defined by the pattern: /:authorId/posts
, the meta
prop can be used as follows:
const MyComponent = () => {
return (
<ListButton meta={{ authorId: "10" }} />
);
};
hideText
hideText
is used to show and hide the text of the button. When true
, only the button icon is visible.
accessControl
This prop can be used to skip 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 { ListButton } from "@refinedev/mui";
export const MyListComponent = () => {
return (
<ListButton
accessControl={{ enabled: true, hideIfUnauthorized: true }}
/>
);
};
resourceNameOrRouteName
deprecated
resourceNameOrRouteName
resourceNameOrRouteName
prop is deprecated. Useresource
prop instead.
Redirection endpoint(resourceNameOrRouteName/list
) is defined by resourceNameOrRouteName
property. By default, <ListButton>
uses name
property of the resource object as the endpoint to redirect after clicking.
Clicking the button will trigger the list
method of useNavigation
and then redirect to /categories
.
API Reference
Properties
It also accepts all props of Material UI Button.