Skip to main content
Version: 3.xx.xxSwizzle Ready

Boolean

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

Swizzle

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.

http://localhost:3000
import {
List,
Table,
useTable,
BooleanField,
Icons
} from "@pankod/refine-antd";

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

const { CloseCircleOutlined, CheckCircleOutlined } = Icons;

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

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

API Reference​

Properties​

External Props

It also accepts all props of Ant Design Tooltip.