angular-cli/docs/documentation/stories/third-party-lib.md
Alex Eagle ec731f0454 docs: don't reference next.angular.io
When we cut a release, this moves to angular.io.
Use v8.angular.io in places where angular.io is currently a 404.

Fixes https://github.com/angular/angular/issues/30407
2019-05-21 09:08:40 -04:00

1.3 KiB

Documentation below is deprecated and we no longer accept PRs to improve this. The new documentation is available here.

3rd Party Library Installation

Simply install your library via npm install lib-name --save and import it in your code.

If the library does not include typings, you can install them using npm:

npm install d3 --save
npm install @types/d3 --save-dev

Then open src/tsconfig.app.json and add it to the types array:

"types":[
  "d3"
]

If the library you added typings for is only to be used on your e2e tests, instead use e2e/tsconfig.e2e.json. The same goes for unit tests and src/tsconfig.spec.json.

If the library doesn't have typings available at @types/, you can still use it by manually adding typings for it:

  1. First, create a typings.d.ts file in your src/ folder. This file will be automatically included as global type definition.

  2. Then, in src/typings.d.ts, add the following code:

declare module 'typeless-package';
  1. Finally, in the component or file that uses the library, add the following code:
import * as typelessPackage from 'typeless-package';
typelessPackage.method();

Done. Note: you might need or find useful to define more typings for the library that you're trying to use.