Radio

Standalone radio button for use in any layout, offering predefined choices for selection.

Installation

API Reference

Spec Doc

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 Radio component.

size

isInvalid

isDisabled

<RadioGroup>
  <Radio value="change" size="md" isInvalid={false} isDisabled={false}>
    <RadioIndicator>
      <RadioIcon as={CircleIcon} />
    </RadioIndicator>
    <RadioLabel>Label</RadioLabel>
  </Radio>
</RadioGroup>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add radio

Step 1: Install the following dependencies:

npm i @gluestack-ui/radio lucide-react-native

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

"use client"
import React, { useMemo } from "react"
import { createRadio } from "@gluestack-ui/radio"
import { Svg } from "react-native-svg"
import { Pressable, View, Platform, Text } from "react-native"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { cssInterop } from "nativewind"
import { withStates } from "@gluestack-ui/nativewind-utils/withStates"
import { withStyleContextAndStates } from "@gluestack-ui/nativewind-utils/withStyleContextAndStates"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

const IndicatorWrapper = React.forwardRef(({ ...props }: any, ref?: any) => {
  return <View {...props} ref={ref} />
})

const LabelWrapper = React.forwardRef(({ ...props }: any, ref?: any) => {
  return <Text {...props} ref={ref} />
})

const IconWrapper = React.forwardRef(({ ...props }: any, ref?: any) => {
  return <PrimitiveIcon {...props} ref={ref} />
})

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 radioStyle = tva({
  base: "group/radio flex-row justify-start items-center web:cursor-pointer data-[disabled=true]:web:cursor-not-allowed",
  variants: {
    size: {
      sm: "gap-1.5",
      md: "gap-2",
      lg: "gap-2",
    },
  },
})

const radioGroupStyle = tva({
  base: "gap-2",
})

const radioIconStyle = tva({
  base: "rounded-full justify-center items-center text-background-800 fill-background-800",

  parentVariants: {
    size: {
      sm: "h-[9px] w-[9px]",
      md: "h-3 w-3",
      lg: "h-4 w-4",
    },
  },
})

const radioIndicatorStyle = tva({
  base: "justify-center items-center bg-transparent border-outline-400 border-2 rounded-full data-[focus-visible=true]:web:outline-2 data-[focus-visible=true]:web:outline-primary-700 data-[focus-visible=true]:web:outline data-[checked=true]:border-primary-600 data-[checked=true]:bg-transparent data-[hover=true]:border-outline-500 data-[hover=true]:bg-transparent data-[hover=true]:data-[checked=true]:bg-transparent data-[hover=true]:data-[checked=true]:border-primary-700 data-[hover=true]:data-[invalid=true]:border-error-700 data-[hover=true]:data-[disabled=true]:opacity-40 data-[hover=true]:data-[disabled=true]:border-outline-400 data-[hover=true]:data-[disabled=true]:data-[invalid=true]:border-error-400 data-[active=true]:bg-transparent data-[active=true]:border-primary-800 data-[invalid=true]:border-error-700 data-[disabled=true]:opacity-40 data-[disabled=true]:data-[checked=true]:border-outline-400 data-[disabled=true]:data-[checked=true]:bg-transparent data-[disabled=true]:data-[invalid=true]:border-error-400",
  parentVariants: {
    size: {
      sm: "h-4 w-4",
      md: "h-5 w-5",
      lg: "h-6 w-6",
    },
  },
})

const radioLabelStyle = tva({
  base: "text-typography-600 data-[checked=true]:text-typography-900 data-[hover=true]:text-typography-900 data-[hover=true]:data-[disabled=true]:text-typography-600 data-[hover=true]:data-[disabled=true]:data-[checked=true]:text-typography-900 data-[active=true]:text-typography-900 data-[active=true]:data-[checked=true]:text-typography-900 data-[disabled=true]:opacity-40 web:select-none",
  parentVariants: {
    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",
    },
  },
})

