Skip to main content
RefineDocumentation
Version: 5.xx.xx
Source Code

List

<ListButton> uses shadcn/ui's <Button> component and the list method from useNavigation under the hood.

It can be useful when redirecting the app to the list page of the resource.

Installation​

npx shadcn@latest add https://ui.refine.dev/r/buttons.json

This will add all button components including ListButton.

Usage​

import { ListButton } from "@/components/refine-ui/buttons/list";
import { Show } from "@/components/refine-ui/views/show";

const PostShow = () => {
  return (
    <Show>
      <div className="flex justify-between items-center mb-4">
        <h1>Post Details</h1>
        <ListButton resource="posts" />
      </div>
      {/* Your show content */}
    </Show>
  );
};

Properties​

resource​

resource is used to redirect the app to the list action of the given resource name. By default, the app redirects to the inferred resource's list action path.

import { ListButton } from "@/components/refine-ui/buttons/list";

const MyComponent = () => {
  return <ListButton resource="categories" />;
};

Clicking the button will trigger the list method of useNavigation and then redirect the app to the list action path of the resource.

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: /posts/:authorId, the meta prop can be used as follows:

const MyComponent = () => {
  return <ListButton 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.

import { ListButton } from "@/components/refine-ui/buttons/list";

const MyComponent = () => {
  return <ListButton hideText={true} />;
};

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 "@/components/refine-ui/buttons/list";

const MyComponent = () => {
  return (
    <ListButton
      accessControl={{
        enabled: true,
        hideIfUnauthorized: true,
      }}
    />
  );
};

children​

It is used to change the text of the button. By default, the text is "List".

import { ListButton } from "@/components/refine-ui/buttons/list";

const MyComponent = () => {
  return <ListButton>View All Posts</ListButton>;
};

API Reference​

Properties​

PropertyTypeDefaultDescription
resourcestringInferred from routeThe resource name or identifier
metaRecord<string, unknown>-Additional metadata to pass to the list method
hideTextbooleanfalseIf true, only the icon will be shown
accessControl{ enabled?: boolean; hideIfUnauthorized?: boolean }{ enabled: true, hideIfUnauthorized: false }Configures access control behavior
childrenReactNodeDefault text & iconCustom content for the button
...restReact.ComponentProps<typeof Button>-Other props are passed to the underlying shadcn/ui Button component (e.g., variant, size, className, onClick)
External Props

It also accepts all props of shadcn/ui Button.

Previous
Edit
Next
Refresh