Version: 4.xx.xx
Swizzle Ready
Import
<ImportButton> is compatible with the useImport hook and is meant to be used as it's upload button. It uses Material UI <LoadingButton> component and native html <input> element. It wraps a <label> with a <LoadingButton> component and <input> element and accepts it's own properties for separately.
For more information, refer to the
useImportdocumentation →
Good to know:
You can swizzle this component with the Refine CLI to customize it.
Usage
Use it like any other Material UI <LoadingButton>. You can use it with useImport:
// visible-block-start
import { useImport } from "@refinedev/core";
import {
useDataGrid,
List,
ImportButton,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";
const columns: GridColDef[] = [
{ field: "id", headerName: "ID", type: "number" },
{ field: "title", headerName: "Title", minWidth: 400, flex: 1 },
];
const PostsList: React.FC = () => {
const { dataGridProps } = useDataGrid<IPost>();
const { inputProps, isLoading } = useImport<IPost>();
return (
<List
headerButtons={
<ImportButton inputProps={inputProps} loading={isLoading} />
}
>
<DataGrid {...dataGridProps} columns={columns} autoHeight />
</List>
);
};
interface IPost {
id: number;
title: string;
}
// visible-block-end
render(
<RefineMuiDemo
resources={[
{
name: "posts",
list: PostsList,
},
]}
/>,
);
Properties
hideText
hideText is used to show and hide the text of the button. When true, only the button icon is visible.
const { useRouterContext } = RefineCore;
// visible-block-start
import { ImportButton } from "@refinedev/mui";
const MyImportComponent = () => {
return (
<ImportButton
hideText={true}
/>
);
};
// visible-block-end
render(
<RefineMuiDemo
initialRoutes={["/"]}
resources={[
{
name: "posts",
list: MyImportComponent,
},
]}
/>,
);
API Reference
Properties
External Props:
It also accepts all props of Material UI LoadingButton.