AlertDialog

Prompt users to take action with interruptions for confirmations or important prompts.

Installation

API Reference

This is an illustration of AlertDialog component.

size

function Example() {
  const [showAlertDialog, setShowAlertDialog] = React.useState(false)
  const handleClose = () => setShowAlertDialog(false)
  return (
    <>
      <Button onPress={() => setShowAlertDialog(true)}>
        <ButtonText>Open Dialog</ButtonText>
      </Button>
      <AlertDialog isOpen={showAlertDialog} onClose={handleClose} size="md">
        <AlertDialogBackdrop />
        <AlertDialogContent>
          <AlertDialogHeader>
            <Heading className="text-typography-950 font-semibold" size="md">
              Are you sure you want to delete this post?
            </Heading>
          </AlertDialogHeader>
          <AlertDialogBody className="mt-3 mb-4">
            <Text size="sm">
              Deleting the post will remove it permanently and cannot be undone.
              Please confirm if you want to proceed.
            </Text>
          </AlertDialogBody>
          <AlertDialogFooter className="">
            <Button
              variant="outline"
              action="secondary"
              onPress={handleClose}
              size="sm"
            >
              <ButtonText>Cancel</ButtonText>
            </Button>
            <Button size="sm" onPress={handleClose}>
              <ButtonText>Delete</ButtonText>
            </Button>
          </AlertDialogFooter>
        </AlertDialogContent>
      </AlertDialog>
    </>
  )
}

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add alert-dialog

Step 1: Install the following dependencies:

npm i @gluestack-ui/alert-dialog @legendapp/motion

Important Note

Note: At present, we have integrated the @legendapp/motion for animation. You have the option to remove this and implement your own custom animation wrapper.

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

"use client"
import React from "react"
import { createAlertDialog } from "@gluestack-ui/alert-dialog"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { withStyleContextAndStates } from "@gluestack-ui/nativewind-utils/withStyleContextAndStates"
import { cssInterop } from "nativewind"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"
import {
  Motion,
  AnimatePresence,
  createMotionAnimatedComponent,
} from "@legendapp/motion"
import { View, Pressable, ScrollView, Platform } from "react-native"

const AnimatedPressable = createMotionAnimatedComponent(Pressable)

const SCOPE = "ALERT_DIALOG"

const UIAccessibleAlertDialog = createAlertDialog({
  Root:
    Platform.OS === "web"
      ? withStyleContext(View, SCOPE)
      : withStyleContextAndStates(View, SCOPE),
  Body: ScrollView,
  Content: Motion.View,
  CloseButton: Pressable,
  Header: View,
  Footer: View,
  Backdrop: AnimatedPressable,
  AnimatePresence: AnimatePresence,
})

cssInterop(UIAccessibleAlertDialog, { className: "style" })
cssInterop(UIAccessibleAlertDialog.Content, { className: "style" })
cssInterop(UIAccessibleAlertDialog.CloseButton, { className: "style" })
cssInterop(UIAccessibleAlertDialog.Header, { className: "style" })
cssInterop(UIAccessibleAlertDialog.Footer, { className: "style" })
cssInterop(UIAccessibleAlertDialog.Body, {
  className: "style",
  contentContainerClassName: "contentContainerStyle",
  indicatorClassName: "indicatorStyle",
})
cssInterop(UIAccessibleAlertDialog.Backdrop, { className: "style" })

const alertDialogStyle = tva({
  base: "group/modal w-full h-full justify-center items-center web:pointer-events-none",
  parentVariants: {
    size: {
      xs: "",
      sm: "",
      md: "",
      lg: "",
      full: "",
    },
  },
})

const alertDialogContentStyle = tva({
  base: "bg-background-0 rounded-lg overflow-hidden border border-outline-100 p-6",
  parentVariants: {
    size: {
      xs: "w-[60%] max-w-[360px]",
      sm: "w-[70%] max-w-[420px]",
      md: "w-[80%] max-w-[510px]",
      lg: "w-[90%] max-w-[640px]",
      full: "w-full",
    },
  },
})

const alertDialogCloseButtonStyle = tva({
  base: "group/alert-dialog-close-button z-10 rounded-sm p-2 data-[focus-visible=true]:bg-background-100 web:cursor-pointer outline-0",
})

const alertDialogHeaderStyle = tva({
  base: "justify-between items-center flex-row",
})

const alertDialogFooterStyle = tva({
  base: "flex-row justify-end items-center gap-3",
})

const alertDialogBodyStyle = tva({ base: "" })

