Tag

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

Good to know:

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:

localhost:3000/posts

Live previews only work with the latest documentation.

import {
  useDataGrid,
  List,
  TagField,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";

const columns: GridColDef[] = [
  { field: "id", headerName: "ID", type: "number" },
  { field: "title", headerName: "Title", minWidth: 100, flex: 1 },
  {
    field: "status",
    headerName: "Status",
    display: "flex",
    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} />
    </List>
  );
};

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

API Reference

Properties

Property	Type	Description
value ﹡	`ReactNode`	Tag content

External Props:

It also accepts all props of Material UI Chip.

Usage​

API Reference​

Properties​

Usage

API Reference

Properties