const SCOPE = "Radio"
const UIRadio = createRadio({
  // @ts-ignore
  Root:
    Platform.OS === "web"
      ? withStyleContext(View, SCOPE)
      : withStyleContextAndStates(Pressable, SCOPE),
  Group: View,
  Icon: Platform.OS === "web" ? IconWrapper : withStates(IconWrapper),
  Indicator:
    Platform.OS === "web" ? IndicatorWrapper : withStates(IndicatorWrapper),
  Label: Platform.OS === "web" ? LabelWrapper : withStates(LabelWrapper),
})

cssInterop(UIRadio, { className: "style" })
cssInterop(UIRadio.Group, { className: "style" })
cssInterop(IndicatorWrapper, { className: "style" })
cssInterop(LabelWrapper, { className: "style" })
cssInterop(IconWrapper, {
  className: {
    target: "style",
    nativeStyleToProp: {
      height: true,
      width: true,
      // @ts-ignore
      fill: true,
      color: true,
      stroke: true,
    },
  },
})

type IRadioProps = Omit<React.ComponentProps<typeof UIRadio>, "context"> &
  VariantProps<typeof radioStyle>
const Radio = React.forwardRef(
  (
    { className, size = "md", ...props }: { className?: string } & IRadioProps,
    ref?: any
  ) => {
    return (
      <UIRadio
        className={radioStyle({ class: className, size })}
        {...props}
        ref={ref}
        context={{ size }}
      />
    )
  }
)

type IRadioGroupProps = React.ComponentProps<typeof UIRadio.Group> &
  VariantProps<typeof radioGroupStyle>
const RadioGroup = React.forwardRef(
  (
    { className, ...props }: { className?: string } & IRadioGroupProps,
    ref?: any
  ) => {
    return (
      <UIRadio.Group
        className={radioGroupStyle({ class: className })}
        {...props}
        ref={ref}
      />
    )
  }
)

type IRadioIndicatorProps = React.ComponentProps<typeof UIRadio.Indicator> &
  VariantProps<typeof radioIndicatorStyle>
const RadioIndicator = React.forwardRef(
  (
    { className, ...props }: { className?: string } & IRadioIndicatorProps,
    ref?: any
  ) => {
    const { size } = useStyleContext(SCOPE)
    return (
      <UIRadio.Indicator
        className={radioIndicatorStyle({
          parentVariants: { size },
          class: className,
        })}
        ref={ref}
        {...props}
      />
    )
  }
)

type IRadioLabelProps = React.ComponentProps<typeof UIRadio.Label> &
  VariantProps<typeof radioIndicatorStyle>
const RadioLabel = React.forwardRef(
  (
    { className, ...props }: { className?: string } & IRadioLabelProps,
    ref?: any
  ) => {
    const { size } = useStyleContext(SCOPE)
    return (
      <UIRadio.Label
        className={radioLabelStyle({
          parentVariants: { size },
          class: className,
        })}
        ref={ref}
        {...props}
      />
    )
  }
)

type IRadioIconProps = React.ComponentProps<typeof UIRadio.Icon> &
  VariantProps<typeof radioIconStyle>
const RadioIcon = React.forwardRef(
  (
    {
      className,
      size,
      ...props
    }: IRadioIconProps & {
      className?: string
      as?: any
    },
    ref?: any
  ) => {
    const { size: parentSize } = useStyleContext(SCOPE)

    if (typeof size === "number") {
      return (
        <UIRadio.Icon
          ref={ref}
          {...props}
          className={radioIconStyle({ class: className })}
          size={size}
        />
      )
    } else if (
      (props.height !== undefined || props.width !== undefined) &&
      size === undefined
    ) {
      return (
        <UIRadio.Icon
          ref={ref}
          {...props}
          className={radioIconStyle({ class: className })}
        />
      )
    }

    return (
      <UIRadio.Icon
        {...props}
        className={radioIconStyle({
          parentVariants: {
            size: parentSize,
          },
          size,
          class: className,
        })}
        ref={ref}
      />
    )
  }
)

