17.7.1 • Published 4 days ago

ids-enterprise-ng v17.7.1

Weekly downloads
853
License
Apache-2.0
Repository
github
Last release
4 days ago

'enterprise-ng' QuickStart Guide

:warning: NOTE: this guide is currently linked to version 4.6.0 of the enterprise controls. :warning:

You can use the 4.6.0 controls, but you will need to install the rxjs-compat package, and make some changes to the ids-enterprise-ng package. :construction:

This quickstart guide demonstrates how to build and run a simple Angular application using the enterprise-ng components (ids-enterprise-ng).

You can download the latest version of the code from quickstart.

Prerequisites

If Node.js and npm are not already on your machine, install them. These examples require Node 8.11 or higher and NPM 3 or higher. To check which version you are using, run node -v and npm -v in a terminal window.

This quick start guide uses @angular/cli to create, build and run the application.

At the time of writing the version of @angular/cli used was 6.0.0 with angular 6.0.0.

Step 0 : Install Pre-Prerequisites

From a command prompt, run:

npm install -g @angular/cli

Step 1 : Create and Configure the Project

Create the project folder

Using a terminal/console window, use @angular/cli to initialise the project, creating scaffolding for the application (in this case enterprise-ng-quickstart):

ng new enterprise-ng-quickstart

Step 2 : Install Packages

The project will need access to the Infor NPM registy to be able to pull down the latest Infor Design System (IDS) enterprise component libraries for jQuery and Angular.

You can add the dependencies directly into the project.json file, however it is more reliable to add them using the command line. In a terminal window, in the project folder:

  1. Type npm install jquery@3.1.1 -S
  2. Type npm install ids-enterprise
  3. Type npm install ids-enterprise-ng
  4. Type npm install @types/jquery@3.2.16 -D
  5. Type npm install merge-stream -D

This includes all the packages we need to create this simple quickstart application.

Step 3 : Configure @angular/cli

The next step is to configure angular-cli to include the IDL enterprise libraries into the output.

Edit angular-cli.json, change the scripts elements as follows:

"scripts": [
  "./node_modules/jquery/dist/jquery.js",
  "./node_modules/ids-enterprise/dist/js/sohoxi.js",
  "./node_modules/ids-enterprise/dist/js/cultures/en-US.js",
  "./node_modules/ids-enterprise/dist/js/d3.v4.js"
],

Change both the test and build architecture sections.

Step 4 : Configure TypeScript:

Edit src/tsconfig.app.json, update/add the types property:

"types": [
  "jasmine",
  "jquery",
  "node"
]

In the root tsconfig file add:

Also, add node_modules/ids-enterprise-ng/index.ts to the include property, as follows:

"include": [
  "src/**/*",
  "node_modules/ids-enterprise-ng/index.ts"
]

This is required as the compiler will not compile code outside the src source folder by default. -->

Step 5 : Enterprise Controls Assets

@angular/cli needs to include assets from node_modules into the compiled output.

To configure this edit the angular-cli.json assets section.

  "assets": [
    { "glob": "**/*", "input": "../node_modules/ids-enterprise/dist/css", "output": "./assets/sohoxi/css" }
  ],

The link in the following to the src/index.html file would be the output folder..

<head>
  ...
  <link rel="stylesheet" id="stylesheet" href="/assets/sohoxi/css/light-theme.css" type="text/css">
</head>

Step 6 : Making Sure it Works

Run the app to test it. ng serve Check you get the default page when you browse to http://localhost:4200/.

Step 7 : Unit Testing

Edit the file karma.conf.js, adding any extra JavaScript libraries to the file property, for example:

files: [
 { pattern: './node_modules/jquery/dist/jquery.js', watched: false  },
 { pattern: './node_modules/ids-enterprise/dist/js/sohoxi.js', watched: false },
 { pattern: './node_modules/ids-enterprise/dist/js/cultures/en-US.js', watched: false },
 { pattern: './src/test.ts', watched: false }
],

Run the unit tests:

ng test

