v6.0.35

Notification

Show dynamic notifications and alerts to user, part of notifications system
Import

Usage

Notification is a base component for notification system. Build your own or use @asuikit/notifications package.

Notification component has 3 variants:

  • default – with colored line on the left
  • icon – line is replaced with icon
  • loading – icon or line are replaced with Loader
import { Notification } from '@asuikit/core';
import { IconCheck, IconX } from '@tabler/icons-react';
function Demo() {
return (
<>
<Notification title="Default notification">
This is default notification with title and body
</Notification>
<Notification icon={<IconCheck size="1.1rem" />} color="teal" title="Teal notification">
This is teal notification with icon
</Notification>
<Notification icon={<IconX size="1.1rem" />} color="red">
Bummer! Notification without title
</Notification>
<Notification
loading
title="Uploading data to the server"
withCloseButton={false}
>
Please wait until data is uploaded, you cannot close this notification yet
</Notification>
</>
);
}

Colors

Color
Shades
Radius
xs
sm
md
lg
xl
import { Notification } from '@asuikit/core';
import { IconCheck } from '@tabler/icons-react';
function Demo() {
return (
<>
<Notification title="We notify you that">
You are now obligated to give a star to Mantine project on GitHub
</Notification>
<Notification icon={<IconCheck size="1.2rem" />} title="We notify you that">
You are now obligated to give a star to Mantine project on GitHub
</Notification>
</>
);
}

CloseButtonProps

To customize CloseButton inside Notification, you can pass CloseButtonProps.

<Notification closeButtonProps={{ color: 'red' }} />
<Notification closeButtonProps={{ iconSize: 20 }} />

Accessibility

To support screen readers set close button aria-label or title with closeButtonProps:

<Notification closeButtonProps={{ 'aria-label': 'Hide notification' }} />
<Notification closeButtonProps={{ title: 'Hide notification' }} />

Notification component props

NameTypeDescription
children
ReactNode
Notification body, place main text here
closeButtonProps
Record<string, any>
Props spread to close button
color
MantineColor
Notification line or icon color
icon
ReactNode
Notification icon, replaces color line
loading
boolean
Replaces colored line or icon with Loader component
onClose
() => void
Called when close button is clicked
radius
number | "xs" | "sm" | "md" | "lg" | "xl"
Key of theme.radius or any valid CSS value to set border-radius, theme.defaultRadius by default
title
ReactNode
Notification title, displayed before body
withBorder
boolean
Adds border styles
withCloseButton
boolean
Determines whether close button should be visible, true by default

Notification component Styles API

NameStatic selectorDescription
root.asuikit-Notification-rootRoot element
body.asuikit-Notification-bodyNotification body wrapper, contains title and description
loader.asuikit-Notification-loaderNotification loader, controlled by loading prop
icon.asuikit-Notification-iconNotification icon on the left, controlled by icon prop
title.asuikit-Notification-titleNotification title, controlled by title prop
description.asuikit-Notification-descriptionNotification description, controlled by children
closeButton.asuikit-Notification-closeButtonClose button