Dgs-core NPM | npm.io

Angular5 dgs-core - DGS Core

Getting started
Roadmap
API
Contributors
Development

Warning

Library is under active development and may have breaking changes until stable 2.0.0 release or subsequent major versions after 2.0.0.

Getting started

Step 1: Install `dgs-core`

NPM

npm install --save dgs-core

Step 2: Import the component module

import { DGSCoreModule, IDGSEnvironment } from 'dgs-core';

const dgsEnvironment: IDGSEnvironment = {
  debug: environment.debug,
  apiUrl: environment.apiUrl,
  defaultLanguage: {
    Name: 'English',
    Code: 'en',
    Icon: 'fa fa-globe',
  },
  languages: [{
      Name: 'English',
      Code: 'en',
      Icon: 'fa fa-globe',
    }],
  lowerCaseTranslates: true,
};

@NgModule({
  declarations: [AppComponent],
  imports: [DGSCoreModule.forRoot(dgsEnvironment)],
  bootstrap: [AppComponent]
})
export class AppModule {}

Step 3: Include assets

To load assets like themes and pdf viewer its ncessary to include assets. IF you're using the Angular CLI, you can add this to your angular-cli.json. Note: Path to dgs-core bundle must set relative to basepath inside angular-cli.json.

"apps": {
    ...any,
    "assets": [
        ...any,
        {
          "glob": "**/*",
          "input": "../node_modules/dgs-core/assets/",
          "output": "./assets/"
        }
    ],
    ...any,
}

Step 4: Include a theme

For now library doesn't allow you to use a custom theme, but i will be avalaible soon. Keep in touch with us.

API

Inputs

Input	Type	Default	Required	Description
task	`Task`	-	yes	Initial process object
language	`Lang`	The one you sent in `dgsEnvironment`	no	Sends active language to `dgs-core`
grid	`boolean`	`false`	no	Let `dgs-core` know that you are gonna use instance as a grid
hideName	`boolean`	`false`	no	Decides to show process name or not