title: React Alert Component API

name: Alert API

description: Explore the API reference for the React Alert component and discover how to effectively utilize its props for customization.

route: /components/alert/

import CAlertAPI from '../../api/CAlert.api.mdx'

import CAlertHeadingAPI from '../../api/CAlertHeading.api.mdx'

import CAlertLinkAPI from '../../api/CAlertLink.api.mdx'

<CAlertAPI />

<CAlertHeadingAPI />

<CAlertLinkAPI />

import React from 'react'

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

export const AlertAdditionalContentExample = () => {

return (

<CAlert color="success">

<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>

</CAlert>

)

import React from 'react'

import { CAlert } from '@coreui/react'

export const AlertDismissingExample = () => {

return (

<CAlert

color="warning"

dismissible

onClose={() => {

alert('👋 Well, hi there! Thanks for dismissing me.')

}}

>

<strong>Go right ahead</strong> and click that dimiss over there on the right.

</CAlert>

)

import React from 'react'

import { CAlert } from '@coreui/react'

export const AlertExample = () => {

return (

<>

<CAlert color="primary">A simple primary alert—check it out!</CAlert>

<CAlert color="secondary">A simple secondary alert—check it out!</CAlert>

<CAlert color="success">A simple success alert—check it out!</CAlert>

<CAlert color="danger">A simple danger alert—check it out!</CAlert>

<CAlert color="warning">A simple warning alert—check it out!</CAlert>

<CAlert color="info">A simple info alert—check it out!</CAlert>

<CAlert color="light">A simple light alert—check it out!</CAlert>

<CAlert color="dark">A simple dark alert—check it out!</CAlert>

</>

)

import React from 'react'

import { CAlert } from '@coreui/react'

export const AlertIcons1Example = () => {

return (

<CAlert color="primary" className="d-flex align-items-center">

<svg className="flex-shrink-0 me-2" 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'

import CIcon from '@coreui/icons-react'

import { cilBurn, cilCheckCircle, cilInfo, cilWarning } from '@coreui/icons'

export const AlertIcons2Example = () => {

return (

<>

<CAlert color="primary" className="d-flex align-items-center">

<CIcon icon={cilInfo} className="flex-shrink-0 me-2" width={24} height={24} />

<div>An example alert with an icon</div>

</CAlert>

<CAlert color="success" className="d-flex align-items-center">

<CIcon icon={cilCheckCircle} className="flex-shrink-0 me-2" width={24} height={24} />

<div>An example success alert with an icon</div>

</CAlert>

<CAlert color="warning" className="d-flex align-items-center">

<CIcon icon={cilWarning} className="flex-shrink-0 me-2" width={24} height={24} />

<div>An example warning alert with an icon</div>

</CAlert>

<CAlert color="danger" className="d-flex align-items-center">

<CIcon icon={cilBurn} className="flex-shrink-0 me-2" width={24} height={24} />

<div>An example danger alert with an icon</div>

</CAlert>

</>

)

import React from 'react'

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

export const AlertLinkColorExample = () => {

return (

<>

<CAlert color="primary">

A simple primary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a

click if you like.

</CAlert>

<CAlert color="secondary">

A simple secondary alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a

click if you like.

</CAlert>

<CAlert color="success">

A simple success alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a

click if you like.

</CAlert>

<CAlert color="danger">

A simple danger alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a

click if you like.

</CAlert>

<CAlert color="warning">

A simple warning alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a

click if you like.

</CAlert>

<CAlert color="info">

A simple info alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click

if you like.

</CAlert>

<CAlert color="light">

A simple light alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click

if you like.

</CAlert>

<CAlert color="dark">

A simple dark alert with <CAlertLink href="#">an example link</CAlertLink>. Give it a click

if you like.

</CAlert>

</>

)

import React, { useState } from 'react'

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

export const AlertLiveExample = () => {

const [visible, setVisible] = useState(false)

return (

<>

<CAlert color="primary" dismissible visible={visible} onClose={() => setVisible(false)}>

A simple primary alert—check it out!

</CAlert>

<CButton color="primary" onClick={() => setVisible(true)}>

Show live alert

</CButton>

</>

)

import React from 'react'

import { CAlert } from '@coreui/react'

export const AlertSolidExample = () => {

return (

<>

<CAlert color="primary" variant="solid">

A simple solid primary alert—check it out!

</CAlert>

<CAlert color="secondary" variant="solid">

A simple solid secondary alert—check it out!

</CAlert>

<CAlert color="success" variant="solid">

A simple solid success alert—check it out!

</CAlert>

<CAlert color="danger" variant="solid">

A simple solid danger alert—check it out!

</CAlert>

<CAlert color="warning" variant="solid">

A simple solid warning alert—check it out!

</CAlert>

<CAlert color="info" variant="solid">

A simple solid info alert—check it out!

</CAlert>

<CAlert color="light" variant="solid" className="text-high-emphasis">

A simple solid light alert—check it out!

</CAlert>

<CAlert color="dark" variant="solid">

A simple solid dark alert—check it out!

</CAlert>

</>

)

title: React Alert Component

name: Alert

description: 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.

menu: Components

route: /components/alert/

other_frameworks: alert

React Alert is prepared for any length of text, as well as an optional close button. For a styling, use one of the **required** contextual `color` props (e.g., `primary`). For inline dismissal, use the [dismissing prop](#dismissing).

import { AlertExample } from './examples/AlertExample.tsx'

import AlertExampleTS from '!!raw-loader!./examples/AlertExample.tsx'

<ExampleSnippet code={AlertExampleTS} componentName="React Alert">

<AlertExample />

</ExampleSnippet>

<Callout color="info" title="Conveying meaning to assistive technologies">

Using color to add meaning only provides a visual indication, which will not be conveyed to

users of assistive technologies – such as screen readers. 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.

</Callout>

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 { AlertLiveExample } from './examples/AlertLiveExample.tsx'

import AlertLiveExampleTS from '!!raw-loader!./examples/AlertLiveExample.tsx'

<ExampleSnippet code={AlertLiveExampleTS} componentName="React Alert">

<AlertLiveExample />

</ExampleSnippet>

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

import { AlertLinkColorExample } from './examples/AlertLinkColorExample.tsx'

import AlertLinkColorExampleTS from '!!raw-loader!./examples/AlertLinkColorExample.tsx'

<ExampleSnippet code={AlertLinkColorExampleTS} componentName="React Alert">

<AlertLinkColorExample />

</ExampleSnippet>

React Alert can also incorporate supplementary components &amp; elements like heading, paragraph, and divider.

import { AlertAdditionalContentExample } from './examples/AlertAdditionalContentExample.tsx'

import AlertAdditionalContentExampleTS from '!!raw-loader!./examples/AlertAdditionalContentExample.tsx'

<ExampleSnippet code={AlertAdditionalContentExampleTS} componentName="React Alert">

<AlertAdditionalContentExample />

</ExampleSnippet>

Similarly, you can use [flexbox utilities](https//coreui.io/docs/4.0/utilities/flex") and [CoreUI Icons](https://icons.coreui.io) to create react alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles.

import { AlertIcons1Example } from './examples/AlertIcons1Example.tsx'

import AlertIcons1ExampleTS from '!!raw-loader!./examples/AlertIcons1Example.tsx'

<ExampleSnippet code={AlertIcons1ExampleTS} componentName="React Alert">

<AlertIcons1Example />

</ExampleSnippet>

Need more than one icon for your react alerts? Consider using [CoreUI Icons](https://icons.coreui.io).

import { AlertIcons2Example } from './examples/AlertIcons2Example.tsx'

import AlertIcons2ExampleTS from '!!raw-loader!./examples/AlertIcons2Example.tsx'

<ExampleSnippet code={AlertIcons2ExampleTS} componentName="React Alert">

<AlertIcons2Example />

</ExampleSnippet>

Use `variant="solid"` to change contextual colors to solid.

import { AlertSolidExample } from './examples/AlertSolidExample.tsx'

import AlertSolidExampleTS from '!!raw-loader!./examples/AlertSolidExample.tsx'

<ExampleSnippet code={AlertSolidExampleTS} componentName="React Alert">

<AlertSolidExample />

</ExampleSnippet>

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

import { AlertDismissingExample } from './examples/AlertDismissingExample.tsx'

import AlertDismissingExampleTS from '!!raw-loader!./examples/AlertDismissingExample.tsx'

<ExampleSnippet code={AlertDismissingExampleTS} componentName="React Alert">

<AlertDismissingExample />

</ExampleSnippet>

<Callout color="warning">

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.

</Callout>

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

- [&lt;CAlert /&gt;](./api/#calert)

- [&lt;CAlertHeading /&gt;](./api/#calertheading)

- [&lt;CAlertLink /&gt;](./api/#calertlink)

title: React Alert Component Styling

name: Alert Styling

description: Learn how to customize the React Alert component with CSS classes, variables, and SASS for flexible styling and seamless integration into your design.

route: /components/alert/

React Alert comes with built-in class names that make styling super simple. Here’s a quick rundown of what you can use:

<ClassNamesDocs

files={[

'components/alert/CAlert.tsx',

'components/alert/CAlertHeading.tsx',

'components/alert/CAlertLink.tsx',

]}

/>

React Alert supports CSS variables for easy customization. These variables are set via SASS but allow direct overrides in your stylesheets or inline styles.

<ScssDocs file="_alert.scss" capture="alert-css-vars" />

const customVars = {

'--cui-alert-color': '#333',

'--cui-alert-bg': '#f8f9fa',

}

return <CAlert style={customVars}>{/* Alert content */}</CAlert>

<ScssDocs file="_variables.scss" capture="alert-variables" />