Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration of agm-direction package #2035

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 22 additions & 1 deletion angular.json
Expand Up @@ -85,5 +85,26 @@
}
}
}
}},
},
"direction": {
"projectType": "library",
"root": "packages/direction",
"sourceRoot": "packages/direction/src",
"prefix": "agm",
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:ng-packagr",
"options": {
"tsConfig": "packages/direction/tsconfig.lib.json",
"project": "packages/direction/ng-package.json"
},
"configurations": {
"production": {
"tsConfig": "packages/direction/tsconfig.lib.prod.json"
}
}
}
}
}
}
}
7 changes: 4 additions & 3 deletions package.json
Expand Up @@ -20,8 +20,9 @@
"scripts": {
"clean": "rimraf dist node_modules/@agm",
"prebuild": "yarn clean",
"build": "ng build core && ng build markerclusterer && ng build snazzy-info-window && ng build drawing",
"build:prod": "ng build core --configuration production && ng build markerclusterer --configuration production && ng build snazzy-info-window --configuration production && ng build drawing --configuration production",
"build": "ng build core && ng build markerclusterer && ng build snazzy-info-window && ng build drawing && ng build direction",
"build-direction": "ng build direction",
"build:prod": "ng build core --configuration production && ng build markerclusterer --configuration production && ng build snazzy-info-window --configuration production && ng build drawing --configuration production && ng build direction --configuration production",
"lint": "ng lint",
"test": "jest",
"test:watch": "jest --watchAll",
Expand Down Expand Up @@ -73,4 +74,4 @@
"typescript": "~4.6.4",
"yarn": "^1.22.4"
}
}
}
151 changes: 151 additions & 0 deletions packages/direction/README.md
@@ -0,0 +1,151 @@
# Agm-Direction

[![npm version](https://badge.fury.io/js/agm-direction.svg)](https://badge.fury.io/js/agm-direction)
[![npm](https://img.shields.io/npm/dm/localeval.svg)](https://github.com/explooosion/Agm-Direction)
[![Build Status](https://travis-ci.org/explooosion/Agm-Direction.svg?branch=master)](https://travis-ci.org/explooosion/Agm-Direction)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)


[Agm-Direction](https://github.com/explooosion/Agm-Direction) is the directive for [@agm/core](https://github.com/SebastianM/angular-google-maps) (not official)

- Angular
- Google Map API

How to use?
👉 [Start Reading](https://robby570.tw/Agm-Direction-Docs/)
👉 [Build With Ionic](https://github.com/explooosion/ionic-agm-direction-example)


![Agm-Direction](https://i.imgur.com/DCIoXqS.jpg)

## Credit

#### [SebastianM/angular-google-maps](https://github.com/SebastianM/angular-google-maps) - [Directions service #495](https://github.com/SebastianM/angular-google-maps/issues/495)

## Installation

Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):

- Use npm
```bash
npm install --save @agm/core agm-direction
```

- Use yarn
```bash
yarn add @agm/core agm-direction
```

## Importing Modules

```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { AgmCoreModule } from '@agm/core'; // @agm/core
import { AgmDirectionModule } from 'agm-direction'; // agm-direction

@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
AgmCoreModule.forRoot({ // @agm/core
apiKey: 'your key',
}),
AgmDirectionModule, // agm-direction
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
```

## Usage

HTML

```html
<agm-map [latitude]="lat" [longitude]="lng">
<agm-direction
[origin]="origin"
[destination]="destination"
>
</agm-direction>
</agm-map>
```

CSS

```css
agm-map {
height: 400px;
}
```

TS

```typescript
public lat = 24.799448;
public lng = 120.979021;

public origin: any;
public destination: any;

ngOnInit() {
this.getDirection();
}

getDirection() {
this.origin = { lat: 24.799448, lng: 120.979021 };
this.destination = { lat: 24.799524, lng: 120.975017 };

// Location within a string
// this.origin = 'Taipei Main Station';
// this.destination = 'Taiwan Presidential Office';
}
```

## Document
- Document [Agm-Direction-Docs](https://robby570.tw/Agm-Direction-Docs/)
- Less useful [AgmDirectionModule](https://robby570.tw/Agm-Direction/)

## Development

👉 [Playground Project](https://github.com/explooosion/Agm-Direction/tree/master/playground)

```bash
git clone https://github.com/explooosion/Agm-Direction.git
```

## Generator
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.0.0.

## Code scaffolding

Run `ng generate component component-name --project agm-direction` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project agm-direction`.
> Note: Don't forget to add `--project agm-direction` or else it will be added to the default project in your `angular.json` file.

## Build

Run `ng build agm-direction` to build the project. The build artifacts will be stored in the `dist/` directory.

## Publishing

After building your library with `ng build agm-direction`, go to the dist folder `cd dist/agm-direction` and run `npm publish`.

## Running unit tests

Run `ng test agm-direction` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.


## License

[MIT](http://opensource.org/licenses/MIT)
7 changes: 7 additions & 0 deletions packages/direction/ng-package.json
@@ -0,0 +1,7 @@
{
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../../dist/agm-direction",
"lib": {
"entryFile": "src/public-api.ts"
}
}
104 changes: 104 additions & 0 deletions packages/direction/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions packages/direction/package.json
@@ -0,0 +1,36 @@
{
"name": "@agm/direction",
"version": "0.8.11",
"description": "Angular Google Maps direction",
"license": "MIT",
"author": {
"name": "Robby",
"email": "ta7382@gmail.com"
},
"repository": {
"type": "git",
"url": "https://github.com/explooosion/agm-direction.git"
},
"bugs": {
"url": "https://github.com/explooosion/agm-direction/issues"
},
"homepage": "https://github.com/explooosion/agm-direction",
"keywords": [
"angular-google-maps",
"angular",
"google-maps-direction",
"agm-direction",
"direction",
"angular-14.2"
],
"peerDependencies": {
"@angular/common": "^15.0.0",
"@angular/core": "^15.0.0"
},
"dependencies": {

},
"devDependencies": {
"@types/googlemaps": "^3.39.8"
}
}