React Alert Component

Alert

React alert component gives contextual feedback information for common user operations. The alert component is delivered with a bunch of usable and adjustable alert messages.

Available in Other JavaScript Frameworks

CoreUI React Alert Component is also available for Angular, Bootstrap, and Vue. Explore framework-specific implementations below:

On this page

Default alert

React Alert is prepared for any length of text, as well as an optional close button. A bare <CAlert> is a neutral alert — a bordered surface that inherits the text color of its surroundings. For inline dismissal, use the dismissing prop.

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertDefaultExample = () => {
  return <CAlert>A simple alert—check it out!</CAlert>
}

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertDefaultExample = () => {
  return <CAlert>A simple alert—check it out!</CAlert>
}

Variants

For a styling, use one of the optional contextual theme props (e.g., primary).

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertExample = () => {
  return (
    <>
      <CAlert theme="primary">A simple primary alert—check it out!</CAlert>
      <CAlert theme="secondary">A simple secondary alert—check it out!</CAlert>
      <CAlert theme="success">A simple success alert—check it out!</CAlert>
      <CAlert theme="danger">A simple danger alert—check it out!</CAlert>
      <CAlert theme="warning">A simple warning alert—check it out!</CAlert>
      <CAlert theme="info">A simple info alert—check it out!</CAlert>
      <CAlert theme="secondary">A simple light alert—check it out!</CAlert>
      <CAlert theme="inverse">A simple dark alert—check it out!</CAlert>
    </>
  )
}

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertExample = () => {
  return (
    <>
      <CAlert theme="primary">A simple primary alert—check it out!</CAlert>
      <CAlert theme="secondary">A simple secondary alert—check it out!</CAlert>
      <CAlert theme="success">A simple success alert—check it out!</CAlert>
      <CAlert theme="danger">A simple danger alert—check it out!</CAlert>
      <CAlert theme="warning">A simple warning alert—check it out!</CAlert>
      <CAlert theme="info">A simple info alert—check it out!</CAlert>
      <CAlert theme="secondary">A simple light alert—check it out!</CAlert>
      <CAlert theme="inverse">A simple dark alert—check it out!</CAlert>
    </>
  )
}

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Please ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.

Live example

Click the button below to show an alert (hidden with inline styles to start), then dismiss (and destroy) it with the built-in close button.

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertLiveExample = () => {
  const [show, setShow] = useState(false)
  return (
    <>
      <CAlert theme="primary" dismissible show={show} onShowChange={setShow}>
        A simple primary alert—check it out!
      </CAlert>
      <CButton theme="primary" onClick={() => setShow(true)}>
        Show live alert
      </CButton>
    </>
  )
}

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertLiveExample = () => {
  const [show, setShow] = useState(false)
  return (
    <>
      <CAlert theme="primary" dismissible show={show} onShowChange={setShow}>
        A simple primary alert—check it out!
      </CAlert>
      <CButton theme="primary" onClick={() => setShow(true)}>
        Show live alert
      </CButton>
    </>
  )
}

Link color

Use the <CAlertLink> component to immediately give matching colored links inside any React alert component.

import React from 'react'
import { CAlert, CAlertLink } from '@coreui/react'

export const AlertLinkColorExample = () => {
  return (
    <>
      <CAlert theme="primary">
        A simple primary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="secondary">
        A simple secondary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="success">
        A simple success alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="danger">
        A simple danger alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="warning">
        A simple warning alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="info">
        A simple info alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
      <CAlert theme="secondary">
        A simple light alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
      <CAlert theme="inverse">
        A simple dark alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
    </>
  )
}

import React from 'react'
import { CAlert, CAlertLink } from '@coreui/react'

export const AlertLinkColorExample = () => {
  return (
    <>
      <CAlert theme="primary">
        A simple primary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="secondary">
        A simple secondary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="success">
        A simple success alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="danger">
        A simple danger alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="warning">
        A simple warning alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a
        click if you like.
      </CAlert>
      <CAlert theme="info">
        A simple info alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
      <CAlert theme="secondary">
        A simple light alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
      <CAlert theme="inverse">
        A simple dark alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click
        if you like.
      </CAlert>
    </>
  )
}

