Create
<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.
You can swizzle this component to customize it with the refine CLI
Usage
Properties
resource
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.
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
identifier
section of the<Refine/>
component documentation →
meta
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" }} />;
};
hideText
It is used to show and not show the text of the button. When true
, only the button icon is visible.
accessControl
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 }}
/>
);
};
resourceNameOrRouteName
deprecated
resourceNameOrRouteName
The
resourceNameOrRouteName
prop is deprecated. Useresource
prop instead.
It is used to redirect the app to the /create
endpoint of the given resource name. By default, the app redirects to a URL with /create
defined by the name property of resource object.
API Reference
Properties
It also accepts all props of Ant Design Button.