Skip to main content
Version: 4.xx.xx
Swizzle Ready

Boolean

This field is used to display boolean values. It uses the <Tooltip> values from Material 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
import {
useDataGrid,
List,
BooleanField,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";
import { Close, Check } from "@mui/icons-material";

const columns: GridColDef[] = [
{ field: "id", headerName: "ID", type: "number" },
{ field: "title", headerName: "Title", minWidth: 100, flex: 1 },
{
field: "status",
headerName: "Published",
renderCell: function render({ row }) {
return (
<BooleanField
value={row.status === "published"}
trueIcon={<Check />}
falseIcon={<Close />}
valueLabelTrue="published"
valueLabelFalse="unpublished"
/>
);
},
align: "center",
headerAlign: "center",
minWidth: 100,
flex: 1,
},
];

const PostsList: React.FC = () => {
const { dataGridProps } = useDataGrid<IPost>();

return (
<List>
<DataGrid {...dataGridProps} columns={columns} autoHeight />
</List>
);
};

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

API Reference

Properties

PropertyTypeDescriptionDefault
value

unknown

The value of the field.

title

NonNullable<ReactNode>

The text shown in the tooltip

value ? valueLabelTrue : valueLabelFalse

svgIconProps

SvgIconProps

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:

It also accepts all props of Material UI Tooltip.