@sebgroup/vanilla

6.0.0 • Public • Published

Vanilla Pattern Library

Commitizen friendly semantic-release Build Status Stable Version Greenkeeper badge

Vanilla contains basic HTML-only versions of SEB's web components.

The CSS-classes in this library are all prefixed with sdv (short for SEB Design library Vanilla), while variables, functions, mixins, etc are prefixed with vanilla.

This library can be used in two different ways:

  1. Import the classes and use directly in your markup. This can be done either by importing SCSS-files, or by simply including pre-built CSS-files directly in your page. When using SCSS-imports, you gain the ability to choose which components you want to include.

  2. Create your own classes using the mixins provided by this library. To do this, you need to import _functions.scss, _variables.scss and _mixins.scss. None of these files produce any CSS-output. Instead they provide a set of mixnis and functions that can be used to create vanilla components from your own classes.

Including classes from SCSS

For example, this will include all classes related to buttons:

@import "~@sebgroup/vanilla/src/components/buttons/button";

Creating your own classes using mixins

Here's an example where we create our own button class:

@import "~@sebgroup/vanilla/src/components/buttons/button-mixins";

.my-btn-class {
    @include vanilla-button();
}

This will output the classes .my-btn-class.

Icons

Font Awesome icons are not included and imported by default. instead you have to add this to your build yourself. You should you the Font Awesome Light set of icons.

The package you should install for icons is @fortawesome/fontawesome-pro

Components that use icons will look bad if you don't have any icons included in your build.

Tests

There are both units test of the sass code as well as end-to-end test included in this project

Unit tests

Unit tests are run with mocha through sass true. The tests are generated automatically for all mixins with a script. So, when you have added a new component run node generate-tests.js to add unit tests for the new component. These tests only test that each mixin return what is expected but this is enough to discover most of the errors that the linter won't catch.

End to end tests

Readme

Keywords

none

Package Sidebar

Install

npm i @sebgroup/vanilla

Weekly Downloads

1,474

Version

6.0.0

License

UNLICENSED

Unpacked Size

344 kB

Total Files

206

Last publish

Collaborators

  • vsjolander
  • sebopensource
  • johanobrink