Skip to main content
Version: 3.xx.xx

CSV Export

With refine, you can easily add export functionality to your application. By using the useExport hook with desired configurations, you can turn any button into an export button. Which resources' records to export can be configured. By default, it is inferred from current route of browser.

Internally, it uses export-to-csv to create the CSV file.


import { useExport } from "@pankod/refine-core";

interface IPost {
id: number;
slug: string;
title: string;
content: string;

export const PostList: React.FC = () => {
const { triggerExport } = useExport<IPost>();

return (
<button onClick={triggerExport}>Export Button</button>

After this setup is done, when the user clicks the button, download process will initialize.

Manually running the triggerExport function is another option.

useExport returns two properties: isLoading: boolean and triggerExport: async () => void. You can use these properties to create your own export button or pass them to the ExportButton component.

Refer to the useExport docs for more detailed information and export settings.


Run on your local
npm create refine-app@latest -- --example import-export-antd