List
<ListButton>
is uses Mantine'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 resource definition.
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 →
hideText
hideText
is used to show and not show 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/mantine";
export const MyListComponent = () => {
return (
<ListButton accessControl={{ enabled: true, hideIfUnauthorized: true }} />
);
};
resourceNameOrRouteName deprecated
Use resource
prop instead.
API Reference
Properties
Property | Type | Description | Default |
---|---|---|---|
hideText |
| Whether should hide the text and show only the icon or not. |
|
resourceNameOrRouteName Please use |
| Resource name for API data interactions | Reads |
resource |
| Resource name for API data interactions. | Inferred resource name from the route |
accessControl |
| Access Control configuration for the button |
|
onClick |
| Sets the handler to handle click event | |
meta |
|
| |
hidden |
| ||
svgIconProps |
|