ngx-dawn
v0.2.0
Published
[![npm version](https://badge.fury.io/js/ngx-dawn.svg)](https://badge.fury.io/js/ngx-dawn) [![Angular 2 Style Guide](https://mgechev.github.io/angular2-style-guide/images/badge.svg)](https://angular.io/styleguide)
Downloads
11
Readme
ngx-dawn
An implementation of kununu engage design specification for Angular framework.
Table of Contents
Installation
To add the library to you project, open a terminal and run:
$ npm install ngx-dawn --save
Usage
Add it on your module:
import { ButtonModule } from 'ngx-dawn';
@NgModule({
imports: [
BrowserModule,
ButtonModule
],
declarations: [
AppComponent
],
bootstrap: [AppComponent]
})
export class AppModule { }
Follow the features documentation and add it on your html:
<button ngx-dawn-button>Button</button>
Features
| Feature | To-do | | |------------------|---------------|---------------| | badge |Check click behavior + "lozenges"|Badge use cases| | button | |Button use cases| | checkbox | |Checkbox use cases| | slide toggle | |Slide Toggle use cases| | radio & radio group | |Radio & Radio Group use cases| | typography |Add responsive sizes|Typography use cases|
Theming
The easiest way is to use the ngx-dawn-theme mixin which will create all styles needed for every component provided by ngx-dawn.
@import '~ngx-dawn/scss/_theming';
// Generate all styles for all components with one include
@include ngx-dawn-theme($palette);
If you just want to use the styles from a specific component you can do it by having something like the following.
@import '~ngx-dawn/scss/_theming';
// Button styles only
@include ngx-dawn-button-theme($palette);
TODO Tasks
- Improve Demo/Documentation
TODO Features
| Feature | |:------------------| | content | | inline flag messages | | input | | link | | modal | | search | | select | | tab | | text area | | tooltip |