Radio.displayName = "Radio"
RadioGroup.displayName = "RadioGroup"
RadioIndicator.displayName = "RadioIndicator"
RadioLabel.displayName = "RadioLabel"
RadioIcon.displayName = "RadioIcon"

export { Radio, RadioGroup, RadioIndicator, RadioLabel, RadioIcon }

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 { Radio } from "@gluestack-ui/themed"

export default () => (
  <RadioGroup>
    <Radio>
      <RadioIndicator>
        <RadioIcon />
      </RadioIndicator>
      <RadioLabel />
    </Radio>
  </RadioGroup>
)

Component Props

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

Radio

Contains all Radio related layout style props and actions. It inherits all the properties of React Native's View component.

Prop	Type	Default	Description
value	string	-	The value to be used in the radio input. This is the value that will be returned on form submission.
onChange	function	-	Function called when the state of the radio changes.
isDisabled	bool	false	To manually set disable to the radio.
isInvalid	bool	false	To manually set invalid to the radio.
isHovered	bool	false	To manually set hover to the radio.
isFocusVisible	bool	false	To manually set focus visible state to the radio.
isIndeterminate	bool	false	To manually set indeterminate to the radio.

RadioIndicator

Contains all Indicator related layout style props and actions. It inherits all the properties of React Native's View component.

RadioIcon

Contains all Icon related layout style props and actions. It inherits all the properties of gluestack Style's AsForwarder component.

RadioLabel

Contains all Label related layout style props and actions. It inherits all the properties of React Native's Text component.

RadioGroup

Contains all Group related layout style props and actions. It inherits all the properties of React Native's View component.

Prop	Type	Default	Description
value	string	-	The value of the radio group.
onChange	function	-	The callback fired when any children Radio is checked or unchecked.
isReadOnly	bool	false	To manually set read-only to the radio group.

Features

Keyboard support for actions.
Support for hover, focus and active states.

Accessibility

We have outlined the various features that ensure the Radio component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. Adheres to the WAI-ARIA design pattern.

Keyboard

Tab: Moves focus to the next focusable element.
Shift + Tab: Moves focus to the previous focusable element.
Space: To check or uncheck focused radio.

VoiceOver: When the radio is focused, the screen reader will announce it's a radio and it's current state (check or uncheck) and it's label.

Focus Management

The onFocus and onBlur props manage focus states and provide visual cues to users. This is especially important for users who rely on keyboard navigation.

States

In error state, aria-invalid will be passed to indicate that the radio input has an error, and providing support for an aria-errormessage to describe the error in more detail.
In disabled state, aria-hidden will be passed to make radio input not focusable.
In required state, aria-required will be passed to indicate that the radio input is required.

Props

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

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.

Multiple Radio

Radio buttons provide a mutually exclusive selection mechanism, allowing users to choose a single option from a set of related choices.

function App() {
  const [values, setValues] = React.useState("Eng")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <VStack space="sm">
        <Radio value="Eng">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>English</RadioLabel>
        </Radio>
        <Radio value="Fre">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>French</RadioLabel>
        </Radio>
        <Radio value="Ger">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>German</RadioLabel>
        </Radio>
      </VStack>
    </RadioGroup>
  )
}

Horizontal

Radio buttons can be used horizontally.

function App() {
  const [values, setValues] = React.useState("Cash On Delivery")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <HStack space="2xl">
        <Radio value="Credit Card">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Credit Card</RadioLabel>
        </Radio>
        <Radio value="Cash On Delivery">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Cash On Delivery</RadioLabel>
        </Radio>
      </HStack>
    </RadioGroup>
  )
}

With help text

Radio buttons can be used with helper text.

