Back to Refine

Url

documentation/versioned_docs/version-3.xx.xx/api-reference/antd/components/fields/url.md

3.25.01.6 KB
Original Source

This field lets you embed a link. It uses Ant Design's <Typography.Link> component. You can pass a URL in its value prop and you can show a text in its place by passing any children.

:::info-tip Swizzle You can swizzle this component to customize it with the refine CLI :::

Usage

Let's see how we can use <UrlField> with an example:

tsx
import {
  List,
  Table,
  useTable,
  // highlight-next-line
  UrlField,
} from "@pankod/refine-antd";

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

  return (
    <List>
      <Table {...tableProps} rowKey="id">
        <Table.Column dataIndex="title" title="Title" key="title" width="50%" />
        <Table.Column
          dataIndex={["image", "0", "url"]}
          title={"Image"}
          key="image"
          // highlight-next-line
          render={(value: string) => <UrlField value={value} />}
          width="50%"
        />
      </Table>
    </List>
  );
};

interface IPost {
  id: number;
  title: string;
  image: IImage[];
}

interface IImage {
  url: string;
}
// visible-block-end

render(
  <RefineAntdDemo
    resources={[
      {
        name: "posts",
        list: PostList,
      },
    ]}
  />,
);

API Reference

Properties

<PropsTable module="@pankod/refine-antd/UrlField" value-description="URL for link to reference to"/>

:::tip External Props It also accepts all props of Ant Design Link. :::