bitcrowd / bitstyles

A complete design system, with base styles and components, built in Sass using CSS variables
https://bitcrowd.github.io/bitstyles
ISC License
16 stars 0 forks source link

Update PR template #755

Closed planktonic closed 1 year ago

planktonic commented 1 year ago

I’ve found it super useful to have:

Example taken from #749

Fixes #749 

## Changes

- Badges are now more configurable — each color variant has its color & background-color specified explicitly in configuration instead of automatically. Defaults to grayscale.
- Badges now have size variants (base and small in default config), and always display as small on small screens
- Moves stories for Badge component into a `.js` file, and includes them into the mdx file
- Adds a component file for Badge — outputs a simple HTML element, mimicing how a component in e.g. React, web-components would work.
- Reactivates the controls plugin for storybook

## 📸

<img width="1028" alt="Screenshot 2023-03-29 at 16 20 20" src="https://user-images.githubusercontent.com/2479422/228568653-18dcabbd-fd7f-4de4-a34f-3959dc886567.png">
<img width="1028" alt="Screenshot 2023-03-29 at 16 20 32" src="https://user-images.githubusercontent.com/2479422/228568608-1bbb4cd7-be38-4678-88b5-3ad7ad98d0c7.png">

## How to QA Visual changes

- `git checkout main` 
- `git pull` 
- `git checkout feature/749-update-badge-components` 
- `yarn`
- `yarn storybook`
- navigate to Badge component

Check:

- [ ] The appearance matches the zeplin designs
- [ ] The documentation for this component is correct, understandable, and up-to-date.

## How to QA code changes

- [ ] The documentation for this component is correct, understandable, and up-to-date.
- [ ] The component makes good use of CSS custom properties to simplify creating variants (or doesn’t have variants).
- [ ] Everything that should be a variable, is.

## Preflight checks

PR author to check, and delete if not applicable:

- [x] Storybook documentation has been updated
- [x] Fixtures in [`test/scss/`](../test/scss/) have been updated
- [x] Your changes have been added to the `unreleased` section of [CHANGELOG.md](../CHANGELOG.md)