documentation/docs/ui-integrations/ant-design/components/buttons/create-button/index.md
<CreateButton> uses Ant Design's <Button> component and the create method from useNavigation under the hood.
It can be useful when redirecting the app to the create page route of resource.
:::simple Good to know
You can swizzle this component to customize it with the Refine CLI
:::
setInitialRoutes(["/posts"]);
// visible-block-start
import {
List,
useTable,
// highlight-next-line
CreateButton,
} from "@refinedev/antd";
import { Table } from "antd";
const PostList: React.FC = () => {
const { tableProps } = useTable<IPost>();
return (
<List
// highlight-next-line
headerButtons={<CreateButton />}
>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="id" title="ID" />
<Table.Column dataIndex="title" title="Title" width="100%" />
</Table>
</List>
);
};
interface IPost {
id: number;
title: string;
}
// visible-block-end
const CreatePage = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
create: "/posts/create",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/posts"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<PostList />} />
<ReactRouter.Route path="create" element={<CreatePage />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
resource is used to redirect the app to the create action path of the given resource name. By default, the app redirects to the inferred resource's create action path.
setInitialRoutes(["/categories"]);
// visible-block-start
import { CreateButton } from "@refinedev/antd";
const MyCreateComponent = () => {
return <CreateButton resource="categories" />;
};
// visible-block-end
const CategoryCreate = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
create: "/posts/create",
},
{
name: "categories",
list: "/categories",
create: "/categories/create",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route path="/categories" element={<MyCreateComponent />} />
<ReactRouter.Route
path="/categories/create"
element={<CategoryCreate />}
/>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
Clicking the button will trigger the create method of useNavigation and then redirect the app to the create action path of the resource, filling the necessary parameters in the route.
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
identifiersection of the<Refine/>component documentation →
It is used to pass additional parameters to the create method of useNavigation. By default, existing parameters in the route are used by the create method. You can pass additional parameters or override the existing ones using the meta prop.
If the create action route is defined by the pattern: /posts/:authorId/create, the meta prop can be used as follows:
const MyComponent = () => {
return <CreateButton meta={{ authorId: "10" }} />;
};
It is used to show and not show the text of the button. When true, only the button icon is visible.
setInitialRoutes(["/posts"]);
// visible-block-start
import { CreateButton } from "@refinedev/antd";
const MyCreateComponent = () => {
return (
<CreateButton
// highlight-next-line
hideText={true}
/>
);
};
// visible-block-end
const CreatePage = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
create: "/posts/create",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/posts"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<MyCreateComponent />} />
<ReactRouter.Route path="create" element={<CreatePage />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
This prop can be used to skip access control check with its enabled property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized property. This is relevant only when an accessControlProvider is provided to <Refine/>
import { CreateButton } from "@refinedev/antd";
export const MyListComponent = () => {
return (
<CreateButton
accessControl={{
enabled: true,
hideIfUnauthorized: true,
}}
/>
);
};
:::simple External Props
It also accepts all props of Ant Design Button.
:::