useImport

The useImport hook allows you to import data from a CSV file. For each row in the file, it calls the create or createMany method of your data provider according to your configuration.

Internally, it uses Papa Parse to parse the file contents.

It will return properties that are compatible with Ant Design's <Upload> and <Button> components.

Basic Usage​

Here is a basic usage example of useImport hook:

import { ImportButton, useImport } from "@refinedev/antd";

export const PostList: React.FC = () => {
    const importProps = useImport();

    return <ImportButton {...importProps}>Import</ImportButton>;
};

For more information, refer to the <ImportButton> interface →

Also, you can use the inputProps and uploadProps properties without the <ImportButton> component for more customization:

import { useImport } from "@refinedev/antd";
import { Upload, Button } from "antd";

export const PostList: React.FC = () => {
    const { buttonProps, uploadProps } = useImport();

    return (
        <Upload {...uploadProps}>
            <Button {...buttonProps}>Import</Button>
        </Upload>
    );
};

Properties​

resource​

resource determines which resource is passed to the create or createMany method of your data provider. It reads from the URL by default.

useImport({
    resource: "posts",
});

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier section of the <Refine/> component documentation #8594

mapData​

If you want to map the data before sending it to a data provider method, you can use the mapData property.

useImport({
    mapData: (data) => ({
        ...data,
        category: {
            id: data.categoryId,
        },
    }),
});

paparseOptions​

You can pass any Papa Parse options to the paparseOptions property.

useImport({
    paparseOptions: {
        header: true,
    },
});

batchSize​

If you want to send the data in batches, you can use the batchSize property. When the batchSize is 1, it calls the create method of your data provider for each row in the file. When the batchSize is greater than 1, it calls the createMany method of your data provider for each batch. By default, it is Number.MAX_SAFE_INTEGER

useImport({
    batchSize: 1,
});

onFinish​

If you want to do something after the import is finished, you can use the onFinish property. It returns an object with two properties: succeeded and errored which contain the responses of the successful and failed requests.

useImport({
    onFinish: (result) => {
        // success requests response
        result.succeeded.forEach((item) => {
            console.log(item);
        });

        // failed requests response
        result.errored.forEach((item) => {
            console.log(item);
        });
    },
});

meta​

If you want to send additional data to the create or createMany method of your data provider, you can use the meta property.

useImport({
    meta: {
        foo: "bar",
    },
});

onProgress​

A callback function that is called when the import progress changes. It returns an object with two properties: totalAmount and processedAmount which contain the total amount of rows and the processed amount of rows.

useImport({
    onProgress: ({ totalAmount, processedAmount }) => {
        // progress percentage
        console.log((processedAmount / totalAmount) * 100);
    },
});

By default, it shows a notification with the progress percentage. You can override this behavior by passing a custom onProgress function.

dataProviderName​

If there is more than one dataProvider, you can specify which one to use by passing the dataProviderName prop. It is useful when you have a different data provider for different resources.

useImport({
    dataProviderName: "second-data-provider",
});

resourceName​

Return Values​

buttonProps​

buttonProps are button properties that are compatible with Ant Design <Button> component.

import { useImport } from "@refinedev/antd";
import { Button } from "antd";

export const PostList: React.FC = () => {
    const { buttonProps } = useImport();

    return <Button {...buttonProps}>Import</Button>;
};

type​

It is set to default by default.

loading​

loading sets the loading state of the button if the import is in progress.

uploadProps​

Upload properties that are compatible with Ant Design <Upload> component.

import { useImport } from "@refinedev/antd";
import { Upload } from "antd";

export const PostList: React.FC = () => {
    const { uploadProps } = useImport();

    return <Upload {...uploadProps}>Import</Upload>;
};

onChange​

Handles the file upload.

beforeUpload​

By default, () => false is set to prevent the file from being uploaded automatically.

showUploadList​

By default, false is set to hide the upload list.

accept​

By default, ".csv" is set to accept only CSV files.

isLoading​

It is a boolean value that indicates whether the import is in progress.

mutationResult​

Result of the useCreate or useCreateMany method of your data provider.

FAQ​

Handling Relational Data​

Sometimes you need to process your parsed CSV data for certain cases, such as when your data includes relational data and references to other data, or when your backend API requires a specific data format. To handle this, you can use the mapData option in useImport to customize the process.

For example, the CSV file is as follows:

"title","content","status","categoryId","userId"
"dummy title 1","dummy content 1","rejected","3","8"
"dummy title 2","dummy content 2","draft","44","8"
"dummy title 3","cummy content 3","published","41","10"

Since the user and category are relational fields, we store only their id fields in the exported file as userId and categoryId, respectively. To create resources from this file, we need to map the data back to the required format of the backend API. To do this, we use the mapData option in useImport. Here's an example:

When creating these resources back, we should map them back to our backend API's required format. The mapData option allows us to do this. Here is an example:

useImport<IPostFile>({
    mapData: (item) => {
        return {
            title: item.title,
            content: item.content,
            status: item.status,
            category: {
                id: item.categoryId,
            },
            user: {
                id: item.userId,
            },
        };
    },
});

interface IPostFile {
    title: string;
    status: string;
    content: string;
    categoryId: string;
    userId: string;
}

With this code, the parsed data will be mapped to conform to the API requirements.

API Reference​

Properties​

Return Values​

Type Parameters​