This will open a Chrome window, and run the tests from there.

Add polyfills

If you plan on using IE11, then it is advisable to include a number of polyfills used to plug holes in IEs JavaScript support.

Edit the file src/polyfills.js, and uncomment all the import lines below

/** IE9, IE10 and IE11 requires all of the following polyfills. **/
import 'core-js/es6/symbol';
import 'core-js/es6/object';
import 'core-js/es6/function';
import 'core-js/es6/parse-int';
import 'core-js/es6/parse-float';
import 'core-js/es6/number';
import 'core-js/es6/math';
import 'core-js/es6/string';
import 'core-js/es6/date';
import 'core-js/es6/array';
import 'core-js/es6/regexp';
import 'core-js/es6/map';
import 'core-js/es6/weak-map';
import 'core-js/es6/set';

/** IE10 and IE11 requires the following for NgClass support on SVG elements */
import 'classlist.js';  // Run `npm install --save classlist.js`.

Type npm install --save classlist.js to add classlist package.

Add the SohoComponentsModule

Edit src/app/app.module.ts:

import { SohoComponentsModule } from 'ids-enterprise-ng';

Add SohoComponentsModule to the imports.

@NgModule({
  ...
  declarations: [],
  imports: [
    BrowserModule,
    FormsModule,
    HttpModule,
    SohoComponentsModule
  ]
  ...
)}

Add a SoHoXi Component

Add a button to app.component.html, by appending the following code snippet:

<button soho-button (click)="clicked()">Click Me!</button>

Add the clicked handler to app.component.ts, as follows:

public clicked() {
    alert('Clicked me!');
}

Then from a command line run (you can use ng serve):

npm run start

Check you get the button when you browse to http://localhost:4200/.

What Next

Now implement the rest of your application, using the components provided, of which a list can be found here

17.7.0

4 days ago

17.7.1

4 days ago

17.1.5

17 days ago

16.12.5

24 days ago

17.6.2

1 month ago

17.5.10

1 month ago

17.6.1

1 month ago

17.6.0

1 month ago

17.1.4

2 months ago

17.4.7

2 months ago

16.13.1

2 months ago

15.7.0

2 months ago

15.7.1

2 months ago

16.13.0

2 months ago

17.4.6

2 months ago

17.5.6

2 months ago

17.5.8

2 months ago

17.5.7

2 months ago

17.5.9

2 months ago

17.5.0

2 months ago

17.5.5

2 months ago

17.5.2

2 months ago

17.5.1

2 months ago

17.5.4

2 months ago

14.4.8

3 months ago

17.4.5

3 months ago

16.12.4

3 months ago

17.4.4

3 months ago

16.12.3

3 months ago

16.12.2

3 months ago

17.1.3

3 months ago

17.4.3

3 months ago

16.12.1

3 months ago

17.3.2

3 months ago

17.3.1

3 months ago

17.4.1

3 months ago

17.4.0

3 months ago

17.4.2

3 months ago

17.3.0

4 months ago

16.12.0

4 months ago

16.12.0-beta.1

4 months ago

17.3.0-beta.4

4 months ago

17.3.0-beta.3

4 months ago

16.12.0-beta.0

4 months ago

17.3.0-beta.1

4 months ago

17.3.0-beta.2

4 months ago

17.2.1-dev.1

4 months ago

17.2.1-dev.2

4 months ago

16.2.1-dev.2

4 months ago

16.2.1-dev.1

4 months ago

16.11.2

4 months ago

16.11.1

4 months ago

17.2.1

4 months ago

17.2.0

4 months ago

17.1.2

4 months ago

17.1.1

5 months ago

17.1.0

5 months ago

16.10.1

5 months ago

16.10.0

5 months ago

16.10.2

5 months ago

17.0.1-dev.0

6 months ago

15.6.1

6 months ago

16.9.1

6 months ago

16.9.0

6 months ago

16.9.0-dev.0

6 months ago

16.9.0-dev.1

6 months ago

15.4.17

7 months ago

16.8.4

7 months ago

