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

Image

This field is used to display images and uses <Image> from Ant Design.

Good to know:

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

Usage

Let's see how we can use <ImageField> with the example in the edit page:

localhost:3000
import {
List,
useTable,
ImageField,
} from "@refinedev/antd";
import { Table } from "antd";

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

return (
<List>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="id" title="ID" />
<Table.Column dataIndex="title" title="Title" width="50%" />
<Table.Column<IPost>
title="Image"
dataIndex="image"
render={(_, record) => (
<ImageField
value={record.image[0].url}
title={record.image[0].name}
width={200}
/>
)}
width="50%"
/>
</Table>
</List>
);
};

interface IPost {
id: number;
title: string;
image: [
{
url: string;
name: string;
},
];
}

API Reference

Properties

PropertyTypeDescription
value

string | undefined

Image path

imageTitle

string

External Props:

It also accepts all props of Ant Design Image.