Skip to main content
RefineDocumentation
Version: 5.xx.xx
Swizzle Ready

List

<ListButton> 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.

Good to know:

You can swizzle this component with the Refine CLI to customize it.

Usage​

localhost:3000/posts/show/123
import { useShow } from "@refinedev/core";
import {
  Show,
  MarkdownField,
  ListButton,
} from "@refinedev/mantine";
import { Title, Text } from "@mantine/core";

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

  return (
    <Show headerButtons={<ListButton />} isLoading={isLoading}>
      <Title order={5}>Id</Title>
      <Text mt="sm">{record?.id}</Text>

      <Title mt="sm" order={5}>
        Title
      </Title>
      <Text mt="sm">{record?.title}</Text>

      <Title mt="sm" order={5}>
        Content
      </Title>
      <MarkdownField value={record?.content} />
    </Show>
  );
};

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

Properties​

resource​

Redirection endpoint is defined by the resource's list action path. By default, <ListButton> uses the inferred resource from the route.

localhost:3000
import { ListButton } from "@refinedev/mantine";

const MyListComponent = () => {
  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, 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.

localhost:3000
import { ListButton } from "@refinedev/mantine";

const MyListComponent = () => {
  return <ListButton 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 "@refinedev/mantine";

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

API Reference​

Properties​

PropertyTypeDescriptionDefault
hideText

boolean

Whether should hide the text and show only the icon or not.

false

resource

string

Resource name for API data interactions. identifier of the resource can be used instead of the name of the resource.

Inferred resource name from the route

accessControl

{ enabled?: boolean; hideIfUnauthorized?: boolean; }

undefined

Access Control configuration for the button

{ enabled: true }

onClick

PointerEventHandler<HTMLButtonElement>

Sets the handler to handle click event

meta

Record<string, unknown>

meta property is used when creating the URL for the related action and path.

hidden

boolean

svgIconProps

Omit<IconProps, "ref">

Previous
Import
Next
Refresh