Message ​

A Message provides system feedback for users. Messages can be provided as a prominently-displayed banner with a longer explanation, or as inline validation feedback.

Guidelines ​

Using messages ​

Messages must include text clearly defining the system feedback to the user. They also include an icon to help users recognize the type of message, and they can also feature an optional dismiss button to close the message.

Specifications ​

The message component may contain the following items:

1. Icon
   Icons simplify user recognition and provide the ability to shorten message text. A specific icon is matched with each message type (e.g., ‘success’) to ensure recognition.
2. Message text
   The message text should be as clear and concise as possible, offering feedback to users. If applicable, it may also suggest next steps.
3. Close button (optional)
   To allow for the message to be dismissed, an optional icon-only quiet button can be included.

The inline message component includes both the icon and message elements, excluding the close button.

Refer to the Message component in Codex Figma.

Types ​

Message layout ​

There are two types of messages, each suited to specific use cases:

1. Message: Utilize it to display system feedback, respond to user actions, or provide information.
2. Inline message: Employ it to offer feedback on the validation of form inputs.

Message type ​

Depending on the feedback conveyed to the user, the messages can be categorized as follows:

1. Neutral or notice messages provide general user feedback. They are accompanied by the 'infoFilled' icon by default, but the icon may be changed to any other system icon to emphasize a specific aspect of the notice message.
2. Success messages deliver feedback of a successful user interaction, like publishing an article. Accompany the message with the 'success' icon.
3. Error messages have the strongest visual priority of all system messages. Use them to alert the user only in situations when their immediate attention is needed. Accompany the message with the 'error' icon.
4. Warning messages provide important information about circumstances that require caution. Accompany the message with the 'alert' icon.

Inline messages follow the same categorization: notice, success, error, and warning.

Dismissability ​

Messages can be categorized based on how they are removed from the interface as follows:

Dismiss button ​

Messages can be dismissed by utilizing the close button within the message. Note that inline messages cannot be dismissable.

Auto-dismiss ​

Messages can be also auto-dismissable. This means they will automatically disappear after 4 seconds.

This feature should only be used for very short messages to ensure that they can be read and understood before disappearing. When in doubt, do not use auto-dismiss. To prevent error messages from disappearing before users fix the error, do not use auto-dismiss with error messages. Auto-dismiss can be used with or without the manual dismiss button.

Demos ​

Configurable ​

<cdx-message dismiss-button-label="Close">Message text</cdx-message>

type

inline

dismissButtonLabel

default

Reading direction

Fade in ​

When a message is dynamically added to the UI, use the fadeIn prop to enable a transition.

<template>
  <cdx-button :disabled="showMessage" @click="showMessage = true">
    Show message
  </cdx-button>
  <cdx-message v-if="showMessage" type="warning" :fade-in="true">
    <p><strong>Warning!</strong> Here's some information you should know.</p>
  </cdx-message>
</template>

<script>
import { defineComponent } from "vue";
import { CdxMessage, CdxButton } from "@wikimedia/codex";

export default defineComponent({
  name: "MessageFadeIn",
  components: { CdxMessage, CdxButton },
  data() {
    return {
      showMessage: false
    };
  }
});
</script>

<template>
  <cdx-button :disabled="showMessage" @click="showMessage = true">
    Show message
  </cdx-button>
  <cdx-message v-if="showMessage" type="warning" :fade-in="true">
    <p><strong>Warning!</strong> Here's some information you should know.</p>
  </cdx-message>
</template>

<script>
const { defineComponent } = require("vue");
const { CdxMessage, CdxButton } = require("@wikimedia/codex");

// @vue/component
module.exports = defineComponent({
  name: "MessageFadeIn",
  components: { CdxMessage, CdxButton },
  data() {
    return {
      showMessage: false
    };
  }
});
</script>

Dismiss button ​

Messages can be made dismissable by supplying a semantic label for the dismiss button via the dismissButtonLabel prop. This label will be visually hidden but accessible to assistive technology, specifically screen readers.

When the dismiss button is clicked, the Message component hides itself, and a 'user-dismissed' event is emitted to the parent component in case the parent component needs to react to the message dismissal in some way.

Note that inline messages cannot be dismissable.

<cdx-message dismiss-button-label="Close">
	Notice message with dismiss button
</cdx-message>

Auto-dismiss ​

The autoDismiss prop can be used to automatically remove the message after a period of time. Set this prop to true to use the default display time of 4000 milliseconds (4 seconds). To customize the display time, set the autoDismiss prop to a number of milliseconds.

This feature should only be used for very short messages to ensure that can be read and understood before disappearing. When in doubt, do not use auto-dismiss. Auto-dismiss cannot be used for error messages: if the type prop is set to error, the autoDismiss prop will be ignored and a warning will be thrown if it's set.

