Skip to content

Latest commit

 

History

History
86 lines (71 loc) · 2.54 KB

README.md

File metadata and controls

86 lines (71 loc) · 2.54 KB

UI Library

Website npm
Build Status Codacy Badge
StackShare GitHub license GitHub pull requests

Getting started:

Install library

npm i @fourjs/ng-library --save Note: Install peer dependencies. npm install @angular/[email protected] @fortawesome/[email protected] --save

Import NgLibrary into @NgModule
Also import dependent modules

  • BrowserAnimationsModule
  • HttpClientModule
  • FormsModule
import { NgLibrary } from '@fourjs/ng-library';

@NgModule({
  declarations: [DemoWrapperComponent],
  imports: [
    NgLibrary,
    BrowserAnimationsModule,
    HttpClientModule,
    FormsModule,
    // other modules imports
    ...
  ]
  ...
})

Add "node_modules/@fourjs/ng-library/styles.css" into of angular.json

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "version": 1,
  "newProjectRoot": "projects",
  "projects": {
    "project-name": {
      "projectType": "application",
      "sourceRoot": "src",
      "prefix": "app",
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-angular:browser",
          "options": {
            ...
            "styles": [
              "src/styles.scss",
              "node_modules/@fourjs/ng-library/styles.css"
            ],
            "scripts": []
          },
          "configurations": {
           ...
          }
        },
        ...
      }
    }},
  "defaultProject": "project-name"
}

For API Documentation refer https://nimjetushar.github.io/ui-lib/

License

GitHub license