NotificationProps interface

Package:

@azure/communication-react

Props for Notification.

Properties

ariaLive	Aria-live property for the notification bar.
autoDismiss	If set, notifications will automatically dismiss after 5 seconds
notificationIconProps	Notification bar icon;
notificationStrings	Notification bar strings;
onClickLink	Optional callback to supply users with further troubleshooting steps or more information for the notification.
onClickPrimaryButton	Callback called when the primary button inside notification bar is clicked.
onClickSecondaryButton	Callback called when the secondary button inside notification bar is clicked.
onDismiss	Callback called when the notification is dismissed.
role	Role html property for the notification bar.
showStackedEffect	If set, notifications will be shown in a stacked effect
styles	Styles for the incoming call notifications.

Property Details

ariaLive

Aria-live property for the notification bar.

ariaLive?: "assertive" | "off" | "polite"

Property Value

"assertive" | "off" | "polite"

autoDismiss

If set, notifications will automatically dismiss after 5 seconds

autoDismiss?: boolean

Property Value

boolean

notificationIconProps

Notification bar icon;

notificationIconProps?: IIconProps

Property Value

IIconProps

notificationStrings

Notification bar strings;

notificationStrings?: NotificationStrings

Property Value

NotificationStrings

onClickLink

Optional callback to supply users with further troubleshooting steps or more information for the notification.

onClickLink?: () => void

Property Value

() => void

onClickPrimaryButton

Callback called when the primary button inside notification bar is clicked.

onClickPrimaryButton?: () => void

Property Value

() => void

onClickSecondaryButton

Callback called when the secondary button inside notification bar is clicked.

onClickSecondaryButton?: () => void

Property Value

() => void

onDismiss

Callback called when the notification is dismissed.

onDismiss?: () => void

Property Value

() => void

role

Role html property for the notification bar.

role?: "none" | "alert" | "presentation" | "status"

Property Value

"none" | "alert" | "presentation" | "status"

showStackedEffect

If set, notifications will be shown in a stacked effect

showStackedEffect?: boolean

Property Value

boolean

styles

Styles for the incoming call notifications.

styles?: NotificationStyles

Property Value

NotificationStyles