16.8.3

7 months ago

17.0.1

6 months ago

17.0.0

6 months ago

15.4.16

7 months ago

15.4.15

7 months ago

15.4.14

8 months ago

15.4.13

8 months ago

16.7.1

8 months ago

16.7.0

8 months ago

16.8.2

7 months ago

16.8.1

7 months ago

16.8.0

7 months ago

14.4.7

8 months ago

15.4.12

9 months ago

16.5.1

10 months ago

16.5.0

10 months ago

16.2.1-beta.0

12 months ago

16.6.1

9 months ago

16.6.0

9 months ago

15.5.0

10 months ago

16.3.1

12 months ago

16.3.0

12 months ago

15.6.0

9 months ago

16.4.1

11 months ago

16.4.0

11 months ago

15.4.11

9 months ago

15.4.10

9 months ago

16.1.0-beta.0

12 months ago

15.3.0

12 months ago

15.3.2

12 months ago

15.3.1

12 months ago

15.4.1

11 months ago

15.4.0

11 months ago

15.4.3

11 months ago

15.4.2

11 months ago

15.4.5

10 months ago

15.4.4

11 months ago

15.4.7

10 months ago

15.4.6

10 months ago

15.4.9

10 months ago

15.4.8

10 months ago

16.2.0-beta.0

12 months ago

15.2.0

1 year ago

15.2.1

1 year ago

14.8.3

1 year ago

15.0.6

1 year ago

15.0.7

1 year ago

15.0.5

1 year ago

15.1.1

1 year ago

15.1.2

1 year ago

15.1.0

1 year ago

14.8.1

1 year ago

14.8.2

1 year ago

14.8.0

1 year ago

15.0.2

1 year ago

15.0.3

1 year ago

15.0.0

1 year ago

15.0.1

1 year ago

15.0.4

1 year ago

14.7.0

1 year ago

14.7.1

1 year ago

14.5.0

1 year ago

14.3.6

1 year ago

14.3.7

1 year ago

14.3.3

2 years ago

14.3.4

2 years ago

14.3.5

2 years ago

14.4.5

1 year ago

14.4.6

1 year ago

14.4.0

2 years ago

14.4.1

2 years ago

14.4.2

2 years ago

14.4.3

2 years ago

14.4.4

1 year ago

14.1.10

2 years ago

14.1.14

2 years ago

14.1.13

2 years ago

14.1.12

2 years ago

14.1.11

2 years ago

14.1.8

2 years ago

14.1.9

2 years ago

14.1.7

2 years ago

14.0.4

2 years ago

14.0.5

2 years ago

14.3.0

2 years ago

14.3.1

2 years ago

14.3.2

2 years ago

13.6.2

2 years ago

13.6.1

2 years ago

13.3.5

2 years ago

13.3.6

2 years ago

13.3.3

2 years ago

13.3.4

2 years ago

14.1.0

2 years ago

14.1.1

2 years ago

14.1.2

2 years ago

14.1.3

2 years ago

14.1.4

2 years ago

14.1.5

2 years ago

14.1.6

2 years ago

13.4.4

2 years ago

13.4.2

2 years ago

13.4.3

2 years ago

13.4.1

2 years ago

14.2.0

2 years ago

14.2.1

2 years ago

14.0.0

2 years ago

14.0.1

2 years ago

14.0.2

2 years ago

14.0.3

2 years ago

13.5.5

2 years ago

13.5.6

2 years ago

13.5.3

2 years ago

13.5.4

2 years ago

13.5.1

2 years ago

13.5.2

2 years ago

13.5.0

2 years ago

13.3.2

2 years ago

13.4.0

2 years ago

13.3.1

2 years ago

13.3.0

2 years ago

13.2.0

2 years ago

13.2.1

2 years ago

10.14.0

2 years ago

13.1.1

2 years ago

13.1.0

2 years ago

10.13.1

2 years ago

10.13.0

2 years ago

11.2.0-beta.0

2 years ago

10.11.3

2 years ago

10.11.4