const alertDialogBackdropStyle = tva({
  base: "absolute left-0 top-0 right-0 bottom-0 bg-background-dark web:cursor-default",
})

type IAlertDialogProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog
> &
  VariantProps<typeof alertDialogStyle>

type IAlertDialogContentProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.Content
> &
  VariantProps<typeof alertDialogContentStyle> & { className?: string }

type IAlertDialogCloseButtonProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.CloseButton
> &
  VariantProps<typeof alertDialogCloseButtonStyle>

type IAlertDialogHeaderProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.Header
> &
  VariantProps<typeof alertDialogHeaderStyle>

type IAlertDialogFooterProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.Footer
> &
  VariantProps<typeof alertDialogFooterStyle>

type IAlertDialogBodyProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.Body
> &
  VariantProps<typeof alertDialogBodyStyle>

type IAlertDialogBackdropProps = React.ComponentPropsWithoutRef<
  typeof UIAccessibleAlertDialog.Backdrop
> &
  VariantProps<typeof alertDialogBackdropStyle> & { className?: string }

const AlertDialog = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog>,
  IAlertDialogProps
>(({ className, size = "md", ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog
      ref={ref}
      {...props}
      className={alertDialogStyle({ class: className })}
      context={{ size }}
      pointerEvents="box-none"
    />
  )
})

const AlertDialogContent = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.Content>,
  IAlertDialogContentProps
>(({ className, size, ...props }, ref) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  return (
    <UIAccessibleAlertDialog.Content
      pointerEvents="auto"
      ref={ref}
      initial={{
        scale: 0.9,
        opacity: 0,
      }}
      animate={{
        scale: 1,
        opacity: 1,
      }}
      exit={{
        scale: 0.9,
        opacity: 0,
      }}
      transition={{
        type: "spring",
        damping: 18,
        stiffness: 250,
        opacity: {
          type: "timing",
          duration: 250,
        },
      }}
      {...props}
      className={alertDialogContentStyle({
        parentVariants: {
          size: parentSize,
        },
        size,
        class: className,
      })}
    />
  )
})

const AlertDialogCloseButton = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.CloseButton>,
  IAlertDialogCloseButtonProps
>(({ className, ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog.CloseButton
      ref={ref}
      {...props}
      className={alertDialogCloseButtonStyle({
        class: className,
      })}
    />
  )
})

const AlertDialogHeader = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.Header>,
  IAlertDialogHeaderProps
>(({ className, ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog.Header
      ref={ref}
      {...props}
      className={alertDialogHeaderStyle({
        class: className,
      })}
    />
  )
})

const AlertDialogFooter = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.Footer>,
  IAlertDialogFooterProps
>(({ className, ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog.Footer
      ref={ref}
      {...props}
      className={alertDialogFooterStyle({
        class: className,
      })}
    />
  )
})

const AlertDialogBody = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.Body>,
  IAlertDialogBodyProps
>(({ className, ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog.Body
      ref={ref}
      {...props}
      className={alertDialogBodyStyle({
        class: className,
      })}
    />
  )
})

const AlertDialogBackdrop = React.forwardRef<
  React.ElementRef<typeof UIAccessibleAlertDialog.Backdrop>,
  IAlertDialogBackdropProps
>(({ className, ...props }, ref) => {
  return (
    <UIAccessibleAlertDialog.Backdrop
      ref={ref}
      initial={{
        opacity: 0,
      }}
      animate={{
        opacity: 0.5,
      }}
      exit={{
        opacity: 0,
      }}
      transition={{
        type: "spring",
        damping: 18,
        stiffness: 250,
        opacity: {
          type: "timing",
          duration: 250,
        },
      }}
      {...props}
      className={alertDialogBackdropStyle({
        class: className,
      })}
    />
  )
})

AlertDialog.displayName = "AlertDialog"
AlertDialogContent.displayName = "AlertDialogContent"
AlertDialogCloseButton.displayName = "AlertDialogCloseButton"
AlertDialogHeader.displayName = "AlertDialogHeader"
AlertDialogFooter.displayName = "AlertDialogFooter"
AlertDialogBody.displayName = "AlertDialogBody"
AlertDialogBackdrop.displayName = "AlertDialogBackdrop"

export {
  AlertDialog,
  AlertDialogContent,
  AlertDialogCloseButton,
  AlertDialogHeader,
  AlertDialogFooter,
  AlertDialogBody,
  AlertDialogBackdrop,
}

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 {
  AlertDialog,
  AlertDialogBackdrop,
  AlertDialogContent,
  AlertDialogHeader,
  AlertDialogCloseButton,
  AlertDialogFooter,
  AlertDialogBody,
} from "@/components/ui/alert-dialog"

