# aurelia-openlayers

> A plugin for working with Openlayers within Aurelia

Latest version **0.1.7** (published 2019-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install aurelia-openlayers
pnpm add aurelia-openlayers
yarn add aurelia-openlayers
bun add aurelia-openlayers
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.7 |
| Published | 2019-07-08 |
| First published | 2017-10-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 97.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Maurice Roseboom |
| Maintainers | lmroseboom |
| Keywords | aurelia, plugin, component |

## Links

- npm: https://www.npmjs.com/package/aurelia-openlayers
- Repository: https://github.com/mroseboom/aurelia-openlayers
- Homepage: https://github.com/mroseboom/aurelia-openlayers#readme
- Issues: https://github.com/mroseboom/aurelia-openlayers/issues
- npm.io page: https://npm.io/package/aurelia-openlayers

## Recent versions

- 0.1.7 (latest) — 2019-07-08
- 0.1.6 — 2018-06-24
- 0.1.5 — 2018-06-22
- 0.1.4 — 2018-05-03
- 0.1.2 — 2018-01-29
- 0.1.1 — 2017-12-12
- 0.1.0 — 2017-10-19

## README

# aurelia-openlayers

A custom element for use in your Aurelia applications for
inserting Openlayers into your application.

## WIP - Disclosure
------
This plugin is Work in Progess, defining his archicture and also his implementation. It's not ready to use in live/production enviroments.


## To Install

**Webpack/Aurelia CLI**

``` shell
npm install aurelia-openlayers --save
```

### CLI User?
The Aurelia CLI requires some additional configuration to use this plugin. Open up your `aurelia.json` file located in the `aurelia_project` directory and at the bottom of the `dependencies` section add in the following:

```
{
    "name": "aurelia-openlayers",
    "path": "../node_modules/aurelia-openlayers/dist/amd",
    "main": "aurelia-openlayers"
}
```

**Jspm**

``` shell
jspm install aurelia-openlayers
```

## Configuring For Use

Inside of your `main.js`/`main.ts` file simply load the plugin inside of
the configure method using `.plugin()`

``` typescript
export function configure(aurelia: Aurelia) {
    aurelia.use
        .plugin('aurelia-openlayers', (config: AureliaOpenlayersConfiguration) => {});
}
```

## Using It

Now you have Openlayers configured, to use it simply use the custom
element `<ol-map></ol-map>` in your views.

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