Skip to content

Important information banner - AvNotice ​

✨ Introduction ​

The AvNotice is an important information banner that allow users to view or access important and temporary information.

It is displayed on all pages on desktop and mobile devices. It displays important and urgent information (overuse may cause this banner to "disappear").

The text supports plain text or HTML. Will be sanitized to prevent XSS attacks.

🏗️ Structure ​

The notice consists of the following elements:

  • A title (prop title, of type string):
    • Optional with a default value ''
  • A text (prop text, of type string):
    • Optional with a default value ''
  • A pictogram and a color determined by the prop type, which can be one of the following strings:
    • 'info'
    • 'warning'
    • 'alert'
  • An information icon

🏷️ Props ​

NameTypeDefaultMandatoryDescription
titlestring''The banner title.
textstring''The banner text as plain text or HTML. Will be sanitized to prevent XSS attacks.
type'info' | 'warning' | 'alert'✅The banner type.
globalbooleanfalseWhether the notice is global. Used for full-width notices (e.g., a site-wide alert at the top of the page). Use it when notice is instanciated in AvHeader globalNotice slot.

🔊 Events ​

None.

🎨 Slots ​

None.

🚀 Storybook demos ​

You can find examples of use and demo of the component on its dedicated Storybook page.

💡 Examples of use ​

vue
<template>
  <AvNotice
    text="You have unassigned tracks. Please note, they will be **deleted within 15 days**. Remember to assign them."
    type="warning"
  />
</template>