export default () => (
  <AlertDialog>
    <AlertDialogBackdrop />
    <AlertDialogContent>
      <AlertDialogHeader>
        <AlertDialogCloseButton />
      </AlertDialogHeader>
      <AlertDialogBody />
      <AlertDialogFooter />
    </AlertDialogContent>
  </AlertDialog>
)

Component Props

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

AlertDialog

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

Prop	Type	Default	Description
isOpen	boolean	false	If true, the alert-dialog will open. Useful for controllable state behavior.
onClose	() => any	-	Callback invoked when the alert-dialog is closed.
useRNModal	boolean	false	If true, renders react-native native modal. (Only works in react-native)
defaultIsOpen	boolean	false	Specifies the default open state of the AlertDialog
initialFocusRef	React.RefObject<any>	-	The ref of element to receive focus when the alert-dialog opens.
finalFocusRef	React.RefObject<any>	-	The ref of element to receive focus when the alert-dialog closes.
avoidKeyboard	boolean	-	If true, the AlertDialog will avoid the keyboard.
closeOnOverlayClick	boolean	true	If true, the AlertDialog will close when the overlay is clicked.
isKeyboardDismissable	boolean	true	If true, the keyboard can dismiss the AlertDialog

AlertDialogBackdrop

It is React Native's Pressable component, created using @legendapp/motion's createMotionAnimatedComponent function to add animation to the component. You can use any declarative animation library you prefer.

AlertDialogContent

It is @legendapp/motion's Motion.View component. You can use any declarative animation library you prefer.

AlertDialogCloseButton

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

AlertDialogHeader

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

AlertDialogBody

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

AlertDialogFooter

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

Features

Keyboard support for actions.

Accessibility

We have outlined the various features that ensure the AlertDialog component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards.It uses React Native ARIA @react-native-aria/focus which follows the WAI-ARIA Alert and Message Dialogs Pattern.

Keyboard

Tab:
- Moves focus to the next tabbable element inside the dialog.
- If focus is on the last tabbable element inside the dialog, moves focus to the first tabbable element inside the dialog.
Shift + Tab:
- Moves focus to the previous tabbable element inside the dialog.
- If focus is on the first tabbable element inside the dialog, moves focus to the last tabbable element inside the dialog.
Escape: Closes the dialog.

VoiceOver: When the button is focused, the screen reader will announce the button's label and provide instructions on how to click it. When the alert dialog is triggered, the screen reader will read its content.

States

When the alert dialog is triggered, aria-modal="true" is added to the alert dialog content. This attribute informs assistive technologies that the windows underneath the current alert dialog are not available for interaction(inert).

Props

AlertDialog component is created using View component from react-native. It extends all the props supported by React Native View, and the props mentioned below.

AlertDialog

Name	Value	Default
size	xs \| sm \| md \| lg \| full	md

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.

AlertDialog with image

function Example() {
  const [showAlertDialog, setShowAlertDialog] = React.useState(false)
  const handleClose = () => setShowAlertDialog(false)
  return (
    <>
      <Button onPress={() => setShowAlertDialog(true)}>
        <ButtonText>Pay</ButtonText>
      </Button>
      <AlertDialog isOpen={showAlertDialog} onClose={handleClose}>
        <AlertDialogBackdrop />
        <AlertDialogContent className="p-0 max-w-[590px] sm:flex-row border-primary-800 rounded-xl">
          <Box className="bg-primary-600 min-w-[123px] items-center justify-center py-4 sm:py-0">
            <Image
              source={{
                uri: "https://s3-alpha-sig.figma.com/img/e102/c0d3/7d9780cf2bbdcce3142cbe98fb9c6d6e?Expires=1722211200&Key-Pair-Id=APKAQ4GOSFWCVNEHN3O4&Signature=dcv50VxIIiZhgk7eFIXeeXuIB8IvftOJ6AmQNB0aDmgTXSH3Ph1vQHftectHl91sTPpuGXPWh~B0yVfarBPjq8E-m1o4XqGE4E5EMoSraKMLpWbmkbqeHrI43wt1qQPZIy91~VvJnh~j4Srb8SIpVyKUfJ7rGWfn~umxyBBH7C-04kXgt7RYswh61lswlKugYb8BmO7VYijmjcqTHvnnajNGdjCJM9GH5AaZVGjnQaJfY6whJpjbvpu7qjWQwh2NUh6OlBQz74kUVEg8OeuUcwAA5dd6HIY0plf7o3q7Cq5x35J6oUN30HY1TZ9l2b9fg14~EUkA8apLV1XM3Lad-Q__",
              }}
              alt="image"
              className="h-[95px] w-[95px]"
            />
          </Box>
          <AlertDialogBody
            className=""
            contentContainerClassName="p-6 flex-row justify-between gap-6 md:gap-9 items-center"
          >
            <VStack>
              <Heading
                size="md"
                className="text-typography-950 font-semibold leading-6"
              >
                Get Additional Discount
              </Heading>
              <Text className="pt-2 text-typography-950" size="sm">
                Upgrade your plan before your trial ends yo get 5% discount. Use
                code{" "}
                <Text className="font-bold" size="sm">
                  #PRO005
                </Text>
              </Text>
            </VStack>
            <Button size="sm" className="hidden sm:flex" onPress={handleClose}>
              <ButtonText>Upgrade</ButtonText>
            </Button>
          </AlertDialogBody>
        </AlertDialogContent>
      </AlertDialog>
    </>
  )
}

