Skip to main content
Refine AI
RefineDocumentation
Version: 3.xx.xx
Swizzle Ready

List

<ListButton> is using Material UI <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.

Swizzle

You can swizzle this component to customize it with the refine CLI

Usage​

localhost:3000/posts
Live previews only work with the latest documentation.
import { useShow } from "@pankod/refine-core";
import { ListButton, Show, Typography, Stack } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
  const { queryResult } = useShow<IPost>();
  const { data, isLoading } = queryResult;
  const record = data?.data;

  return (
    <Show
      isLoading={isLoading}
      headerButtons={
        <ListButton />
      }
    >
      <Stack gap="10px">
        <Typography fontWeight="bold">Id</Typography>
        <Typography>{record?.id}</Typography>
        <Typography fontWeight="bold">Title</Typography>
        <Typography>{record?.title}</Typography>
      </Stack>
    </Show>
  );
};

interface IPost {
  id: number;
  title: string;
}
NOTE

The button text is defined automatically by refine based on resource object name property.

Properties​

resourceNameOrRouteName​

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.

localhost:3000
Live previews only work with the latest documentation.
import { ListButton } from "@pankod/refine-mui";

const MyListComponent = () => {
  return <ListButton resourceNameOrRouteName="categories" recordItemId="2" />;
};

Clicking the button will trigger the list method of useNavigation and then redirect to /categories.

hideText​

It is used to show and not show the text of the button. When true, only the button icon is visible.

localhost:3000
Live previews only work with the latest documentation.
import { ListButton } from "@pankod/refine-mui";

const MyListComponent = () => {
  return (
    <ListButton
      resourceNameOrRouteName="posts"
      hideText
    />
  );
};

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 "@pankod/refine-mui";

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

API Reference​

Properties​

External Props

It also accepts all props of Material UI Button.

Previous
Import
Next
Refresh