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

Show

<ShowButton> uses Chakra UI's <Button> component. It uses the show method from useNavigation under the hood. It can be useful when redirecting the app to the show page with the record id route of resource.

Good to know:

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

Usage​

localhost:3000
import {
  List,
  ShowButton,
} from "@refinedev/chakra-ui";
import {
  TableContainer,
  Table,
  Thead,
  Tr,
  Th,
  Tbody,
  Td,
} from "@chakra-ui/react";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";

const PostList: React.FC = () => {
  const columns = React.useMemo<ColumnDef<IPost>[]>(
    () => [
      {
        id: "id",
        header: "ID",
        accessorKey: "id",
      },
      {
        id: "title",
        header: "Title",
        accessorKey: "title",
      },
      {
        id: "actions",
        header: "Actions",
        accessorKey: "id",
        cell: function render({ getValue }) {
          return (
            <ShowButton
              colorScheme="black"
              recordItemId={getValue() as number}
            />
          );
        },
      },
    ],
    [],
  );

  const { getHeaderGroups, getRowModel } = useTable({
    columns,
  });

  return (
    <List>
      <TableContainer whiteSpace="pre-line">
        <Table variant="simple">
          <Thead>
            {getHeaderGroups().map((headerGroup) => (
              <Tr key={headerGroup.id}>
                {headerGroup.headers.map((header) => (
                  <Th key={header.id}>
                    {!header.isPlaceholder &&
                      flexRender(
                        header.column.columnDef.header,
                        header.getContext(),
                      )}
                  </Th>
                ))}
              </Tr>
            ))}
          </Thead>
          <Tbody>
            {getRowModel().rows.map((row) => (
              <Tr key={row.id}>
                {row.getVisibleCells().map((cell) => (
                  <Td key={cell.id}>
                    {flexRender(cell.column.columnDef.cell, cell.getContext())}
                  </Td>
                ))}
              </Tr>
            ))}
          </Tbody>
        </Table>
      </TableContainer>
    </List>
  );
};

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

Properties​

recordItemId​

recordItemId is used to append the record id to the end of the route path. By default it will read the id information from the route.

localhost:3000
import { ShowButton } from "@refinedev/chakra-ui";

const MyShowComponent = () => {
  return <ShowButton colorScheme="black" recordItemId="123" />;
};

Clicking the button will trigger the show method of useNavigation and then redirect the app to the show action path of the resource, filling the necessary parameters in the route.

resource​

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

localhost:3000
import { ShowButton } from "@refinedev/chakra-ui";

const MyShowComponent = () => {
  return (
    <ShowButton colorScheme="black" resource="categories" recordItemId="2" />
  );
};

Clicking the button will trigger the show method of useNavigation and then redirect the app to the show 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 show method of useNavigation. By default, existing parameters in the route are used by the show method. You can pass additional parameters or override the existing ones using the meta prop.

If the show action route is defined by the pattern: /posts/:authorId/show/:id, the meta prop can be used as follows:

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

localhost:3000
import { ShowButton } from "@refinedev/chakra-ui";

const MyShowComponent = () => {
  return <ShowButton colorScheme="black" hideText recordItemId="123" />;
};

accessControl​

The accessControl prop can be used to skip the 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 { ShowButton } from "@refinedev/chakra-ui";

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

API Reference​

Properties​

PropertyTypeDescriptionDefault
meta

Record<string, unknown>

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

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

onClick

(PointerEventHandler<HTMLButtonElement> & MouseEventHandler<HTMLButtonElement>)

Sets the handler to handle click event

hideText

boolean

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

false

accessControl

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

undefined

Access Control configuration for the button

{ enabled: true }

svgIconProps

Omit<IconProps, "ref">

recordItemId

BaseKey

Data item identifier for the actions with the API

Reads :id from the URL

External Props:

It also accepts all props of Chakra UI Button.

Previous
Save
Next
Boolean