@bliss-design-system/alert

<bliss-alert>

<bliss-alert> does show important information to customers.

• Installation
• Usage
  • Properties
• Contributing
  • Demoing with Storybook
  • Testing
  • Committing
  • Opening a merge request
• Troubleshooting

📦 Installation

To install this component, run:

yarn add @bliss-design-system/alert

🏎 Usage

To use this component, you'll need to register the component to the window's Custom Elements Registry. In order to achieve that, you'll want to call this function within your application's client-facing entry file:

import { blissRegisterAlert } from '@bliss-design-system/alert';

blissRegisterAlert(); // Registers <bliss-alert>

That will make the component available in your application. Additionally, you'll need to have the <bliss-icon> component and the Iconsets registered to your application. Both are peer dependencies of this component, and you won't be able to see the icon without them.

With all of the setup you can use it like this:

<bliss-alert size="small">
  <bliss-icon slot="icon" name="trash"></bliss-icon>
  <p slot="message">Lorem ipsum <strong>dolor sit amet</strong>, consectetur adipiscing elit. <a href="#">Feugiat in viverra</a> lacus, volutpat vitae.</p>
</bliss-alert>

To use the alert with an additional title, you'll need to remove the size="small" attribute (or change it to size="medium") and add the title you want to add inside the component (we strongly recommend only using plain text. Any additional HTML tags or styling might break the appearance).

<bliss-alert>
  Alert Title
  <bliss-icon slot="icon" name="trash"></bliss-icon>
  <p slot="message">Lorem ipsum <strong>dolor sit amet</strong>, consectetur adipiscing elit. <a href="#">Feugiat in viverra</a> lacus, volutpat vitae.</p>
</bliss-alert>

To use the alert with a different theming options, please look into the multiple attributes we offer.

<bliss-alert theme="warning">
  Alert Title
  <bliss-icon slot="icon" name="trash"></bliss-icon>
  <p slot="message">Lorem ipsum <strong>dolor sit amet</strong>, consectetur adipiscing elit. <a href="#">Feugiat in viverra</a> lacus, volutpat vitae.</p>
</bliss-alert>

In addition, you can also add the option to dimiss an alert with the dismissible attribute.

<bliss-alert theme="warning" dismissible>
  Alert Title
  <bliss-icon slot="icon" name="trash"></bliss-icon>
  <p slot="message">Lorem ipsum <strong>dolor sit amet</strong>, consectetur adipiscing elit. <a href="#">Feugiat in viverra</a> lacus, volutpat vitae.</p>
</bliss-alert>

Properties

The component accepts the following properties:

Property	Type	Description	Default	Required	Options
size	string	defines the alert size	small	false	tiny, small, medium
theme	string	alert theme	default	false	default, neutral, positive, notice, warning, critical
dismissible	boolean	adds dismiss button to alert	false	false	true, false

Accessibility

The <bliss-alert> handles the fundamental accessibility concerns for you. Based on the theme you choose, <bliss-alert> will add the appropriate status attribute.

• positive, warning or critical = role=alert (used to provide the user with important, and usually time-sensitive, information, and often to tell the user an element has been dynamically updated)
• default, neutral, notice = role=status (advisory information for the user that is not important enough to justify an alert)

🫕 Contributing

If you'd like to contribute, please open an issue with your suggested change on our Proposal Board. Once that is accepted, either the Bliss team will work on it or you can make changes locally by doing the following:

# Clone this repository
git clone https://gitlab.com/bliss-design-system/components.git

# Move into the component toolkit
cd components/

# Install the dependencies
yarn

You don't need to move into the package's directory to run storybook, tests or anything else. All of those commands exist in the root of the component toolkit, so while you can work on the component within its specific folder, you don't need to move through directories to run anything.

Demoing with Storybook

You can see all of your changes as you make them on Storybook.

To run a local instance of Storybook for this component, run:

yarn storybook

Testing

If you want to test as you develop, run:

yarn test

// or

yarn test:watch

Committing

We follow the Conventional Commits specification, meaning that you'll be prompted to fill out a descriptive message when you commit. We also use these commits to manage our releases, so we appreciate details.

As a guideline for this component, we use:

• fix for bug fixes, minor stylistic improvements, etc.
• feat for any backward compatible API changes.

For anything that breaks backwards compatibility or introduces significant changes that require a major version change, please get in touch with the team.

Opening a merge request

When you're ready to open a merge request, please use a descriptive title and fill out the provided template.

The team will be notified, but it helps to post your merge request in #bliss_support.

🙃 Troubleshooting

We'll fill this section out as we go and as issues are raised. But if you haven't found what you're looking for, get in touch via [e-mail] or via the #bliss_support Slack channel ✨.