FormerKit

Theming-first components so you can focus on design, not implementation.

FormerKit can be mostly compared to other UI libraries out there, but not exactly. The philosophy behind FormerKit is to build a white-label React component library by decoupling styles from component's HTML structure, allowing highly customizable user interfaces without the hurdle to build everytime the same HTML structure and React component interface abstractions.

The fastest way to get started with former kit is using our Starter Dashboard.

Using

Install former-kit. If you want to see the full power of FormerKit, you will also need a skin. We have developed a skin based on our styleguide, it's available in package npm former-kit-skin-pagarme or in the github repository former-kit-skin-pagarme

yarn add former-kit former-kit-skin-pagarme

Check the full documentation to understand how to use components.

Development

Check the contributing guide.

Publishing to NPM

The publishing process is automated using a combination of GitHub Actions and CircleCI. We're using the release-please-action in order to automatically create GitHub releases and bump the package.json version based on commit messages conventions known as Conventional Commits.

By following those commit conventions the release-please-action will automatically identify when you're merging a pull request which is in accordance and immediately after will create another pull request which will contain the changelog, the package.json version bump, a tag, and a release indicating the new version.

You're not required to merge this release pull request, but when you do it will trigger a workflow on CircleCI which will publish the new version of the package to NPM.

if you can't get it through CI you need to have access to NPM publish and run

npm publish

Licensing

See LICENSE.