AlertDialog with icon + cta

function Example() {
  const [showAlertDialog, setShowAlertDialog] = React.useState(false)
  const handleClose = () => setShowAlertDialog(false)
  return (
    <>
      <Button onPress={() => setShowAlertDialog(true)}>
        <ButtonText>Upload</ButtonText>
      </Button>
      <AlertDialog isOpen={showAlertDialog} onClose={handleClose}>
        <AlertDialogBackdrop />
        <AlertDialogContent className="p-4 gap-4 max-w-[649px] w-full md:flex-row mx-2">
          <AlertDialogBody
            className=""
            contentContainerClassName="flex-row gap-4"
          >
            <Box className="h-10 min-[350px]:h-14 w-12 min-[350px]:w-14 rounded-full bg-background-50 items-center justify-center">
              <Icon
                as={UploadCloud}
                className="stroke-background-900"
                size="xl"
              />
            </Box>
            <VStack className="gap-1">
              <Heading size="md" className="text-typography-950 font-semibold">
                Cloud storage full!
              </Heading>
              <Text size="sm">You have used up all the storage you have.</Text>
            </VStack>
          </AlertDialogBody>
          <AlertDialogFooter>
            <Button
              variant="outline"
              action="secondary"
              onPress={handleClose}
              size="sm"
            >
              <ButtonText>Cancel</ButtonText>
            </Button>
            <Button size="sm" onPress={handleClose}>
              <ButtonText>Upgrade Storage</ButtonText>
            </Button>
          </AlertDialogFooter>
        </AlertDialogContent>
      </AlertDialog>
    </>
  )
}

AlertDialog with Delete Option

function Example() {
  const [showAlertDialog, setShowAlertDialog] = React.useState(false)
  const handleClose = () => setShowAlertDialog(false)
  return (
    <>
      <Button onPress={() => setShowAlertDialog(true)}>
        <ButtonText>Delete Invoice</ButtonText>
      </Button>
      <AlertDialog isOpen={showAlertDialog} onClose={handleClose}>
        <AlertDialogBackdrop />
        <AlertDialogContent className="w-full max-w-[415px] gap-4 items-center">
          <Box className="rounded-full h-[52px] w-[52px] bg-background-error items-center justify-center">
            <Icon as={TrashIcon} size="lg" className="stroke-error-500" />
          </Box>
          <VStack className="items-center">
            <AlertDialogHeader className="mb-2">
              <Heading size="md">Delete account?</Heading>
            </AlertDialogHeader>
            <AlertDialogBody>
              <Text size="sm" className="text-center">
                The invoice will be deleted from the invoices section and in the
                documents folder. This cannot be undone.
              </Text>
            </AlertDialogBody>
            <AlertDialogFooter className="mt-5">
              <Button
                size="sm"
                action="negative"
                onPress={handleClose}
                className="px-[30px]"
              >
                <ButtonText>Delete</ButtonText>
              </Button>
              <Button
                variant="outline"
                action="secondary"
                onPress={handleClose}
                size="sm"
                className="px-[30px]"
              >
                <ButtonText>Cancel</ButtonText>
              </Button>
            </AlertDialogFooter>
          </VStack>
        </AlertDialogContent>
      </AlertDialog>
    </>
  )
}

AlertDialog

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

AlertDialog

AlertDialogBackdrop

AlertDialogContent

AlertDialogCloseButton

AlertDialogHeader

AlertDialogBody

AlertDialogFooter

Features

Accessibility

Keyboard

Screen Reader

States

Props

AlertDialog

Examples

AlertDialog with image

AlertDialog with icon + cta

AlertDialog with Delete Option