Skip to main content
Version: 4.xx.xx
Swizzle Ready

Tag

This field lets you display a value in a tag. It uses Ant Design's <Tag> 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
import {
List,
TagField,
useTable,
} from "@refinedev/antd";
import { Table } from "antd";

const PostList: React.FC = () => {
const { tableProps } = useTable<IPost>();

return (
<List>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="title" title="Sitle" width="50%" />
<Table.Column
dataIndex="status"
title="Status"
render={(value: string) => <TagField value={value} />}
width="50%"
/>
</Table>
</List>
);
};

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

API Reference

Properties

External Props:

This field also accepts all props of Ant Design's Tag component.

Was this helpful?