Boolean

This field is used to display boolean values. It uses the <Tooltip> values from Material 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.

http://localhost:3000

Live previews only work with the latest documentation.

import {
  useDataGrid,
  DataGrid,
  GridColumns,
  List,
  BooleanField,
} from '@pankod/refine-mui'

const columns: GridColumns = [
  { 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={<IconX />}
          falseIcon={<IconCheck />}
          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

External Props

It also accepts all props of Material UI Tooltip.