FormControl

Provide context to form elements, such as invalid, disabled, or required states.

Installation

API Reference

Important Note

This is the documentation for gluestack-ui v2 (beta). For @gluestack-ui/themed (stable) documentation, refer to gluestack-ui v1.

This is an illustration of FormControl component.

<Box className="h-32 w-72">
  <FormControl {...props}>
    <FormControlLabel className="mb-1">
      <FormControlLabelText>Password</FormControlLabelText>
    </FormControlLabel>
    <Input>
      <InputField type="password" defaultValue="12345" placeholder="password" />
    </Input>
    <FormControlHelper>
      <FormControlHelperText>
        Must be at least 6 characters.
      </FormControlHelperText>
    </FormControlHelper>
    <FormControlError>
      <FormControlErrorIcon size={10} as={AlertCircleIcon} />
      <FormControlErrorText>
        At least 6 characters are required.
      </FormControlErrorText>
    </FormControlError>
  </FormControl>
</Box>

Form Control with Radio

The Radio Component can be incorporated within the FormControl.

<FormControl>
  <FormControlLabel>
    <FormControlLabelText>Favourite fruit</FormControlLabelText>
  </FormControlLabel>
  <RadioGroup className="my-2">
    <VStack space="sm">
      <Radio size="sm" value="Mango">
        <RadioIndicator>
          <RadioIcon>
            <CircleIcon />
          </RadioIcon>
        </RadioIndicator>
        <RadioLabel>Mango</RadioLabel>
      </Radio>
      <Radio size="sm" value="Apple">
        <RadioIndicator>
          <RadioIcon>
            <CircleIcon />
          </RadioIcon>
        </RadioIndicator>
        <RadioLabel>Apple</RadioLabel>
      </Radio>
      <Radio size="sm" value="Orange">
        <RadioIndicator>
          <RadioIcon>
            <CircleIcon />
          </RadioIcon>
        </RadioIndicator>
        <RadioLabel>Orange</RadioLabel>
      </Radio>
    </VStack>
  </RadioGroup>
  <FormControlHelper>
    <FormControlHelperText>
      Choose the fruit you like the most
    </FormControlHelperText>
  </FormControlHelper>
</FormControl>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add form-control

Step 1: Install the following dependencies:

npm i @gluestack-ui/form-control

Step 2: Copy and paste the following code into your project.

"use client"
import { Text, View } from "react-native"
import React, { useMemo } from "react"
import { Svg } from "react-native-svg"
import { createFormControl } from "@gluestack-ui/form-control"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { cssInterop } from "nativewind"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

const SCOPE = "FORM_CONTROL"

const PrimitiveIcon = React.forwardRef(
  (
    {
      height,
      width,
      fill,
      color,
      size,
      stroke = "currentColor",
      as: AsComp,
      ...props
    }: any,
    ref?: any
  ) => {
    const sizeProps = useMemo(() => {
      if (size) return { size }
      if (height && width) return { height, width }
      if (height) return { height }
      if (width) return { width }
      return {}
    }, [size, height, width])

    const colorProps =
      stroke === "currentColor" && color !== undefined ? color : stroke

    if (AsComp) {
      return (
        <AsComp
          ref={ref}
          fill={fill}
          {...props}
          {...sizeProps}
          stroke={colorProps}
        />
      )
    }
    return (
      <Svg
        ref={ref}
        height={height}
        width={width}
        fill={fill}
        stroke={colorProps}
        {...props}
      />
    )
  }
)

const formControlStyle = tva({
  base: "flex flex-col",
  variants: {
    size: {
      sm: "",
      md: "",
      lg: "",
    },
  },
})

const formControlErrorIconStyle = tva({
  base: "text-error-700 fill-none",
  variants: {
    size: {
      "2xs": "h-3 w-3",
      xs: "h-3.5 w-3.5",
      sm: "h-4 w-4",
      md: "h-[18px] w-[18px]",
      lg: "h-5 w-5",
      xl: "h-6 w-6",
    },
  },
})

const formControlErrorStyle = tva({
  base: "flex flex-row justify-start items-center mt-1 gap-1",
})

