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 Mantine.
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, BooleanField } from "@refinedev/mantine";
import { Table, Pagination } from "@mantine/core";
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,
    refineCore: { setCurrent, pageCount, current },
  } = useTable({
    columns,
  });
  return (
    <List>
      <Table>
        <thead>
          {getHeaderGroups().map((headerGroup) => (
            <tr key={headerGroup.id}>
              {headerGroup.headers.map((header) => (
                <th key={header.id}>
                  {header.isPlaceholder
                    ? null
                    : 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>
      <br />
      <Pagination
        position="right"
        total={pageCount}
        page={current}
        onChange={setCurrent}
      />
    </List>
  );
};
interface IPost {
  id: number;
  title: string;
  status: "published" | "draft" | "rejected";
}
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 Mantine Tooltip.
Was this helpful?