Alert

Status indicators notify users of important system, feature, or page conditions that require attention.

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

action

variant

<Alert action="muted" variant="solid">
  <AlertIcon as={InfoIcon} />
  <AlertText>Description of alert!</AlertText>
</Alert>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add alert

Step 1: Install the following dependencies:

npm i @gluestack-ui/alert

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

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

const SCOPE = "ALERT"

const alertStyle = tva({
  base: "items-center py-3 px-4 rounded-md flex-row gap-2 border-outline-100",

  variants: {
    action: {
      error: "bg-background-error",
      warning: "bg-background-warning",
      success: "bg-background-success",
      info: "bg-background-info",
      muted: "bg-background-muted",
    },

    variant: {
      solid: "",
      outline: "border bg-background-0",
    },
  },
})

const alertTextStyle = tva({
  base: "flex-1 font-normal font-body",

  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-md",
      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",
    },
  },
  parentVariants: {
    action: {
      error: "text-error-800",
      warning: "text-warning-800",
      success: "text-success-800",
      info: "text-info-800",
      muted: "text-background-800",
    },
  },
})

const alertIconStyle = tva({
  base: "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",
    },
  },
  parentVariants: {
    action: {
      error: "text-error-800",
      warning: "text-warning-800",
      success: "text-success-800",
      info: "text-info-800",
      muted: "text-secondary-800",
    },
  },
})

type IPrimitiveIcon = React.ComponentPropsWithoutRef<typeof Svg> & {
  height?: number | string
  width?: number | string
  fill?: string
  color?: string
  size?: number | string
  stroke?: string
  as?: React.ElementType
  className?: string
  classNameColor?: string
}
const PrimitiveIcon = React.forwardRef<
  React.ElementRef<typeof Svg>,
  IPrimitiveIcon
>(
  (
    {
      height,
      width,
      fill,
      color,
      classNameColor,
      size,
      stroke,
      as: AsComp,
      ...props
    },
    ref
  ) => {
    color = color ?? classNameColor
    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])

    let colorProps = {}
    if (fill) {
      colorProps = { ...colorProps, fill: fill }
    }
    if (stroke !== "currentColor") {
      colorProps = { ...colorProps, stroke: stroke }
    } else if (stroke === "currentColor" && color !== undefined) {
      colorProps = { ...colorProps, stroke: color }
    }

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

const IconWrapper = React.forwardRef<
  React.ElementRef<typeof PrimitiveIcon>,
  IPrimitiveIcon
>(({ ...props }, ref) => {
  return <PrimitiveIcon {...props} ref={ref} />
})

export const UIAlert = createAlert({
  Root: withStyleContext(View, SCOPE),
  Text: Text,
  Icon: IconWrapper,
})

cssInterop(UIAlert, { className: "style" })
//@ts-ignore
cssInterop(UIAlert.Text, { className: "style" })
//@ts-ignore
cssInterop(IconWrapper, {
  className: {
    target: "style",
    nativeStyleToProp: {
      height: true,
      width: true,
      //@ts-ignore
      fill: true,
      color: "classNameColor",
      stroke: true,
    },
  },
})

type IAlertProps = Omit<
  React.ComponentPropsWithoutRef<typeof UIAlert>,
  "context"
> &
  VariantProps<typeof alertStyle>

const Alert = React.forwardRef<React.ElementRef<typeof UIAlert>, IAlertProps>(
  ({ className, variant = "solid", action = "muted", ...props }, ref) => {
    return (
      <UIAlert
        className={alertStyle({ action, variant, class: className })}
        context={{ variant, action }}
        ref={ref}
        {...props}
      />
    )
  }
)

type IAlertTextProps = React.ComponentPropsWithoutRef<typeof UIAlert.Text> &
  VariantProps<typeof alertTextStyle>

const AlertText = React.forwardRef<
  React.ElementRef<typeof UIAlert.Text>,
  IAlertTextProps
>(
  (
    {
      className,
      isTruncated,
      bold,
      underline,
      strikeThrough,
      size = "md",
      sub,
      italic,
      highlight,
      ...props
    },
    ref
  ) => {
    const { action: parentAction } = useStyleContext(SCOPE)
    return (
      <UIAlert.Text
        className={alertTextStyle({
          isTruncated,
          bold,
          underline,
          strikeThrough,
          size,
          sub,
          italic,
          highlight,
          class: className,
          parentVariants: {
            action: parentAction,
          },
        })}
        {...props}
        ref={ref}
      />
    )
  }
)

type IAlertIconProps = React.ComponentPropsWithoutRef<typeof UIAlert.Icon> &
  VariantProps<typeof alertIconStyle>

