Create

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

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

localhost:3000/posts/create

import React from "react";
import { Create, useAutocomplete } from "@refinedev/mui";
import { Autocomplete, Box, TextField } from "@mui/material";
import { useForm } from "@refinedev/react-hook-form";
import { Controller } from "react-hook-form";

const SampleCreate = () => {
  const {
    saveButtonProps,
    refineCore: { formLoading },
    register,
    control,
    formState: { errors },
  } = useForm();

  const { autocompleteProps: categoryAutocompleteProps } = useAutocomplete({
    resource: "categories",
  });

  return (
    <Create isLoading={formLoading} saveButtonProps={saveButtonProps}>
      <Box
        component="form"
        sx={{ display: "flex", flexDirection: "column" }}
        autoComplete="off"
      >
        <TextField
          {...register("title", {
            required: "This field is required",
          })}
          error={!!(errors as any)?.title}
          helperText={(errors as any)?.title?.message}
          margin="normal"
          fullWidth
          InputLabelProps={{ shrink: true }}
          type="text"
          label="Title"
          name="title"
        />
        <TextField
          {...register("content", {
            required: "This field is required",
          })}
          error={!!(errors as any)?.content}
          helperText={(errors as any)?.content?.message}
          margin="normal"
          fullWidth
          InputLabelProps={{ shrink: true }}
          multiline
          label="Content"
          name="content"
        />
        <Controller
          control={control}
          name="category"
          rules={{ required: "This field is required" }}
          // eslint-disable-next-line
          defaultValue={null as any}
          render={({ field }) => (
            <Autocomplete
              {...categoryAutocompleteProps}
              {...field}
              onChange={(_, value) => {
                field.onChange(value);
              }}
              getOptionLabel={(item) => {
                return (
                  categoryAutocompleteProps?.options?.find(
                    (p) => p?.id?.toString() === item?.id?.toString(),
                  )?.title ?? ""
                );
              }}
              isOptionEqualToValue={(option, value) =>
                value === undefined ||
                option?.id?.toString() === (value?.id ?? value)?.toString()
              }
              renderInput={(params) => (
                <TextField
                  {...params}
                  label="Category"
                  margin="normal"
                  variant="outlined"
                  error={!!(errors as any)?.category?.id}
                  helperText={(errors as any)?.category?.id?.message}
                  required
                />
              )}
            />
          )}
        />
      </Box>
    </Create>
  );
};

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. If you don't pass title props it uses "Create" prefix and singular resource name by default. For example, for the /posts/create resource, it would be "Create post".

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Typography } from "@mui/material";

const CreatePage: React.FC = () => {
  return (
    <Create
      title={<Typography variant="h5">Custom Title</Typography>}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

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.

localhost:3000/custom

import { Create } from "@refinedev/mui";

const CustomPage: React.FC = () => {
  return (
    <Create resource="posts">
      <span>Rest of your page here</span>
    </Create>
  );
};

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 →

saveButtonProps

The <Create> component has a default button that submits the form. If you want to customize this button you can use the saveButtonProps property like the code below:

localhost:3000/posts/create

import { Create } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  return (
    <Create saveButtonProps={{ size: "small" }}>
      <span>Rest of your page here</span>
    </Create>
  );
};

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

goBack

To customize the back button or to disable it, you can use the goBack property.

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Button } from "@mui/material";
import { useBack } from "@refinedev/core";

const BackButton = () => {
  const goBack = useBack();

  return <Button onClick={goBack}>BACK!</Button>;
};

const PostCreate: React.FC = () => {
  return (
    <Create
      goBack={<BackButton />}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

isLoading

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

localhost:3000/posts/create

import { Create } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      isLoading={loading}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

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

localhost:3000/posts/create

import { Create, Breadcrumb } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  return (
    <Create
      breadcrumb={
        <div
          style={{
            padding: "3px 6px",
            border: "2px dashed cornflowerblue",
          }}
        >
          <Breadcrumb />
        </div>
      }
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

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.

localhost:3000/posts/create

import { Create } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      wrapperProps={{
        sx: {
          backgroundColor: "lightsteelblue",
        },
      }}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

For more information, refer to the Card documentation from Material UI →

headerProps

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

localhost:3000/posts/create

import { Create } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      headerProps={{
        sx: {
          backgroundColor: "lightsteelblue",
        },
      }}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

For more information, refer to the CardHeader documentation from Material UI →

contentProps

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

localhost:3000/posts/create

import { Create } from "@refinedev/mui";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      contentProps={{
        sx: {
          backgroundColor: "lightsteelblue",
        },
      }}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

For more information, refer to the CardContent documentation from Material 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.

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Button } from "@mui/material";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

headerButtonProps

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

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Button } from "@mui/material";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      headerButtonProps={{
        sx: {
          backgroundColor: "lightsteelblue",
        },
      }}
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

For more information, refer to the Box documentation from Material 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.

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Button } from "@mui/material";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

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.

localhost:3000/posts/create

import { Create, SaveButton } from "@refinedev/mui";
import { Button } from "@mui/material";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      footerButtons={({ saveButtonProps }) => (
        <>
          <SaveButton
            {...saveButtonProps}
            type="primary"
            sx={{ marginRight: 8 }}
          >
            Save
          </SaveButton>
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

footerButtonProps

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

localhost:3000/posts/create

import { Create } from "@refinedev/mui";
import { Button } from "@mui/material";

const PostCreate: React.FC = () => {
  const [loading, setLoading] = React.useState(true);

  return (
    <Create
      footerButtonProps={{
        sx: {
          backgroundColor: "lightsteelblue",
        },
      }}
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <span>Rest of your page here</span>
    </Create>
  );
};

For more information, refer to the CardActions documentation from Material UI →

API Reference

Properties

Property	Type	Description	Default
resource	`string`	Resource name for API data interactions	Reads `:resource` from the URL
title	`ReactNode`	Title of the create view	Create {resource.name}
wrapperProps	`CardProps`	Props for the wrapper component of the view
headerProps	`CardHeaderProps`	Props for the header component
contentProps	`CardContentProps`	Props for the content wrapper component
breadcrumb	`ReactNode`	Breadcrumb to be displayed in the header	`<Breadcrumb />`
goBack	`ReactNode`	Back button element at the top left of the page	`<ArrowLeft />`
headerButtons	`ActionButtonRenderer<Record<stringnumbersymbol, unknown>>`	Header action buttons to be displayed in the header	`null`
headerButtonProps	`BoxProps`	Additional props to be passed to the wrapper of the header buttons
footerButtons	`ActionButtonRenderer<{ saveButtonProps: SaveButtonProps; }>`	Footer action buttons to be displayed in the footer	`<SaveButton />`
footerButtonProps	`CardActionsProps`	Additional props to be passed to the wrapper of the footer buttons
isLoading	`boolean`	Loading state of the component	`false`
saveButtonProps	`SaveButtonProps`	Additional props for the `<SaveButton />` component

Properties​

title​

resource​

saveButtonProps​

goBack​

isLoading​

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

wrapperProps​

headerProps​

contentProps​

headerButtons​

headerButtonProps​

footerButtons​

footerButtonProps​

API Reference​

Properties​

Properties

title

resource

saveButtonProps

goBack

isLoading

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

wrapperProps

headerProps

contentProps

headerButtons

headerButtonProps

footerButtons

footerButtonProps

API Reference

Properties