Additional content

React Alert can also incorporate supplementary components & elements like heading, paragraph, and divider. The alert lays its children out in a row, so wrap them in a .vstack to keep them stacked.

import React from 'react'
import { CAlert, CAlertHeading } from '@coreui/react'

export const AlertAdditionalContentExample = () => {
  return (
    <CAlert theme="success">
      <div className="vstack">
        <CAlertHeading as="h4">Well done!</CAlertHeading>
        <p>
          Aww yeah, you successfully read this important alert message. This example text is going
          to run a bit longer so that you can see how spacing within an alert works with this kind
          of content.
        </p>
        <hr />
        <p className="mb-0">
          Whenever you need to, be sure to use margin utilities to keep things nice and tidy.
        </p>
      </div>
    </CAlert>
  )
}

import React from 'react'
import { CAlert, CAlertHeading } from '@coreui/react'

export const AlertAdditionalContentExample = () => {
  return (
    <CAlert theme="success">
      <div className="vstack">
        <CAlertHeading as="h4">Well done!</CAlertHeading>
        <p>
          Aww yeah, you successfully read this important alert message. This example text is going
          to run a bit longer so that you can see how spacing within an alert works with this kind
          of content.
        </p>
        <hr />
        <p className="mb-0">
          Whenever you need to, be sure to use margin utilities to keep things nice and tidy.
        </p>
      </div>
    </CAlert>
  )
}

Icons

Put an icon straight into the alert — it lays its children out in a row and spaces them with --cui-alert-gap, so no flexbox utilities are needed. Use CoreUI Icons or any inline SVG.

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertIcons1Example = () => {
  return (
    <CAlert theme="primary">
      <svg className="flex-shrink-0" width="24" height="24" viewBox="0 0 512 512">
        <rect
          width="32"
          height="176"
          x="240"
          y="176"
          fill="var(--ci-primary-color, currentColor)"
          className="ci-primary"
        ></rect>
        <rect
          width="32"
          height="32"
          x="240"
          y="384"
          fill="var(--ci-primary-color, currentColor)"
          className="ci-primary"
        ></rect>
        <path
          fill="var(--ci-primary-color, currentColor)"
          d="M274.014,16H237.986L16,445.174V496H496V445.174ZM464,464H48V452.959L256,50.826,464,452.959Z"
          className="ci-primary"
        ></path>
      </svg>
      <div>An example alert with an icon</div>
    </CAlert>
  )
}

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertIcons1Example = () => {
  return (
    <CAlert theme="primary">
      <svg className="flex-shrink-0" width="24" height="24" viewBox="0 0 512 512">
        <rect
          width="32"
          height="176"
          x="240"
          y="176"
          fill="var(--ci-primary-color, currentColor)"
          className="ci-primary"
        ></rect>
        <rect
          width="32"
          height="32"
          x="240"
          y="384"
          fill="var(--ci-primary-color, currentColor)"
          className="ci-primary"
        ></rect>
        <path
          fill="var(--ci-primary-color, currentColor)"
          d="M274.014,16H237.986L16,445.174V496H496V445.174ZM464,464H48V452.959L256,50.826,464,452.959Z"
          className="ci-primary"
        ></path>
      </svg>
      <div>An example alert with an icon</div>
    </CAlert>
  )
}

Need more than one icon for your React alerts? Consider using CoreUI Icons.

import React from 'react'
import { CAlert } from '@coreui/react'
import CIcon from '@coreui/icons-react'
import { cilBurn, cilCheckCircle, cilInfo, cilWarning } from '@coreui/icons'