2 years ago

10.11.1

2 years ago

10.11.2

2 years ago

10.11.0

2 years ago

13.0.2

2 years ago

13.0.3

2 years ago

13.0.0

2 years ago

13.0.1

2 years ago

11.1.0-beta.0

2 years ago

10.12.2

2 years ago

10.12.3

2 years ago

10.12.0

2 years ago

10.12.1

2 years ago

11.3.0-beta.0

2 years ago

10.10.2

2 years ago

10.10.0

3 years ago

10.10.1

2 years ago

10.8.0-beta.0

3 years ago

10.9.0

3 years ago

10.9.0-beta.0

3 years ago

10.3.3

3 years ago

10.6.3

3 years ago

10.1.3

3 years ago

10.6.2

3 years ago

10.1.2

3 years ago

10.3.2

3 years ago

10.6.1

3 years ago

10.6.0-beta.0

3 years ago

10.6.0

3 years ago

10.5.0-beta.0

3 years ago

10.3.1

3 years ago

10.3.0

3 years ago

10.2.1

3 years ago

10.2.0

3 years ago

10.1.1

3 years ago

9.6.1

3 years ago

9.6.0

3 years ago

9.4.6

3 years ago

9.4.7

3 years ago

9.5.3

3 years ago

9.5.2

3 years ago

9.5.1

3 years ago

10.1.0-beta.0

3 years ago

10.1.0

3 years ago

9.4.5

3 years ago

9.4.4

3 years ago

9.5.0

3 years ago

9.4.3

3 years ago

9.4.2

3 years ago

9.4.1

3 years ago

9.3.2

3 years ago

9.4.0

3 years ago

9.2.4

3 years ago

9.2.3

3 years ago

9.3.1

3 years ago

9.3.0

3 years ago

9.2.2

3 years ago

9.2.1

3 years ago

9.1.5

3 years ago

9.2.0

3 years ago

9.1.4

3 years ago

9.1.3

3 years ago

9.1.2

3 years ago

9.1.1

3 years ago

8.2.7

3 years ago

7.9.1

3 years ago

9.1.0

3 years ago

9.0.2

3 years ago

9.1.0-beta.0

3 years ago

8.2.6

3 years ago

9.0.1

3 years ago

7.9.0

3 years ago

8.2.5

3 years ago

8.2.4

3 years ago

8.2.3

3 years ago

8.2.2

3 years ago

8.2.1

3 years ago

9.0.0

3 years ago

8.2.0

3 years ago

7.8.4

3 years ago

7.5.6

3 years ago

7.7.2

3 years ago

8.1.2

3 years ago

7.8.3

3 years ago

8.1.1

4 years ago

7.8.2

4 years ago

7.8.1

4 years ago

8.1.0

4 years ago

7.8.0

4 years ago

7.8.0-beta.1

4 years ago

7.8.0-beta.0

4 years ago

8.0.3

4 years ago

8.0.2

4 years ago

7.7.1

4 years ago

8.0.1

4 years ago

8.0.0

4 years ago

7.7.0

4 years ago

7.5.5

4 years ago

7.6.2

4 years ago

7.6.1

4 years ago

7.5.4

4 years ago

7.6.0

4 years ago

7.5.3

4 years ago

7.5.2

4 years ago

7.5.1

4 years ago

7.5.0

4 years ago

7.5.0-rc.2

4 years ago

7.5.0-rc.1

4 years ago

7.5.0-rc.0

4 years ago

7.1.8

4 years ago

7.5.0-beta.2

4 years ago

7.4.1

4 years ago

7.4.0

4 years ago

7.1.7

4 years ago

6.6.6

4 years ago

6.6.5

4 years ago

7.1.6

4 years ago

7.0.4

4 years ago

7.2.4

4 years ago

7.2.2

4 years ago

7.2.1

4 years ago

7.2.0

4 years ago

7.2.0-rc.2

4 years ago

7.1.4

4 years ago

7.1.3

4 years ago

7.1.1

4 years ago

7.1.0

