<bliss-badge>

<bliss-badge> displays relevant information that needs more visual weight. Badges are normally used to indicate status of an object or of an action that’s been taken. They aren't clickable.

• 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/badge

🏎 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 { blissRegisterBadge } from '@bliss-design-system/badge';

blissRegisterBadge(); // Registers <bliss-badge>

That will make the component available in your application and you can use it like this:

<!-- Render a badge with the positive theme at the default medium size -->
<bliss-badge theme="positive">Test</bliss-badge>

Properties

The component accepts the following properties:

| Property | Type | Description | Default | Required | Options | | --------------- |:--------------:| :------------------------------------------------:|:------------:|:---------:|:-------:| | theme | String | Applies theme to the badge component | default | false | default, neutral, positive, notice, warning and critical | size | String | Size of the badge component | medium | false | medium or small | borderless | Boolean | Adds or removes border from the badge component | false | false | true or false

🫕 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 [email protected] or via the #bliss_support Slack channel ✨.