@beamwind/system

ready to go beamwind for using @beamwind/preset-system

Read the docs | API | Change Log > ⚡️ Demo

@beamwind/system tries to follow a semantic naming approach by using a common language to reduce the guess work. A small set of well known design tokens hopefully prevents magic values or ambiguous names. This creates a taxonomy of tokenized variables used by system adopters and library’s components. The more predictably the model is catalogued, the easier it is to apply, maintain, and endure.

Please see @beamwind/preset-system for further information.

• Installation
• Usage
• Contribute
• License

Installation

npm install @beamwind/system

Usage

Please refer to the main documentation and @beamwind/preset-system for further information.

import { bw } from '@beamwind/system'

bw`text-critical`

For further customization setup is exported:

import { bw, setup } from '@beamwind/system'

setup({
  colors: {
    important: '#DC2626',
  },
})

bw`text-important` // will result in a #DC2626 as text color

Contribute

Thanks for being willing to contribute!

This project is free and open-source, so if you think this project can help you or anyone else, you may star it on GitHub. Feel free to open an issue if you have any idea, question, or you've found a bug.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

We are following the Conventional Commits convention.

Sponsors

Kenoxa GmbH

License

MIT © Kenoxa GmbH