Skip to main content
Refine AI
Version: 3.xx.xx
Swizzle Ready

Boolean

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

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.

localhost:3000/posts
Live previews only work with the latest documentation.
import {
List,
DateField,
TableContainer,
Table,
Thead,
Tr,
Th,
Tbody,
Td,
BooleanField,
} from "@pankod/refine-chakra-ui";
import { useTable, ColumnDef, flexRender } from "@pankod/refine-react-table";

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>
);
};

API Reference

Properties

External Props

It also accepts all props of Chakra UI Tooltip.