function App() {
  const [values, setValues] = React.useState("Read-only")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <VStack space="2xl">
        <Box>
          <Radio value="Read-only" size="md">
            <RadioIndicator>
              <RadioIcon as={CircleIcon} />
            </RadioIndicator>
            <RadioLabel>Extended coverage</RadioLabel>
          </Radio>
          <Text size="$sm" className="ml-7 text-typography-500">
            Extra services included
          </Text>
        </Box>
        <Box>
          <Radio value="Write" size="md">
            <RadioIndicator>
              <RadioIcon as={CircleIcon} />
            </RadioIndicator>
            <RadioLabel>Basic coverage</RadioLabel>
          </Radio>
          <Text size="$sm" className="ml-7 text-typography-500">
            Nothing extra included
          </Text>
        </Box>
      </VStack>
    </RadioGroup>
  )
}

Form Control

Radio buttons can be used inside FormControl for better control of states and functionality.

<FormControl>
  <VStack space="md">
    <Heading size="sm">Which time slot works best for you?</Heading>
    <RadioGroup>
      <VStack space="sm">
        <Radio value="Monday" size="md">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Monday</RadioLabel>
        </Radio>
        <Radio value="Tuesday" size="md">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Tuesday</RadioLabel>
        </Radio>
        <Radio value="Wednesday" size="md">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Wednesday</RadioLabel>
        </Radio>
      </VStack>
    </RadioGroup>
    <Text className="text-sm text-light-500">
      Choose a time slot for the meeting
    </Text>
  </VStack>
</FormControl>

Label left

Radio buttons can be used horizontally

function App() {
  const [values, setValues] = React.useState("Monday")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <VStack space="lg" className="w-40">
        <Radio value="Monday" className="justify-between">
          <RadioLabel>Jane Cooper</RadioLabel>
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
        </Radio>
        <Radio value="Tuesday" className="justify-between">
          <RadioLabel>Wade Warren</RadioLabel>
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
        </Radio>
      </VStack>
    </RadioGroup>
  )
}

Controlled

The Radio components can be used with a controlled state, enabling precise management of the selected option through external state management.

function App() {
  const [values, setValues] = React.useState("Apartments")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <VStack space="md">
        <Radio value="Apartments">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Apartments</RadioLabel>
        </Radio>
        <Radio value="Houses">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Houses</RadioLabel>
        </Radio>
      </VStack>
    </RadioGroup>
  )
}

Uncontrolled

The Radio components can be used with either a ref or no state, providing an uncontrolled state where the selected option is managed internally.

function App() {
  const radioRef = React.useRef(null)
  const handleRadioChange = (e) => {
    e.preventDefault()
    const checkboxValue = radioRef.current.checked
  }
  return (
    <RadioGroup>
      <VStack space="md">
        <Radio value="Hotels" ref={radioRef} onChange={handleRadioChange}>
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Hotels</RadioLabel>
        </Radio>
        <Radio
          value="Living quarters"
          ref={radioRef}
          onChange={handleRadioChange}
        >
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Living quarters</RadioLabel>
        </Radio>
      </VStack>
    </RadioGroup>
  )
}

Radio group

The Radio group component allows users to group radio and display them in a horizontal or vertical row for better visual representation and functionality.

function RadioGroupExample() {
  const [values, setValues] = React.useState("1st")
  return (
    <RadioGroup value={values} onChange={setValues}>
      <VStack space="sm">
        <Radio value="1st">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Label 1</RadioLabel>
        </Radio>
        <Radio value="2nd">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Label 2</RadioLabel>
        </Radio>
        <Radio value="3rd">
          <RadioIndicator>
            <RadioIcon as={CircleIcon} />
          </RadioIndicator>
          <RadioLabel>Label 3</RadioLabel>
        </Radio>
      </VStack>
    </RadioGroup>
  )
}

Radio

Installation

Run the following command:

Step 1: Install the following dependencies:

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

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

API Reference

Component Props

Radio

RadioIndicator

RadioIcon

RadioLabel

RadioGroup

Features

Accessibility

Keyboard

Screen Reader

Focus Management

States

Props

Examples

Multiple Radio

Horizontal

With help text

Form Control

Label left

Controlled

Uncontrolled

Radio group