Auto-dismiss can be used with or without the manual dismiss button.

<template>
  <cdx-button :disabled="showMessage" @click="showMessage = true">
    Show message
  </cdx-button>
  <cdx-message
    v-if="showMessage"
    type="success"
    :fade-in="true"
    :auto-dismiss="true"
    :display-time="3000"
  >
    Success! This message will disappear...
  </cdx-message>
</template>

<script>
import { defineComponent } from "vue";
import { CdxMessage, CdxButton } from "@wikimedia/codex";

export default defineComponent({
  name: "MessageAutoDismiss",
  components: { CdxMessage, CdxButton },
  data() {
    return {
      showMessage: false
    };
  }
});
</script>

<template>
  <cdx-button :disabled="showMessage" @click="showMessage = true">
    Show message
  </cdx-button>
  <cdx-message
    v-if="showMessage"
    type="success"
    :fade-in="true"
    :auto-dismiss="true"
    :display-time="3000"
  >
    Success! This message will disappear...
  </cdx-message>
</template>

<script>
const { defineComponent } = require("vue");
const { CdxMessage, CdxButton } = require("@wikimedia/codex");

// @vue/component
module.exports = defineComponent({
  name: "MessageAutoDismiss",
  components: { CdxMessage, CdxButton },
  data() {
    return {
      showMessage: false
    };
  }
});
</script>

Multiline message ​

Message content can contain markup like bold text and links.

<cdx-message type="error">
	<p><strong>An error has occurred.</strong></p>
	<p>Comprehensive explanation of the error.</p>
	<p><a href="#">Link</a> to more information.</p>
</cdx-message>

With custom icon ​

Only notice messages may have a custom icon.

<cdx-message :icon="cdxIconArticle">
	Notice message with custom icon
</cdx-message>

Vue usage ​

Message styles and icon will vary depending on the message type (notice, warning, error or success). Messages are block style by default, but can be displayed as inline messages via the inline prop.

Block-style messages can be made dismissable in the following ways:

• By using the dismissButtonLabel prop, which adds a dismiss button
• By using the autoDismiss prop. This can be set to true to use the default display time of 4000 milliseconds (4 seconds), or the display time can be customized by setting autoDismiss to a number of milliseconds. Error messages cannot auto-dismiss: if the type prop is set to error, then the autoDismiss prop will be ignored.

Props ​

Events ​

Slots ​

CSS-only version ​

Note that some features of the Vue component require JavaScript and are therefore not supported in the CSS-only version (fade in, dismiss button, and auto-dismiss).

Markup structure ​

<!-- Root element with layout and type classes, and additional attribute(s). -->
<div
  class="cdx-message cdx-message--block cdx-message--notice"
  aria-live="polite"
>
  <!-- Empty span for message icon. -->
  <span class="cdx-message__icon"></span>
  <!-- Div for content. -->
  <div class="cdx-message__content">
    Message content (can include markup)
  </div>
</div>

Message layout ​

There are two layout styles for messages: block and inline. Use the following classes to apply these layouts.

• Block: cdx-message--block (class can be omitted since this is the default)
• Inline: cdx-message--inline

<div
  class="cdx-message cdx-message--block cdx-message--notice"
  aria-live="polite"
>
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is a block-style message.
  </div>
</div>
<div
  class="cdx-message cdx-message--inline cdx-message--notice"
  aria-live="polite"
>
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is an inline-style message.
  </div>
</div>

Message types ​

There are 4 message types, which change the colors and icon depending on the message's purpose. Use these classes to apply the different message type styles:

• Notice: cdx-message--notice (class can be omitted since this is the default)
• Warning: cdx-message--warning
• Error: cdx-message--error
• Success: cdx-message--success

<div
  class="cdx-message cdx-message--block cdx-message--notice"
  aria-live="polite"
>
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is a notice message.
  </div>
</div>
<div
  class="cdx-message cdx-message--block cdx-message--warning"
  aria-live="polite"
>
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is a warning message.
  </div>
</div>
<div class="cdx-message cdx-message--block cdx-message--error" role="alert">
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is an error message.
  </div>
</div>
<div
  class="cdx-message cdx-message--block cdx-message--success"
  aria-live="polite"
>
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    This is a success message.
  </div>
</div>

Multiline message ​

Message content can contain markup like bold text and links.

<div class="cdx-message cdx-message--block cdx-message--error" role="alert">
  <span class="cdx-message__icon"></span>
  <div class="cdx-message__content">
    <p><strong>An error has occurred.</strong></p>
    <p>Comprehensive explanation of the error.</p>
    <p><a href="#">Link</a> to more information.</p>
  </div>
</div>