Refine AI
This is documentation for Refine 4.xx.xx, which is no longer actively maintained.
For up-to-date documentation, see the latest version (5.xx.xx).
Version: 4.xx.xx
Swizzle Ready
Boolean
This field is used to display boolean values. It uses the <Tooltip> values from Chakra UI.
Good to know:
You can swizzle this component to customize it with the Refine CLI
Usage
Let's see how we can use <BooleanField> with the example in the post list.
localhost:3000/posts
Live previews only work with the latest documentation.
import {
  List,
  DateField,
  BooleanField,
} 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";
import { IconX, IconCheck } from "@tabler/icons-react";
const PostList: React.FC = () => {
  const columns = React.useMemo<ColumnDef<IPost>[]>(
    () => [
      {
        id: "id",
        header: "ID",
        accessorKey: "id",
      },
      {
        id: "title",
        header: "Title",
        accessorKey: "title",
      },
      {
        id: "status",
        header: "Status",
        accessorKey: "status",
        cell: function render({ getValue }) {
          return (
            <BooleanField
              value={getValue() === "published"}
              trueIcon={<IconCheck />}
              falseIcon={<IconX />}
              valueLabelTrue="published"
              valueLabelFalse="unpublished"
            />
          );
        },
      },
    ],
    [],
  );
  const { getHeaderGroups, getRowModel } = useTable({
    columns,
  });
  return (
    <List>
      <TableContainer>
        <Table variant="simple" whiteSpace="pre-line">
          <Thead>
            {getHeaderGroups().map((headerGroup) => (
              <Tr key={headerGroup.id}>
                {headerGroup.headers.map((header) => {
                  return (
                    <Th key={header.id}>
                      {!header.isPlaceholder &&
                        flexRender(
                          header.column.columnDef.header,
                          header.getContext(),
                        )}
                    </Th>
                  );
                })}
              </Tr>
            ))}
          </Thead>
          <Tbody>
            {getRowModel().rows.map((row) => {
              return (
                <Tr key={row.id}>
                  {row.getVisibleCells().map((cell) => {
                    return (
                      <Td key={cell.id}>
                        {flexRender(
                          cell.column.columnDef.cell,
                          cell.getContext(),
                        )}
                      </Td>
                    );
                  })}
                </Tr>
              );
            })}
          </Tbody>
        </Table>
      </TableContainer>
    </List>
  );
};
Was this helpful?
API Reference
Properties
| Property | Type | Description | Default | 
|---|---|---|---|
value ﹡  |  | The value of the field.  | |
title  |  | The text shown in the tooltip  | 
  | 
svgIconProps  |  | ||
valueLabelTrue  |  | If there is a value, this is the text to use.  |  | 
valueLabelFalse  |  | If there no value, this is the text to use.  |  | 
trueIcon  |  | If there is a value, this is the icon to use.  | |
falseIcon  |  | If there is no value, this is the icon to use.  | 
External Props:
It also accepts all props of Chakra UI Tooltip.
Was this helpful?