Skip to content

Commit

Permalink
vale fix
Browse files Browse the repository at this point in the history
  • Loading branch information
andersonjeccel committed May 31, 2024
1 parent 4bdc7b6 commit f119ade
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/development-environment/design/notifications.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
Notifications
=============

Notifications are a critical component of user experience (UX) in digital products, serving as a bridge between the system and the user. They should enhance, not detract from, the user experience, assisting users in achieving their goals and providing immediate, relevant feedback.
Notifications are a critical component of user experience (UX) in digital products, serving as a bridge between the system and the user. They should enhance, not detract from, the user experience, assisting users in achieving their goals and providing immediate, relevant feedback. This guide synthesizes best practices from the Carbon Design System and industry standards to help developers create effective and user-friendly notifications.

Notification Types and Their Use
===============================
Notification types and their use
================================

Understanding Notification Variants
Understanding notification variants
-----------------------------------

Notifications come in various forms, each serving a specific purpose within an application:
Notifications come in various forms, each serving a specific purpose within an app:

- **Inline Notifications**: These are integrated into task flows to inform users about the status of an action or system changes. They are typically placed at the top of the content area or near the relevant item.
- **Inline notifications**: these are integrated into task flows to inform users about the status of an action or system changes. They are typically placed at the top of the content area or near the relevant item.

- **Toast Notifications**: These are time-based messages that appear at the top of the screen and disappear after a short duration. They are used for brief messages that do not require user interaction.
- **Toast notifications**: these are time-based messages that appear at the top of the screen and disappear after a short duration. They are used for brief messages that do not require user interaction.

- **Actionable Notifications**: These include interactive elements and require user interaction. They are styled similarly to inline or toast notifications but are more disruptive due to their interactive nature.
- **Actionable notifications**: these include interactive elements and require user interaction. They are styled similarly to inline or toast notifications but are more disruptive due to their interactive nature.

Design
------

- Carefully examine the context in which notifications will appear. Use them sparingly and only when they add value to the user experience.
- Maintain consistency in the design and behavior of notifications across the application.
- Carefully examine the context in which notifications appear. Use them sparingly and only when they add value to the user experience.
- Maintain consistency in the design and behavior of notifications across the app.
- High-contrast notifications are used for critical messaging, while low-contrast notifications are less visually disruptive.

Content
Expand All @@ -41,10 +41,10 @@ Accessibility
- Notifications should be accessible and not rely solely on color to convey status, as this can be problematic for users with color blindness, so use additional HTML attributes according to the notification type.
- Toast notifications with interactive content should not automatically disappear to remain WCAG 2.1 compliant.

Using Notification Components
Using notification components
=============================

Standard Notifications with Icons
Standard notifications with icons
---------------------------------

For standard notifications that include an icon, developers should use a ``<div>`` element with the class ``alert`` and an additional class to specify the type of notification:
Expand All @@ -54,7 +54,7 @@ For standard notifications that include an icon, developers should use a ``<div>
- ``.alert-warning`` for warnings
- ``.alert-danger`` for errors

Each class corresponds to a specific icon and color that will be automatically applied using CSS logic.
Each class corresponds to a specific icon and color that is automatically applied using CSS logic.

Example:

Expand All @@ -64,12 +64,12 @@ Example:
No emails are scheduled to be sent.
</div>

This will display a warning notification with an appropriate icon and color styling.
This displays a warning notification with an appropriate icon and color styling.

Larger Notification Blocks Without Icons
Larger notification blocks without icons
----------------------------------------

When a larger notification block is needed, for instance, to include headings or additional content, developers should use the ``alert`` class along with a column class that starts with the ``col-`` prefix. These notifications will not display an icon but will have only a colored left border indicative of the notification type.
When a larger notification block is needed, for instance, to include headings or additional content, developers should use the ``alert`` class along with a column class that starts with the ``col-`` prefix. These notifications do not display an icon but have only a colored left border indicative of the notification type.

Example:

Expand All @@ -80,4 +80,4 @@ Example:
<p>Seems there are none! Try changing a filter (if applicable) or how about creating a new one?</p>
</div>

This creates a more substantial notification block with a heading and paragraph, distinguished by a yellow left border for a warning but without an accompanying icon.
This creates a more substantial notification block with a heading and paragraph, distinguished by a yellow left border for a warning but without an accompanying icon.

0 comments on commit f119ade

Please sign in to comment.