const AlertIcon = React.forwardRef<
  React.ElementRef<typeof UIAlert.Icon>,
  IAlertIconProps
>(({ className, size = "md", ...props }, ref) => {
  const { action: parentAction } = useStyleContext(SCOPE)

  if (typeof size === "number") {
    return (
      <UIAlert.Icon
        ref={ref}
        {...props}
        className={alertIconStyle({ class: className })}
        size={size}
      />
    )
  } else if (
    (props.height !== undefined || props.width !== undefined) &&
    size === undefined
  ) {
    return (
      <UIAlert.Icon
        ref={ref}
        {...props}
        className={alertIconStyle({ class: className })}
      />
    )
  }
  return (
    <UIAlert.Icon
      className={alertIconStyle({
        parentVariants: {
          action: parentAction,
        },
        size,
        class: className,
      })}
      {...props}
      ref={ref}
    />
  )
})

Alert.displayName = "Alert"
AlertText.displayName = "AlertText"
AlertIcon.displayName = "AlertIcon"

export { Alert, AlertText, AlertIcon }

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 { Alert, AlertIcon, AlertText } from "@/components/ui/alert"

export default () => (
  <Alert>
    <AlertIcon />
    <AlertText />
  </Alert>
)

Component Props

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

Alert

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

AlertIcon

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

AlertText

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

Props

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

Alert

Name	Value	Default
action	error \| warning \| success \| info \| muted	info
variant	solid \| outline	solid

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.

Alert with CTA

<Alert
  action="success"
  className="gap-4 max-w-[585px] w-full self-center items-start min-[400px]:items-center"
>
  <VStack className="gap-4 min-[400px]:flex-row justify-between flex-1 min-[400px]:items-center">
    <AlertText className="font-semibold text-typography-900" size="sm">
      Verify your phone number to create an API key
    </AlertText>
    <Button size="sm">
      <ButtonText>Start verification</ButtonText>
    </Button>
  </VStack>
  <Icon as={CloseIcon} />
</Alert>

Alert on cloud sync

<Alert
  action="warning"
  className="gap-4 max-w-[516px] w-full flex-row flex py-4 items-start self-center"
>
  <AlertIcon as={RepeatIcon} className="mt-1" />
  <HStack className="justify-between flex-1 items-center gap-1 sm:gap-8">
    <VStack className="flex-1">
      <Text className="font-semibold text-typography-900">
        Sync is disabled
      </Text>
      <AlertText className="text-typography-900" size="sm">
        Enable cloud sync to help safeguard your data
      </AlertText>
    </VStack>
    <Button size="xs">
      <ButtonText>Turn on</ButtonText>
    </Button>
  </HStack>
</Alert>

Warning alert

<Alert action="error" className="gap-3">
  {/* Bomb is imported from 'lucide-react-native' */}
  <AlertIcon as={Bomb} size="lg" />
  <AlertText className="text-typography-900" size="sm">
    <Text className="mr-2 font-semibold text-typography-900">Heads up:</Text>
    Once done, this action cannot be undone
  </AlertText>
</Alert>

function Example() {
  const [showPassword, setShowPassword] = React.useState(false)
  const handleState = () => {
    setShowPassword((showState) => {
      return !showState
    })
  }
  return (
    <VStack className="gap-5 sm:gap-8 p-6 sm:p-9 border border-outline-200 bg-background-0 rounded-xl shadow-hard-5 w-full max-w-[423px]">
      <VStack className="items-center gap-1">
        <Heading size="xl">Confirm our password?</Heading>
        <Text>johnsmith@gmail.com</Text>
      </VStack>
      <VStack className="gap-3 sm:gap-5">
        <Input className="rounded-md" size="sm">
          <InputField
            type={showPassword ? "text" : "password"}
            placeholder="Enter password"
          />
          <InputSlot className="mr-3" onPress={handleState}>
            {/* EyeIcon, EyeOffIcon are both imported from 'lucide-react-native' */}
            <InputIcon
              size="xs"
              as={showPassword ? EyeIcon : EyeOffIcon}
              className="stroke-background-600"
            />
          </InputSlot>
        </Input>
        <Button className="w-full rounded-md" size="sm">
          <ButtonText>Confirm</ButtonText>
        </Button>
      </VStack>
      <Alert className="items-start" action="muted">
        <AlertIcon as={InfoIcon} size="xs" className="stroke-background-500" />
        <AlertText className="text-typography-600" size="xs">
          Minimum 8 characters, with at least 1 uppercase, 1 lowercase, and 1
          number required.
        </AlertText>
      </Alert>
    </VStack>
  )
}

Alert

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

Alert

AlertIcon

AlertText

Props

Alert

Examples

Alert with CTA

Alert on cloud sync

Warning alert

Alert on confirm password modal