4 years ago

6.6.4

4 years ago

7.0.3

4 years ago

7.0.2

4 years ago

6.6.3

4 years ago

7.0.1

4 years ago

6.6.2

4 years ago

6.6.1

4 years ago

7.0.0

4 years ago

6.6.0

4 years ago

6.6.0-rc.0

4 years ago

6.6.0-beta.0

4 years ago

6.5.1

4 years ago

6.5.0

4 years ago

6.4.3

4 years ago

6.4.2

4 years ago

6.4.1

4 years ago

6.4.0

4 years ago

6.4.0-rc.2

4 years ago

6.4.0-rc.1

4 years ago

6.4.0-rc.0

4 years ago

6.3.0

4 years ago

6.3.0-rc.0

4 years ago

6.3.0-beta.0

4 years ago

6.2.0

4 years ago

6.2.0-rc.1

4 years ago

6.2.0-rc.0

4 years ago

6.1.1

5 years ago

6.1.0

5 years ago

6.1.0-rc.3

5 years ago

6.1.0-rc.2

5 years ago

6.1.0-rc.1

5 years ago

6.1.0-rc.0

5 years ago

6.1.0-beta.0

5 years ago

6.0.0

5 years ago

6.0.0-rc.0

5 years ago

6.0.0-beta.2

5 years ago

6.0.0-beta.1

5 years ago

6.0.0-beta.0

5 years ago

5.5.2

5 years ago

5.5.1

5 years ago

5.5.0

5 years ago

5.5.0-rc.2

5 years ago

5.5.0-rc.1

5 years ago

5.5.0-rc.0

5 years ago

5.5.0-beta.0

5 years ago

5.4.2

5 years ago

5.4.2-rc.0

5 years ago

5.4.1

5 years ago

5.4.0

5 years ago

5.4.0-rc.2

5 years ago

5.4.0-rc.1

5 years ago

5.4.0-rc.0

5 years ago

5.4.0-beta.2

5 years ago

5.4.0-beta.1

5 years ago

5.4.0-beta.0

5 years ago

5.3.0

5 years ago

5.3.0-rc.1

5 years ago

5.3.0-alpha.1

5 years ago

5.3.0-dev

5 years ago

5.2.1

5 years ago

5.2.0

5 years ago

5.2.0-rc.0

5 years ago

5.2.0-beta.0

5 years ago

5.1.1

5 years ago

5.1.1-rc.0

5 years ago

5.1.0

5 years ago

5.1.0-rc.1

5 years ago

5.1.0-rc.0

5 years ago

5.0.0

5 years ago

4.12.1

6 years ago

4.12.0

6 years ago

4.12.0-rc.2

6 years ago

4.12.0-rc.1

6 years ago

4.12.0-rc.0

6 years ago

4.12.0-beta.0

6 years ago

4.11.0

6 years ago

4.11.0-rc.2

6 years ago

4.11.0-rc.1

6 years ago

4.11.0-rc.0

6 years ago

4.11.0-beta.1

6 years ago

4.11.0-beta.0

6 years ago

4.10.1

6 years ago

4.10.0

6 years ago

4.10.0-rc.0

6 years ago

4.10.0-beta.0

6 years ago

4.10.0-alpha.7

6 years ago

4.10.0-alpha.6

6 years ago

4.10.0-alpha.5

6 years ago

4.10.0-dev

6 years ago

4.9.0

6 years ago

4.9.0-rc.1

6 years ago

4.9.0-rc.0

6 years ago

4.9.0-beta.0

6 years ago

4.8.0

6 years ago

4.8.0-beta.0

6 years ago

4.8.0-dev.3

6 years ago

4.8.0-dev.0

6 years ago

4.7.0

6 years ago

4.7.0-rc.2

6 years ago

4.7.0-rc

6 years ago

4.7.0-beta

6 years ago

4.7.0-test.1

6 years ago

4.7.0-dev.180511

6 years ago

4.7.0-dev

6 years ago

4.7.0-alpha.1

6 years ago