Skip to content

mairatma/ui-kit

Repository files navigation

UI Kit

A set of UI components made with Metal.js

Install

bower install liferay-apps/ui-kit

Usage

  1. Load CSS dependencies:

```
  1. Load CSS font icons:

```
  1. Import base files into your SASS file:

@import "bower_components/ui-kit/lib/styles/theme"; @import "bower_components/ui-kit/lib/styles/base"; ```

  1. Load main script:

<script src="vendor/ui-kit/build/scripts/ui-kit.js"></script>
```
  1. Copy & paste component's markup at liferay-apps.github.io/ui-kit.

Development

  1. Run bower install
  2. Run npm install

Bulding the library:

  1. gulp build:lib

Testing the library:

  1. gulp test - this will run the tests inside Chrome
  2. gulp test:watch - this will continuously run the tests inside Chrome
  3. gulp test:browsers - this will run the tests inside all registered browsers

Building the site:

  1. gulp build:site - Note that the site requires the library to be built first, so remember to run gulp build:lib before.

License

BSD License © Liferay, Inc.

About

Under construction 🚧 A set of UI components made with Metal.js

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published