Notification

See: https://www.carbondesignsystem.com/components/notification/usage/

Notifications are messages that communicate information to the user. The two main variants of notifications are toast notifications and inline notifications.

Overview

Use notifications to inform users of updates or changes to system status. Communicating with users and providing immediate feedback are important for building trust. While notifications are an effective method of communicating with users, they are disruptive and should be used sparingly.

For more context on when to use each notification variant, including modals, refer to the notifications pattern. Carbon only supports inline, toast, and modal notification variants, although some product teams also support banners and notification centers.

class carbondesign.tags.notification.Notification(*args, **kwargs)

Notification component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

SLOTS = ('action',)

Named children.

MODES = ('inline', 'toast')

Available variants.

NODE_PROPS = ('variant', 'low_contrast')

Extended Template Tag arguments.

TEMPLATES = ('icon', 'close')

Conditional templates.

POSSIBLE_VARIANT = ('info', 'success', 'warning', 'error')

Documentation only.

prepare(values, context)

Prepare values for rendering the templates.

render_inline(values, context)

Output html of the component.

render_toast(values, context)

Output html of the component.

render_tmpl_icon(values, context)

Dynamically render a part of the component’s template.

render_tmpl_close(values, context)

Dynamically render a part of the component’s template.

class carbondesign.tags.notification.NotificationButton(*args, **kwargs)

Notification button component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

DEFAULT_TAG = 'button'

Rendered HTML tag.

render_default(values, context)

Output html of the component.

class carbondesign.tags.notification.NotificationTitle(*args, **kwargs)

Notification title component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

DEFAULT_TAG = 'h3'

Rendered HTML tag.

render_default(values, context)

Output html of the component.

class carbondesign.tags.notification.NotificationSubtitle(*args, **kwargs)

Notification subtitle component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

DEFAULT_TAG = 'p'

Rendered HTML tag.

render_default(values, context)

Output html of the component.

class carbondesign.tags.notification.NotificationCaption(*args, **kwargs)

Notification caption component.

WANT_CHILDREN = True

Template Tag needs closing end tag.

DEFAULT_TAG = 'p'

Rendered HTML tag.

render_default(values, context)

Output html of the component.