Forms - Components | Backend AI UI

Example

form-example

React

import { z } from "zod";
import { useForm } from "react-hook-form";
import { zodResolver } from "@hookform/resolvers/zod";

import {
  Form,
  FormControl,
  FormDescription,
  FormField,
  FormItem,
  FormLabel,
  FormMessage,
} from "@backend-ai/ui/forms";

import { Button, Input } from "@backend-ai/ui/components";

const formSchema = z.object({
  username: z.string().min(2).max(50),
});

type FormSchema = z.infer<typeof formSchema>;

const FormExample = () => {
  const form = useForm<z.infer<typeof formSchema>>({
    resolver: zodResolver(formSchema),
    defaultValues: {
      username: "",
    },
  });

  function onSubmit(values: FormSchema) {
    console.log(values);
  }

  return (
    <Form {...form}>
      <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-8">
        <FormField
          control={form.control}
          name="username"
          render={({ field }) => (
            <FormItem>
              <FormLabel>Username</FormLabel>
              <FormControl>
                <Input placeholder="shadcn" {...field} />
              </FormControl>
              <FormDescription>
                This is your public display name.
              </FormDescription>
              <FormMessage />
            </FormItem>
          )}
        />
        <Button type="submit">Submit</Button>
      </form>
    </Form>
  );
};

export default FormExample;

Dependencies

To use the form components, you need to install the following dependencies:

Terminal

npm i zod react-hook-form @hookform/resolvers -E

Create a form schema

TypeScript

import { z } from "zod";

const formSchema = z.object({
  username: z.string().min(2).max(50),
});

type FormSchema = z.infer<typeof formSchema>;

Create a new form component

Use the useForm hook from react-hook-form to create a new form component:

React

import { useForm } from "react-hook-form";
import { zodResolver } from "@hookform/resolvers/zod";

const form = useForm<z.infer<typeof formSchema>>({
  resolver: zodResolver(formSchema),
  defaultValues: {
    username: "",
  },
});

Create onSubmit function to handle form submission:

React

function onSubmit(values: FormSchema) {
  console.log(values);
}

Use @backend-ai/ui/forms and @backend-ai/ui/components components to create the form:

React

//...

import {
  Form,
  FormControl,
  FormDescription,
  FormField,
  FormItem,
  FormLabel,
  FormMessage,
} from "@backend-ai/ui/forms";

import { Button, Input } from "@backend-ai/ui/components";

//...

  return (
    <Form {...form}>
      <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-8">
        <FormField
          control={form.control}
          name="username"
          render={({ field }) => (
            <FormItem>
              <FormLabel>Username</FormLabel>
              <FormControl>
                <Input placeholder="shadcn" {...field} />
              </FormControl>
              <FormDescription>
                This is your public display name.
              </FormDescription>
              <FormMessage />
            </FormItem>
          )}
        />
        <Button type="submit">Submit</Button>
      </form>
    </Form>
  );
};

export default FormExample;