search

klarna / ui-css-components

Klarna's UI CSS Components
http://klarna.github.io/ui-css-components
Other
9 stars 2 forks source link

readme

Klarna UI CSS Components

Build Status

Note: This project and its sister project klarna/ui-react-components are deprecated. Use @klarna/ui instead

This project contains CSS components to be used in all Klarna user facing projects.

The showroom of these components is available online at klarna.github.io/ui-css-components.

The reference for its implementation is Klarna's styleguide.

The project follows a non strict version of BEM, and it doesn't include any kind of JavaScript so no behaviour is defined. If you use React use the ui-react-components.

Running locally

To run the showroom locally:

npm install
make dev

License

Please check the LICENSE file.

Contributing

Make sure...

  1. ...your contribution is aligned with the styleguide.
  2. ...your contribution doesn't break the grid. To avoid that use always the $grid variable to define your sizes, as in line-height: ($grid * 4). As a rule of thumb, if your element total height (sum of content, paddings, margins, etc...) has an integer multiple of $grid you should be good.
  3. ... your code is linted: npm run lint.
  4. ... it works in the major browsers, the simplest way is to spawn ngrok and use the cloud service of your choice. Else, you can download IE virtual machines for virtualbox using curl -s https://raw.githubusercontent.com/xdissent/ievms/master/ievms.sh | env IEVMS_VERSIONS="9" bash.

Then:

  1. Send a PR to GitHub.
  2. Once approved:
    1. Merge your PR to master.
    2. Update the version using npm version (tag will have v prefix) & update CHANGELOG.md.

Travis will take care of publishing your new version to npm.