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

Export

<ExportButton> is an Ant Design <Button> with a default export icon and a "Export" text. It only has presentational value.

For more information, refer to the useExport documentation →

Good to know:

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

Usage​

You can use it like any other Ant Design <Button>.

For example, you can use it with useExport:

// visible-block-start
import { useExport } from "@refinedev/core";
import {
  List,
  useTable,
  ExportButton,
} from "@refinedev/antd";
import { Table } from "antd";

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

  const { triggerExport, isLoading: exportLoading } = useExport<IPost>();

  return (
    <List
      headerButtons={
        <ExportButton onClick={triggerExport} loading={exportLoading} />
      }
    >
      <Table {...tableProps} rowKey="id">
        <Table.Column dataIndex="id" title="ID" />
        <Table.Column dataIndex="title" title="Title" />
      </Table>
    </List>
  );
};

interface IPost {
  id: number;
  title: string;
}
// visible-block-end

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

Properties​

hideText​

hideText is used to hide the text of the button. When its true, only the button icon will be visible.

const { useRouterContext } = RefineCore;

// visible-block-start
import { ExportButton } from "@refinedev/antd";

const MyExportComponent = () => {
  return (
    <ExportButton
      hideText={true}
    />
  );
};

// visible-block-end

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

API Reference​

Properties​

External Props:

It also accepts all props of Ant Design Button.

Previous
Edit
Next
Import