https://github.com/canvasoft/ng-leaflet
Angular 2 component for Leaflet 1.x (WIP - Help Wanted)
https://github.com/canvasoft/ng-leaflet
angular2 leaflet ng2 typescript ui-leaflet wip
Last synced: 6 months ago
JSON representation
Angular 2 component for Leaflet 1.x (WIP - Help Wanted)
- Host: GitHub
- URL: https://github.com/canvasoft/ng-leaflet
- Owner: canvasoft
- License: mit
- Created: 2016-10-07T22:59:49.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T06:52:10.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T16:02:29.203Z (6 months ago)
- Topics: angular2, leaflet, ng2, typescript, ui-leaflet, wip
- Language: TypeScript
- Homepage: https://canvasoft.co/ng-leaflet/
- Size: 8.78 MB
- Stars: 17
- Watchers: 9
- Forks: 8
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular 2 Leaflet Directive - WORK IN PROGRESS (WIP)
## Goal
[Angular 2](https://angular.io) directive for the [Leaflet](http://leafletjs.com) Javascript Library. This software aims to easily embed maps managed by Leaflet on your project.
## Master Branch State
Please note the master branch is currently in a "in-progress state" and is not suitable for production use at this point.
## Features
- [x] Map Options
- [x] Layers
- [x] Dynamic Center
- [x] Markercluster
## TODO
- [ ] Markers
- [ ] GeoJSON
- [ ] Bounds
- [ ] Max Bounds
- [ ] Manage Map Events
- [ ] Legend
- [ ] Paths
- [ ] Controls
## Installation
To install ng-leaflet, run:
```bash
$ npm install canvasoft/ng-leaflet#master --save
```
## How to use it
Once you have published your library to npm, you can import ng-leaflet in any Angular application by running:
```bash
$ npm install canvasoft/ng-leaflet#master --save
```
and then from your Angular `AppModule`:
```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
// Import your library
import { UiLeafletModule } from 'ng-leaflet';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
UiLeafletModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
```
Once your library is imported, you can use its components, directives and pipes in your Angular application:
```html
{{title}}
```
## Documentation:
[Demo](https://canvasoft.github.io/ng-leaflet/demo/dist/)
## License
MIT © [Michael Salgado](mailto:elesdoar@gmail.com)