@awongiw/ui-library

This library was generated with Angular CLI version 14.0.0.

Prerequisites

- [node](https://nodejs.org/)
- [npm](https://www.npmjs.com/) (Included with node)
- [git](https://git-scm.com/)

Install Gemfury dependencies

In our CI/CD pipeline, npm uses the .npmrc file located in ./ci that contains the registry pointing to Gemfury proxy.

For local development, you will need to set the registry and log in using your Gemfury credentials:

- npm config set registry https://npm-proxy.fury.io/USERNAME/
- npm login

Download and Install

Run the following in the terminal:

- npm install @awongiw/ui-library

How can I use the @awongiw/ui-library?

Storybook showcase

How can I use @awongiw/ui-library theming?

• Open your angular.json.
• Add into styles section a reference to "@awongiw/ui-library/theme/sama.scss"

Other available resources

• To import the theme palettes into your .scss just include the following line of code @import '@awongiw/ui-library/theme/palette.scss';

Design Tokens

• The support to access the tokens thought ui-library will be deprecate soon. The suggestion is to start to using design-token library instead.

• To import style Token variables into your .scss just include the following line of code @import '@awongiw/ui-library/variables/scss/{resource-name}';

| Resource Name | Documentation | | -------------- | ---------------------------------------------------------------- | | border-radius | | | border-widths | | | colors | colors | | font-families | | | font-sizes | | | font-weights | | | letter-spacing | | | line-heights | | | sizing | | | spacing | |

• To import styles classes resources into your .scss just include the following line of code @import '@awongiw/ui-library/classes/scss/{resource-name}';.

| Resource Name | Documentation | | ------------- | -------------------------------------------------------------------- | | box-shadows | | | typographies | typographies |

• To import js Token variables into your .js just include the following line of code @import {variable} '@awongiw/ui-library/styles';

Running unit tests

Run npm run test:dev to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.