atomic-basics

Atomic Basics

This is the basic and foundation library for the Atomic Design System for RIGD-Loxia. Use this library to add basic elements like buttons, icons, titles, etc. Other Atomic Libraries will also use these basic building blocks to create more complex interactions.

The other libraries are:

TODO

(Option A) Install as a library into your project

npm install ... TODO

(Option B) Install as a editable library into your project

Make sure that you are using Angular CLI 6+

git submodule add --force https://<user>@git.rigd-loxia.nl/scm/atomic/atomic-basics.git libs/atomic-basics

Add the following to your angular.json file under projects:

"atomic-basics": {
      "root": "libs/atomic-basics",
      "sourceRoot": "libs/atomic-basics/src",
      "projectType": "library",
      "prefix": "abs",
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-ng-packagr:build",
          "options": {
            "tsConfig": "libs/atomic-basics/tsconfig.lib.json",
            "project": "libs/atomic-basics/ng-package.json"
          },
          "configurations": {
            "production": {
              "project": "libs/atomic-basics/ng-package.prod.json"
            }
          }
        },
        "test": {
          "builder": "@angular-devkit/build-angular:karma",
          "options": {
            "main": "libs/atomic-basics/src/test.ts",
            "tsConfig": "libs/atomic-basics/tsconfig.spec.json",
            "karmaConfig": "libs/atomic-basics/karma.conf.js"
          }
        },
        "lint": {
          "builder": "@angular-devkit/build-angular:tslint",
          "options": {
            "tsConfig": [
              "libs/atomic-basics/tsconfig.lib.json",
              "libs/atomic-basics/tsconfig.spec.json"
            ],
            "exclude": [
              "**/node_modules/**"
            ]
          }
        }
      }
    }

In the .gitmodules file you can set the branch/version/tag of the library you want to use. For example:

[submodule "libs/atomic-basics"]
	path = libs/atomic-basics
	url = https://[e-mail]/scm/atomic/atomic-basics.git
  branch = develop

Make changes to the library

To make changes to this library, you can checkout this library in your project as a editable submodule. But if you want to change the library as a separate project, you should look at the Styleguide project that showcase and explain the Design System.

TODO