Tag

This field lets you display a value in a tag. It uses Material UI <Chip> component.

Swizzle

You can swizzle this component to customize it with the refine CLI

Usage

Let's see how we can use it in a basic list page:

http://localhost:3000

Live previews only work with the latest documentation.

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

const columns: GridColumns = [
  { field: 'id', headerName: 'ID', type: 'number' },
  { field: 'title', headerName: 'Title', minWidth: 100, flex: 1 },
  {
    field: 'status',
    headerName: 'Status',
    renderCell: function render({ row }) {
      return <TagField value={row.status} />
    },
    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 Chip.