@bdt-component-library/notification NPM

Notification Component

About

This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.

Description

Handles display of notifications according to style guide conventions.

https://zeroheight.com/990ea04ab/p/55e1e4-notification

API

prop	type	required	default	explanation
children	any	yes	no	The message content to be displayed in the notification
className	string	no	""	Adds an optional classname to the component
id	string	no	""	Adds an optional id to the component
actionName	string	yes	no	The name of the secondary notification action
variant	enum("success", "error", "informational", "none")	no	"none"	Changes icon and color style for chosen variant
hasDismissAction	boolean	no	true	Determines whether or not the notification can be dismissed
isDismissed	boolean	no	true	Determines if the notification should be dismissed, using means other than the internal dismiss action
onActionClick	function(event)	yes	no	Handles the onclick event for the action
onDismissClick	function(event)	no	() => false	Fires as a callback when dismiss action is triggered internally