const formControlErrorTextStyle = tva({
  base: "text-error-700",
  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

const formControlHelperStyle = tva({
  base: "flex flex-row justify-start items-center mt-1",
})

const formControlHelperTextStyle = tva({
  base: "text-typography-500",
  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-xs",
      md: "text-sm",
      lg: "text-base",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

const formControlLabelStyle = tva({
  base: "flex flex-row justify-start items-center mb-1",
})

const formControlLabelTextStyle = tva({
  base: "font-medium text-typography-900",
  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

const formControlLabelAstrickStyle = tva({
  base: "font-medium text-typography-900",
  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

const FormControlLabelAstrick = ({ className, ...props }: any) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  return (
    <Text
      className={formControlLabelAstrickStyle({
        parentVariants: { size: parentSize },
        class: className,
      })}
      {...props}
    />
  )
}

export const UIFormControl = createFormControl({
  Root: withStyleContext(View, SCOPE),
  Error: View,
  ErrorText: Text,
  ErrorIcon: PrimitiveIcon,
  Label: View,
  LabelText: Text,
  LabelAstrick: FormControlLabelAstrick,
  Helper: View,
  HelperText: Text,
})

cssInterop(UIFormControl, { className: "style" })
cssInterop(UIFormControl.Error, { className: "style" })
cssInterop(UIFormControl.Error.Text, { className: "style" })
cssInterop(UIFormControl.Label, { className: "style" })
cssInterop(UIFormControl.Label.Text, { className: "style" })
cssInterop(UIFormControl.Helper, { className: "style" })
cssInterop(UIFormControl.Helper.Text, { className: "style" })
cssInterop(UIFormControl.Error.Icon, {
  className: {
    target: "style",
    nativeStyleToProp: {
      height: true,
      width: true,
      // @ts-ignore
      fill: true,
      color: true,
      stroke: true,
    },
  },
})

type IFormControlProps = React.ComponentProps<typeof UIFormControl> &
  VariantProps<typeof formControlStyle>
const FormControl = ({
  className,
  size = "md",
  ...props
}: { className?: string } & IFormControlProps) => {
  return (
    <UIFormControl
      className={formControlStyle({ class: className })}
      {...props}
      context={{ size }}
    />
  )
}

type IFormControlErrorProps = React.ComponentProps<typeof UIFormControl.Error> &
  VariantProps<typeof formControlErrorStyle>
const FormControlError = ({
  className,
  ...props
}: { className?: string } & IFormControlErrorProps) => {
  return (
    <UIFormControl.Error
      className={formControlErrorStyle({ class: className })}
      {...props}
    />
  )
}

type IFormControlErrorTextProps = React.ComponentProps<
  typeof UIFormControl.Error.Text
> &
  VariantProps<typeof formControlErrorTextStyle>
const FormControlErrorText = ({
  className,
  size,
  ...props
}: { className?: string } & IFormControlErrorTextProps) => {
  const { size: parentSize } = useStyleContext(SCOPE)
  return (
    <UIFormControl.Error.Text
      className={formControlErrorTextStyle({
        parentVariants: { size: parentSize },
        size,
        class: className,
      })}
      {...props}
    />
  )
}

type IFormControlErrorIconProps = React.ComponentProps<
  typeof UIFormControl.Error.Icon
> &
  VariantProps<typeof formControlErrorIconStyle>
const FormControlErrorIcon = (
  {
    className,
    size,
    ...props
  }: {
    className?: any
    as?: any
  } & IFormControlErrorIconProps,
  ref?: any
) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  if (typeof size === "number") {
    return (
      <UIFormControl.Error.Icon
        ref={ref}
        {...props}
        className={formControlErrorIconStyle({ class: className })}
        size={size}
      />
    )
  } else if (
    (props.height !== undefined || props.width !== undefined) &&
    size === undefined
  ) {
    return (
      <UIFormControl.Error.Icon
        ref={ref}
        {...props}
        className={formControlErrorIconStyle({ class: className })}
      />
    )
  }
  return (
    <UIFormControl.Error.Icon
      className={formControlErrorIconStyle({
        parentVariants: { size: parentSize },
        size,
        class: className,
      })}
      {...props}
    />
  )
}

type IFormControlLabelProps = React.ComponentProps<typeof UIFormControl.Label> &
  VariantProps<typeof formControlLabelStyle>
const FormControlLabel = ({
  className,
  ...props
}: { className?: string } & IFormControlLabelProps) => {
  return (
    <UIFormControl.Label
      className={formControlLabelStyle({ class: className })}
      {...props}
    />
  )
}

type IFormControlLabelTextProps = React.ComponentProps<
  typeof UIFormControl.Label.Text
> &
  VariantProps<typeof formControlLabelTextStyle>
const FormControlLabelText = ({
  className,
  size,
  ...props
}: { className?: string } & IFormControlLabelTextProps) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  return (
    <UIFormControl.Label.Text
      className={formControlLabelTextStyle({
        parentVariants: { size: parentSize },
        size,
        class: className,
      })}
      {...props}
    />
  )
}

type IFormControlHelperProps = React.ComponentProps<
  typeof UIFormControl.Helper
> &
  VariantProps<typeof formControlHelperStyle>
const FormControlHelper = ({
  className,
  ...props
}: { className?: string } & IFormControlHelperProps) => {
  return (
    <UIFormControl.Helper
      className={formControlHelperStyle({
        class: className,
      })}
      {...props}
    />
  )
}

type IFormControlHelperTextProps = React.ComponentProps<
  typeof UIFormControl.Helper.Text
> &
  VariantProps<typeof formControlHelperTextStyle>
const FormControlHelperText = ({
  className,
  size,
  ...props
}: { className?: string } & IFormControlHelperTextProps) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  return (
    <UIFormControl.Helper.Text
      className={formControlHelperTextStyle({
        parentVariants: { size: parentSize },
        size,
        class: className,
      })}
      {...props}
    />
  )
}

FormControl.displayName = "FormControl"
FormControlError.displayName = "FormControlError"
FormControlErrorText.displayName = "FormControlErrorText"
FormControlErrorIcon.displayName = "FormControlErrorIcon"
FormControlLabel.displayName = "FormControlLabel"
FormControlLabelText.displayName = "FormControlLabelText"
FormControlLabelAstrick.displayName = "FormControlLabelAstrick"
FormControlHelper.displayName = "FormControlHelper"
FormControlHelperText.displayName = "FormControlHelperText"

export {
  FormControl,
  FormControlError,
  FormControlErrorText,
  FormControlErrorIcon,
  FormControlLabel,
  FormControlLabelText,
  FormControlLabelAstrick,
  FormControlHelper,
  FormControlHelperText,
}

Step 3: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { FormControl } from "@/components/ui/form-control"

export default () => (
  <FormControl>
    <FormControlLabel>
      <FormControlLabelText />
    </FormControlLabel>
    <FormControlHelper>
      <FormControlHelperText />
    </FormControlHelper>
    <FormControlError>
      <FormControlErrorIcon />
      <FormControlErrorText />
    </FormControlError>
  </FormControl>
)

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

FormControl

It inherits all the properties of React Native's View component.

Prop	Type	Default	Description
isInvalid	bool	false	When true, invalid state.
isRequired	bool	false	If true, astrick gets activated.
isDisabled	bool	false	Disabled state true.
isReadOnly	bool	false	To manually set read-only state.
isDisabled	bool	false	To manually set disable to the FormControl.

FormControlLabel

It inherits all the properties of React Native's View component.

FormControlLabelText

It inherits all the properties of React Native's Text component.

FormControlHelper

It inherits all the properties of React Native's View component.

FormControlHelperText

It inherits all the properties of React Native's Text component.

FormControlError

It inherits all the properties of React Native's View component.

FormControlErrorIcon

It inherits all the properties of gluestack Style's AsForwarder component.

FormControlErrorText

It inherits all the properties of React Native's Text component.

Features

Keyboard support for actions.
Support for hover, focus and active states.
Option to add your styles or use the default styles.

Props

FormControl component is created using View component from react-native. It extends all the props supported by React Native View.

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

Form Control with Input

The Input Component can be incorporated within the FormControl.

size

isDisabled

isInvalid

isReadOnly

isRequired

<Box className="h-32 w-72">
  <FormControl
    size="md"
    isDisabled={false}
    isInvalid={false}
    isReadOnly={false}
    isRequired={false}
  >
    <FormControlLabel className="mb-1">
      <FormControlLabelText>Password</FormControlLabelText>
    </FormControlLabel>
    <Input>
      <InputField type="password" defaultValue="12345" placeholder="password" />
    </Input>
    <FormControlHelper>
      <FormControlHelperText>
        Must be at least 6 characters.
      </FormControlHelperText>
    </FormControlHelper>
    <FormControlError>
      <FormControlErrorIcon size={10} as={AlertCircleIcon} />
      <FormControlErrorText>
        At least 6 characters are required.
      </FormControlErrorText>
    </FormControlError>
  </FormControl>
</Box>

Form Control with Checkbox

The Checkbox Component can be incorporated within the FormControl.

<FormControl>
  <FormControlLabel>
    <FormControlLabelText>Sign up for newsletters</FormControlLabelText>
  </FormControlLabel>
  <CheckboxGroup className="my-2">
    <VStack space="sm">
      <Checkbox size="sm" value="Mango">
        <CheckboxIndicator className="mr-2">
          <CheckboxIcon>
            <CheckIcon />
          </CheckboxIcon>
        </CheckboxIndicator>
        <CheckboxLabel>Daily Bits</CheckboxLabel>
      </Checkbox>
      <Checkbox size="sm" value="Apple">
        <CheckboxIndicator className="mr-2">
          <CheckboxIcon>
            <CheckIcon />
          </CheckboxIcon>
        </CheckboxIndicator>
        <CheckboxLabel>Event Updates</CheckboxLabel>
      </Checkbox>
      <Checkbox size="sm" value="Orange">
        <CheckboxIndicator className="mr-2">
          <CheckboxIcon>
            <CheckIcon />
          </CheckboxIcon>
        </CheckboxIndicator>
        <CheckboxLabel>Sponsorship</CheckboxLabel>
      </Checkbox>
    </VStack>
  </CheckboxGroup>
  <FormControlHelper>
    <FormControlHelperText>
      Subscribe to newsletters for updates
    </FormControlHelperText>
  </FormControlHelper>
</FormControl>

Form Control with Textarea

The Textarea Component can be incorporated within the FormControl.

<FormControl>
  <FormControlLabel>
    <FormControlLabelText>Comment</FormControlLabelText>
  </FormControlLabel>
  <Textarea>
    <TextareaInput />
  </Textarea>
  <FormControlHelper>
    <FormControlHelperText>Type your comment above</FormControlHelperText>
  </FormControlHelper>
</FormControl>

Form Control with Error

Error messages can be displayed using FormControl.

<FormControl isInvalid>
  <FormControlLabel>
    <FormControlLabelText>
      Which time slot works best for you?
    </FormControlLabelText>
  </FormControlLabel>
  <RadioGroup className="my-2">
    <VStack space="sm">
      <Radio size="sm" value="Mango">
        <RadioIndicator>
          <RadioIcon as={CircleIcon} />
        </RadioIndicator>
        <RadioLabel>Monday</RadioLabel>
      </Radio>
      <Radio size="sm" value="Apple">
        <RadioIndicator>
          <RadioIcon as={CircleIcon} />
        </RadioIndicator>
        <RadioLabel>Tuesday</RadioLabel>
      </Radio>
      <Radio size="sm" value="Orange">
        <RadioIndicator>
          <RadioIcon as={CircleIcon} />
        </RadioIndicator>
        <RadioLabel>Wednesday</RadioLabel>
      </Radio>
    </VStack>
  </RadioGroup>
  <FormControlError>
    <FormControlErrorIcon as={AlertCircleIcon} />
    <FormControlErrorText>
      Choose one time slot for the meeting
    </FormControlErrorText>
  </FormControlError>
</FormControl>

Form Control with Form Actions

Form Action Buttons can also be utilized in conjunction with FormControl.

<HStack>
  <FormControl>
    <Button variant="outline" action="secondary">
      <ButtonText>Cancel</ButtonText>
    </Button>
  </FormControl>
  <FormControl>
    <Button action="negative" className="ml-4">
      <ButtonText className="text-white group-hover/button:text-white group-active/button:text-white">
        Delete
      </ButtonText>
    </Button>
  </FormControl>
</HStack>