Skip to content

swasunb/symphony-bdk-ui-toolkit-styles

 
 

Repository files navigation

💄 SymphonyBDK - UI Toolkit Styles

The official styles library of Symphony's design system

Requirements

  • Node 12+
  • Yarn

🛠 Install

Run

yarn

🛸 Explore

yarn start

✅ Getting started

In order to install and start using the library you can read the detailed guide on getting-started.md

😀 Icons

To add a new icon in UIToolkit Styles:

  • Add the *.svg source file to:
src/
|
|– icons/
|   |– svg/

🤖 Visual Testing

Automated visual testing uses software to automate the process of comparing visual elements across various screen combinations to uncover visual defects.

Creevey is a Cross-browser screenshot testing tool for Storybook with a fancy UI Runner.

  • Start storybook and then start Visual Testing Execution.
yarn start
yarn test

And that's it.

NOTE: After changes or new Components, the tests will fail or need to be included in validation. In order to update them, you may approve them all in one command:

yarn test --update

🧩 Theming components

Read detailed guide on theming-guide.md

💪 Contributing

Read detailed guide on contribution process

About

SymphonyPlatformSolutions/symphony-bdk-ui-toolkit-styles

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.7%
  • SCSS 47.9%
  • Other 1.4%