Skip to main content
UniversalCore
Version: 4.xx.xx
Swizzle Ready

Create

const { default: simpleRest } = RefineSimpleRest;
setRefineProps({
  dataProvider: simpleRest("https://api.fake-rest.refine.dev"),
  Layout: RefineChakra.Layout,
  Sider: () => null,
});

const Wrapper = ({ children }) => {
  return (
    <ChakraUI.ChakraProvider theme={RefineChakra.refineTheme}>
      {children}
    </ChakraUI.ChakraProvider>
  );
};

const DummyListPage = () => (
  <ChakraUI.VStack alignItems="flex-start">
    <ChakraUI.Text>This page is empty.</ChakraUI.Text>
    <CreateButton colorScheme="black" />
  </ChakraUI.VStack>
);

interface ICategory {
  id: number;
  title: string;
}

interface IPost {
  id: number;
  title: string;
  content: string;
  status: "published" | "draft" | "rejected";
  category: { id: number };
}

<Create> provides us a layout to display the page. It does not contain any logic and just adds extra functionalities like action buttons and being able to give titles to the page.

We will show what <Create> does using properties with examples.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import {
  FormControl,
  FormErrorMessage,
  FormLabel,
  Input,
  Select,
} from "@chakra-ui/react";
import { useSelect } from "@refinedev/core";
import { useForm } from "@refinedev/react-hook-form";

const PostCreate: React.FC = () => {
  const {
    refineCore: { formLoading },
    saveButtonProps,
    register,
    formState: { errors },
  } = useForm<IPost>();

  const { options } = useSelect({
    resource: "categories",
  });

  return (
    <Create isLoading={formLoading} saveButtonProps={saveButtonProps}>
      <FormControl mb="3" isInvalid={!!errors?.title}>
        <FormLabel>Title</FormLabel>
        <Input
          id="title"
          type="text"
          {...register("title", { required: "Title is required" })}
        />
        <FormErrorMessage>{`${errors.title?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.status}>
        <FormLabel>Status</FormLabel>
        <Select
          id="content"
          placeholder="Select Post Status"
          {...register("status", {
            required: "Status is required",
          })}
        >
          <option>published</option>
          <option>draft</option>
          <option>rejected</option>
        </Select>
        <FormErrorMessage>{`${errors.status?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.categoryId}>
        <FormLabel>Category</FormLabel>
        <Select
          id="categoryId"
          placeholder="Select Category"
          {...register("categoryId", {
            required: "Category is required",
          })}
        >
          {options?.map((option) => (
            <option value={option.value} key={option.value}>
              {option.label}
            </option>
          ))}
        </Select>
        <FormErrorMessage>{`${errors.categoryId?.message}`}</FormErrorMessage>
      </FormControl>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);
Good to know:

You can swizzle this component with the Refine CLI to customize it.

Properties​

title​

title allows the addition of titles inside the <Create> component by passing title props. If you don't pass title props, however, it uses the "Create" prefix and the singular resource name by default. For example, for the /posts/create resource, it would be "Create post".

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { Heading } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create title={<Heading size="lg">Custom Title</Heading>}>
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

saveButtonProps​

saveButtonProps can be used to customize the default button of the <Create> component that submits the form:

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create saveButtonProps={{ colorScheme: "red" }}>
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the <SaveButton> documentation →

resource​

The <Create> component reads the resource information from the route by default. If you want to use a custom resource for the <Create> component, you can use the resource prop.

setInitialRoutes(["/custom"]);

import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";
import routerProvider from "@refinedev/react-router-v6/legacy";
import { Layout } from "@refinedev/chakra-ui";
// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const CustomPage: React.FC = () => {
  return (
    <Create resource="categories">
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App: React.FC = () => {
  return (
    <Refine
      legacyRouterProvider={{
        ...routerProvider,
        routes: [
          {
            element: <CustomPage />,
            path: "/custom",
          },
        ],
      }}
      Layout={Layout}
      dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
      resources={[{ name: "posts" }]}
    />
  );
};

render(
  <Wrapper>
    <App />
  </Wrapper>,
);

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 →

goBack​

To customize the back button or to disable it, you can use the goBack property. You can pass false or null to hide the back button.

setInitialRoutes(["/posts", "/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { IconMoodSmile } from "@tabler/icons-react";

const PostCreate: React.FC = () => {
  return (
    <Create goBack={<IconMoodSmile />}>
      <p>Rest of your page here 2</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

isLoading​

To toggle the loading state of the <Create/> component, you can use the isLoading property.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create isLoading={true}>
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

breadcrumb
Globally Configurable
This value can be configured globally. Click to see the guide for more information.
​

To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @refinedev/chakra-ui package.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create, Breadcrumb } from "@refinedev/chakra-ui";
import { Box } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create
      breadcrumb={
        <Box borderColor="blue" borderStyle="dashed" borderWidth="2px">
          <Breadcrumb />
        </Box>
      }
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Breadcrumb documentation →

wrapperProps​

If you want to customize the wrapper of the <Create/> component, you can use the wrapperProps property. For @refinedev/chakra-ui wrapper element is <Card>s and wrapperProps can get every attribute that <Box> can get.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create
      wrapperProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Box documentation from Chakra UI →

headerProps​

If you want to customize the header of the <Create/> component, you can use the headerProps property.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Box documentation from Chakra UI →

contentProps​

If you want to customize the content of the <Create/> component, you can use the contentProps property.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create
      contentProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Box documentation from Chakra UI →

headerButtons​

You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { Button, Box } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerButtons={({ defaultButtons }) => (
        <Box borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          {defaultButtons}
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </Box>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

headerButtonProps​

You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { Button } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerButtonProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
      }}
      headerButtons={<Button type="primary">Custom Button</Button>}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Box documentation from Chakra UI →

footerButtons​

By default, the <Create/> component has a <SaveButton> at the header.

You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, saveButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { Button, HStack } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtons={({ defaultButtons }) => (
        <HStack borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          {defaultButtons}
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use saveButtonProps to utilize the default values of the <SaveButton> component.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton, SaveButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";
import { Button, HStack } from "@chakra-ui/react";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtons={({ saveButtonProps }) => (
        <HStack borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          <SaveButton {...saveButtonProps} hideText />
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

footerButtonProps​

You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.

setInitialRoutes(["/posts/create"]);
import { Refine } from "@refinedev/core";
import { CreateButton } from "@refinedev/chakra-ui";

// visible-block-start
import { Create } from "@refinedev/chakra-ui";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtonProps={{
        float: "right",
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
        p: "2",
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};
// visible-block-end

const App = () => {
  return (
    <RefineHeadlessDemo
      resources={[
        {
          name: "posts",
          create: PostCreate,
          list: DummyListPage,
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

For more information, refer to the Box documentation from Chakra UI →

API Reference​

Props​

Previous
Inferencer
Next
Edit