export const AlertIcons2Example = () => {
  return (
    <>
      <CAlert theme="primary">
        <CIcon icon={cilInfo} className="flex-shrink-0" width={24} height={24} />
        <div>An example alert with an icon</div>
      </CAlert>
      <CAlert theme="success">
        <CIcon icon={cilCheckCircle} className="flex-shrink-0" width={24} height={24} />
        <div>An example success alert with an icon</div>
      </CAlert>
      <CAlert theme="warning">
        <CIcon icon={cilWarning} className="flex-shrink-0" width={24} height={24} />
        <div>An example warning alert with an icon</div>
      </CAlert>
      <CAlert theme="danger">
        <CIcon icon={cilBurn} className="flex-shrink-0" width={24} height={24} />
        <div>An example danger alert with an icon</div>
      </CAlert>
    </>
  )
}

import React from 'react'
import { CAlert } from '@coreui/react'
import CIcon from '@coreui/icons-react'
import { cilBurn, cilCheckCircle, cilInfo, cilWarning } from '@coreui/icons'

export const AlertIcons2Example = () => {
  return (
    <>
      <CAlert theme="primary">
        <CIcon icon={cilInfo} className="flex-shrink-0" width={24} height={24} />
        <div>An example alert with an icon</div>
      </CAlert>
      <CAlert theme="success">
        <CIcon icon={cilCheckCircle} className="flex-shrink-0" width={24} height={24} />
        <div>An example success alert with an icon</div>
      </CAlert>
      <CAlert theme="warning">
        <CIcon icon={cilWarning} className="flex-shrink-0" width={24} height={24} />
        <div>An example warning alert with an icon</div>
      </CAlert>
      <CAlert theme="danger">
        <CIcon icon={cilBurn} className="flex-shrink-0" width={24} height={24} />
        <div>An example danger alert with an icon</div>
      </CAlert>
    </>
  )
}

Solid

Added in v6.0.0

Use variant="solid" for a high-contrast alert. The background takes the theme color and the text takes the color that reads on it, so a yellow alert gets dark text and a dark one gets light text without you picking either.

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertSolidExample = () => {
  return (
    <>
      <CAlert theme="primary" variant="solid">
        A simple solid primary alert—check it out!
      </CAlert>
      <CAlert theme="secondary" variant="solid">
        A simple solid secondary alert—check it out!
      </CAlert>
      <CAlert theme="success" variant="solid">
        A simple solid success alert—check it out!
      </CAlert>
      <CAlert theme="danger" variant="solid">
        A simple solid danger alert—check it out!
      </CAlert>
      <CAlert theme="warning" variant="solid">
        A simple solid warning alert—check it out!
      </CAlert>
      <CAlert theme="info" variant="solid">
        A simple solid info alert—check it out!
      </CAlert>
      <CAlert theme="secondary" variant="solid">
        A simple solid light alert—check it out!
      </CAlert>
      <CAlert theme="inverse" variant="solid">
        A simple solid dark alert—check it out!
      </CAlert>
    </>
  )
}

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertSolidExample = () => {
  return (
    <>
      <CAlert theme="primary" variant="solid">
        A simple solid primary alert—check it out!
      </CAlert>
      <CAlert theme="secondary" variant="solid">
        A simple solid secondary alert—check it out!
      </CAlert>
      <CAlert theme="success" variant="solid">
        A simple solid success alert—check it out!
      </CAlert>
      <CAlert theme="danger" variant="solid">
        A simple solid danger alert—check it out!
      </CAlert>
      <CAlert theme="warning" variant="solid">
        A simple solid warning alert—check it out!
      </CAlert>
      <CAlert theme="info" variant="solid">
        A simple solid info alert—check it out!
      </CAlert>
      <CAlert theme="secondary" variant="solid">
        A simple solid light alert—check it out!
      </CAlert>
      <CAlert theme="inverse" variant="solid">
        A simple solid dark alert—check it out!
      </CAlert>
    </>
  )
}

Dismissing

React Alert component can also be easily dismissed. Just add the dismissible prop.

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertDismissingExample = () => {
  return (
    <CAlert
      theme="warning"
      dismissible
      onClose={() => {
        alert('👋 Well, hi there! Thanks for dismissing me.')
      }}
    >
      <strong>Go right ahead</strong> and click that dismiss over there on the right.
    </CAlert>
  )
}

