This library was generated with Angular CLI version 15.2.5.
- [node](https://nodejs.org/)
- [npm](https://www.npmjs.com/) (Included with node)
- [git](https://git-scm.com/)
This library is published to Gemfury so, to be able to use this library in your project you need to make sure that npm can get Sama packages from their package repository. To do this, you'll need to add a .npmrc to the root folder of your project with the following contents:
; Set a new registry for sama packages
@sama:registry=https://npm-proxy.fury.io/samasource/
In our CI/CD pipeline, npm uses the .npmrc file located in ./ci that contains the registry pointing to Gemfury proxy.
Run the following in the terminal:
- npm install @sama/ui-library
angular.json.styles section a reference to "@sama/ui-library/theme/sama.scss".scss just include the following line of code @import '@sama/ui-library/theme/palette.scss';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 '@sama/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 |
classes resources into your .scss just include the following line of code @import '@sama/ui-library/classes/scss/{resource-name}';.| Resource Name | Documentation |
|---|---|
| box-shadows | |
| typographies | typographies |
.js just include the following line of code @import {variable} '@sama/ui-library/styles';Run npm run test:dev to execute the unit tests via Karma.
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.