VGR Styleguide

Alert: Success With Icon 

<div class="vgr-alert vgr-mt-1 vgr-alert--success">

    <div class="vgr-alert__icon">
        <svg class="vgr-icon vgr-icon--"><use xlink:href="/icons/sprite/icons.svg#message--success"></use></svg>

    </div>

    <div class="vgr-alert__content">
        <h2 class="vgr-alert__title">Success message</h2>
        <div class="vgr-alert__description">
            <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.</p>
        </div>
    </div>
</div>
 
<div class="vgr-alert vgr-mt-1 vgr-alert--{{ modifier }}">
  {% if icon %}
  <div class="vgr-alert__icon">
    {% render "@icon", iconData %}
  </div>
  {% endif %}
  <div class="vgr-alert__content">
    <h2 class="vgr-alert__title">{{ title }}</h2>
    <div class="vgr-alert__description">
      {{ description }}
    </div>
  </div>
</div>
 
{
  "title": "Success message",
  "modifier": "success",
  "description": "<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.</p>",
  "icon": true,
  "iconData": {
    "id": "message--success"
  }
}
  • Content: 
    .vgr-alert {
  padding: $default-whitespace;
  font-family: $secondary-font-stack;
  display: flex;
  flex-direction: row;
  align-items: center;

  a {
    color: inherit;
  }

  &__title {
    display: block;
    margin: 0;
    font-size: 1rem;
  }

  &__description {

    *:first-child {
      margin-top: 0;
    }

    *:last-child {
      margin-bottom: 0;
    }
  }

  &--default {
    background-color: $color-success;
    color: darken($color-success, 60%);
  }

  &--success {
    background-color: $color-success;
    color: darken($color-success, 60%);
  }

  &--warning {
    background-color: $color-warning;
    color: darken($color-warning, 70%);
  }

  &--error {
    background-color: $color-error;
    color: darken($color-error, 60%);
  }

  &--info {
    background-color: $color-info;
    color: darken($color-info, 60%);
  }

  &__icon {
    margin-right: $default-whitespace;
    fill: currentColor;
  }

  .vgr-icon {
    width: 2.75rem;
    height: 2.75rem;
  }
}
  • URL: /components/raw/alerts/_alerts.scss
  • Filesystem Path: components/base/alerts/_alerts.scss
  • Size: 990 Bytes

Text from The U.S. Web Design Standards

Accessibility

  • Use the ARIA role="alert" to inform assistive technologies of a time-sensitive and important message that is not interactive. If the message is interactive, use the alertdialog role instead.
  • Do not visually hide alert messages on the page and then make them visible when they are needed. Users of older assistive technologies may still be able to perceive the alert messages even if they are not currently applicable.

Usability

When to use

  • As a notification that keeps people informed of the status of the system and which may or may not require the user to respond. This includes errors, warnings, and general updates.
  • As a validation message that alerts someone that they just did something that needs to be corrected or as confirmation that a task was completed successfully.

When to consider something else

  • On long forms, always include in-line validation in addition to any error messages that appear at the top of the form.
  • If an action will result in destroying a user’s work (for example, deleting an application) use a more intrusive pattern, such as a confirmation modal dialogue, to allow the user to confirm that this is what they want.

Guidance

  • When the user is required to do something in response to an alert, let them know what they need to do and make that task as easy as possible. Think about how much context to provide with your message. For example, a notification of a system change may require more contextual information than a validation message. Write the message in concise, human readable language; avoid jargon and computer code.
  • Be polite in error messages — don’t place blame on the user.
  • Users generally won’t read documentation but will read a message that helps them resolve an error; include some educational material in your error message.
  • But don’t overdo it — too many notifications will either overwhelm or annoy the user and are likely to be ignored.
  • Allow a user to dismiss a notification wherever appropriate.
  • Don’t include notifications that aren’t related to the user’s current goal.