import React from 'react'
import { CAlert } from '@coreui/react'

export const AlertDismissingExample = () => {
  return (
    <CAlert
      theme="warning"
      dismissible
      onClose={() => {
        alert('👋 Well, hi there! Thanks for dismissing me.')
      }}
    >
      <strong>Go right ahead</strong> and click that dismiss over there on the right.
    </CAlert>
  )
}

Added in v6.0.0

An alert also makes room for a <CCloseButton /> you render as its direct child, so your own close button is positioned without the dismissible prop. It has to be a direct child to be pushed to the end of the alert — one nested in a wrapper is laid out by that wrapper like any other content.

An alert rendered with transition fades in when it is added to the page, not only out when it is dismissed.

When an alert is dismissed, the element is completely removed from the page structure. If a keyboard user dismisses the alert using the close button, their focus will suddenly be lost and, depending on the browser, reset to the start of the page/document.

transition={false} renders the alert with .alert-instant, so it is dismissed at once with no fade. The fade itself can be retimed with --cui-alert-transition-duration and --cui-alert-transition-timing.

Collapse the box as well

Added in v6.0.0

transition="size" animates the alert’s height, padding, borders and margin alongside the opacity, so the content below rises into its place instead of jumping once the alert is gone — and grows from nothing when the alert arrives. It takes interpolate-size, so in a browser without it the alert fades in place as usual.

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertSizeExample = () => {
  const [show, setShow] = useState(true)
  return (
    <>
      <CAlert theme="info" dismissible show={show} onShowChange={setShow} transition="size">
        This alert takes its box with it, so the button below moves with the animation.
      </CAlert>
      <CButton theme="primary" onClick={() => setShow(true)}>
        Show the alert again
      </CButton>
    </>
  )
}

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertSizeExample = () => {
  const [show, setShow] = useState(true)
  return (
    <>
      <CAlert theme="info" dismissible show={show} onShowChange={setShow} transition="size">
        This alert takes its box with it, so the button below moves with the animation.
      </CAlert>
      <CButton theme="primary" onClick={() => setShow(true)}>
        Show the alert again
      </CButton>
    </>
  )
}

Controlled and uncontrolled

Added in v6.0.0

The alert works either way, and the prop you reach for is what picks the mode.

	prop	who owns the visibility
Uncontrolled	`defaultShow`	the alert, from that starting point
Controlled	`show`	your component

onShowChange fires in both modes whenever the alert requests a visibility change — the dismiss button or, in uncontrolled mode, any internal toggle. The deprecated visible prop keeps its old behavior and is ignored when defaultShow or show is set.

Uncontrolled

An alert starts visible on its own; seed defaultShow={false} for one that appears later. A dismissed uncontrolled alert removes itself, exactly as the examples above do.

<CAlert theme="primary" dismissible defaultShow>

Controlled

Pass show and the alert renders exactly what you pass — the dismiss button only calls onShowChange. Because the state lives outside, a dismissed alert can come back.

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertControlledExample = () => {
  const [show, setShow] = useState(true)

  return (
    <>
      <CAlert theme="primary" dismissible show={show} onShowChange={setShow}>
        A controlled alert — the open state lives outside, so it can come back.
      </CAlert>
      <CButton theme="primary" disabled={show} onClick={() => setShow(true)}>
        Restore the alert
      </CButton>
    </>
  )
}

import React, { useState } from 'react'
import { CAlert, CButton } from '@coreui/react'

export const AlertControlledExample = () => {
  const [show, setShow] = useState(true)

  return (
    <>
      <CAlert theme="primary" dismissible show={show} onShowChange={setShow}>
        A controlled alert — the open state lives outside, so it can come back.
      </CAlert>
      <CButton theme="primary" disabled={show} onClick={() => setShow(true)}>
        Restore the alert
      </CButton>
    </>
  )
}

Use it when the visibility belongs to something else: a validation result, a notification store, or a preference you persist.

API

Check out the documentation below for a comprehensive guide to all the props you can use with the components mentioned here.