Boolean

This field is used to display boolean values. It uses the <Tooltip> values from Ant Design.

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,
  useTable,
  BooleanField,
} from "@refinedev/antd";
import { Table } from "antd";

const PostList: React.FC = () => {
  const { tableProps } = useTable<IPost>();

  const TrueIcon = () => <span>✅</span>;
  const FalseIcon = () => <span>❌</span>;

  return (
    <List>
      <Table {...tableProps} rowKey="id">
        <Table.Column dataIndex="id" title="ID" />
        <Table.Column dataIndex="title" title="Title" />
        <Table.Column
          dataIndex="status"
          title="Published"
          render={(value) => (
            <BooleanField
              value={value === "published"}
              trueIcon={<TrueIcon />}
              falseIcon={<FalseIcon />}
              valueLabelTrue="published"
              valueLabelFalse="unpublished"
            />
          )}
        />
      </Table>
    </List>
  );
};

interface IPost {
  id: number;
  title: string;
  status: "published" | "draft" | "rejected";
}

API Reference

Properties

Property	Type	Description	Default
value ﹡	`unknown`	The value of the field.
title	`NonNullable<ReactNode>`	The text shown in the tooltip	`value` ? `valueLabelTrue` : `valueLabelFalse`
valueLabelTrue	`string`	If there is a value, this is the text to use.	`true`
valueLabelFalse	`string`	If there no value, this is the text to use.	`false`
trueIcon	`ReactNode`	If there is a value, this is the icon to use.	`<CheckOutlined />`
falseIcon	`ReactNode`	If there is no value, this is the icon to use.	`<CloseOutlined />`

External Props:

This field also accepts all props of Ant Design's Tooltip component.

Usage​

API Reference​

Properties​

Usage

API Reference

Properties