# @exanic/ng-cobrowse

> A service library for integrate cobrowse.io in your angular project

Latest version **2.0.1** (published 2022-02-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @exanic/ng-cobrowse
pnpm add @exanic/ng-cobrowse
yarn add @exanic/ng-cobrowse
bun add @exanic/ng-cobrowse
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-02-23 |
| First published | 2020-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 37.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | nils.thomann@exanic.ch |
| Maintainers | nils.thomann, exanic.ch |

## Links

- npm: https://www.npmjs.com/package/@exanic/ng-cobrowse
- Repository: https://github.com/nilsthomann/ng-cobrowse
- Homepage: https://github.com/nilsthomann/ng-cobrowse#readme
- Issues: https://github.com/nilsthomann/ng-cobrowse/issues
- npm.io page: https://npm.io/package/@exanic/ng-cobrowse

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.0.0

## Recent versions

- 2.0.1 (latest) — 2022-02-23
- 2.0.0 — 2022-02-23
- 1.1.1 — 2020-10-29

## README

# Cobrowse Service Library for Angular

A service library for integrate cobrowse.io in your angular project.
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.12.

## Getting Started

The following steps must be done to activate Cobrowse in your angular project

### Installing

Run the following command to install the library

```
npm i --save  @exanic/ng-cobrowse
```

### Setup

After the installation you have to provide your license key in app.module.ts

``` typescript
    providers: [
        ...
        {provide: COBROWSE_IO_LICENSE_KEY,  useValue: '[YOUR_LICENSE_KEY]'}
    ],
```

inject the cobrowseService in your controller and start a session

``` typescript
constructor(
        ...
        private cobrowseService: CobrowseService,
    ) {
        ...
         cobrowseService.start();
     }
```

### Enterprise Instance

If you have your own enterprise instance, you have to provide your API URL in app.module.ts

``` typescript
    providers: [
        ...
        {provide: COBROWSE_IO_API_URL,  useValue: '[YOUR_API_URL]'} // as example 'https://cobrowse.example.com'
    ],
```

## Authors

* **Nils Thomann** - *Initial work* - [Nils Thomann](https://github.com/nilsthomann)

See also the list of [contributors](https://github.com/nilsthomann/ng-cobrowse/graphs/contributors) who participated in this project.

## License

This project is licensed under the MIT License

## Acknowledgments

* Thanks to PurpleBooth for the [Readme Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)

---
_Source: https://npm.io/package/@exanic/ng-cobrowse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._