API Reference
Advanced Tutorials
Comparison
FAQ
Contributing
Testing
Migration Guide
Licence
This is documentation for Refine 3.xx.xx, which is no longer actively maintained.
For up-to-date documentation, see the latest version (4.xx.xx).
Version: 3.xx.xx
Swizzle Ready
Boolean
This field is used to display boolean values. It uses the <Tooltip>
values from Mantine.
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
Live previews only work with the latest documentation.
import { List, Table, Pagination, BooleanField } from "@pankod/refine-mantine";
import { useTable, ColumnDef, flexRender } from "@pankod/refine-react-table";
import { IconX, IconCheck } from "@tabler/icons";
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
External Props
It also accepts all props of Mantine Tooltip.
Was this helpful?