Skip to content

interfacewerk/iwerk-angular-ui

Repository files navigation

Build Status Coverage Status npm monthly downloads current version Commitizen friendly BrowserStack Status

Iwerk Angular Ui

This project is a collection of useful Angular 2 directives and components. The implemented UI concepts (stateful buttons, popovers, tooltips) are very opinionated and are the basic blocks to provide the best UX as possible to users. For instance, the popovers and tooltips are always put in the body and positioned relatively to the target element according to a very simple heuristics.

We decided to take this implementation inside a bigger library to make it easier to maintain and it should not have any influence on your bundle size as you can import the modules you want!

Install

npm install iwerk-angular-ui --save

Usage

Check the demo page

Contributing

Start the "app"

npm start

Run E2E Tests

npm run e2e

Run Unit Tests

npm run test

Documentation

Documentation is generated automatically by using inline documentation and an Angular CLI side project called demo. To serve the documentation application, use:

Serve

npm run docs

Build

To build, run npm run build:docs.

BrowserStack

We want to avoid visual regressions. Therefore, we have setup Browserstack along with Protractor in order to test our library across multiple devices and browsers. Furthermore, we use visual-testing-report to compare screenshots and report any potential difference.