Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/eregnier/vue-leaflet-custom-marker

vue leaflet for open street map custom marker component
https://github.com/eregnier/vue-leaflet-custom-marker

Last synced: about 2 months ago
JSON representation

vue leaflet for open street map custom marker component

Lists

README 

        
# vue leaflet custom marker



[

![npm](https://img.shields.io/npm/v/vue-leaflet-custom-marker.svg)

![npm](https://img.shields.io/npm/dm/vue-leaflet-custom-marker.svg)

](https://www.npmjs.com/package/vue-leaflet-custom-marker)

![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)



This component allows you to display custom HTML content on the map using Overlay.

I made this component for leaflet because I made the one for [google map](https://github.com/eregnier/vue2-gmap-custom-marker) and it was quite easy for me to adapt and do this one then.



[Demo](https://vue-leaflet-custom-marker-demo.pages.dev/)



You might look at this [demo code repository](https://github.com/eregnier/vue-leaflet-custom-marker-demo) for features usage and complete exemple around this plugin.



## Features



- Display reactive custom html into markers on google map using slot system



- Live property change allows simple interaction with coordonates and zindex of html marker element



- Simple positionning system for marker around the origin point



- Specific markers offset X and Y for more control about html element display



- Almost all API of the component is optional, just start with lon, lat property



## Example



https://user-images.githubusercontent.com/5399780/143586275-d25dfe7a-732b-4d09-b47f-b1a359574828.mp4



## Installation



Install the package from [npm](https://www.npmjs.com/package/vue-leaflet-custom-marker):



`npm i vue-leaflet-custom-marker`



## Basic Usage



Import the component and use it in the components object.



```javascript

import CustomMarker from 'vue-leaflet-custom-marker';



export default = {

  [...],

  components: {

      CustomMarker

  },

  [...]

}

```



Use the custom marker inside the map component. Add HTML or other Vue components inside the custom marker to be rendered on the map.



```vue



  

  

    


      X

    


  



export default = {

  //[...],

  methods: {

    toggle () {

      this.isBlue = !this.isBlue

    }

  },

  data() {

    return {

      isBlue: false,

      marker: {

        lat: 50.60229509638775,

        lng: 3.0247059387528408

      }

    }

  //[...]

}



```

ℹ️ Use the @click event with the .native modifier to bind a function to the clicking of the custom marker.



Specify the marker alignment with the `alignment` property. It accepts 13 values: `top`, `bottom`, `left`, `right`, `center`, `topleft`, `topright`, `bottomleft`, `bottomright`. Defines the alignment of the marker relative to the lat/lng specified, e.g. `bottomright` - the marker will be below and on the right of the location.



```vue



  
content



```



Manually specify an offset value for the marker in pixels with prop `offsetX` | `offsetY`. A positive `offsetX` moves the marker further right, and a positive `offsetY` moves the marker further down the page. Can be used with the `alignment` prop.



```vue



  
content



```



## Reference



|   **Prop**    | **Type** | **Default** |                                                                        **Description**                                                                        |                                                               **Supported Values**                                                                |

| :-----------: | :------: | :---------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------: |

|   `marker`    |  Object  |   `null`    |                                Provide the latitude and longitude values that the marker should be displayed at. **Required**                                 |                                 Provide an Object with `lat` and `lng` properties. `{ lat: Number, lng: Number }`                                 |

|   `offsetX`   |  Number  |     `0`     |                          The number of pixels to move the marker by in the x-direction. Postive values move the marker to the right                           |                                                           Positive or negative number.                                                            |

|   `offsetY`   |  Number  |     `0`     |                        The number of pixels to move the marker by in the y-direction. Postive values move the marker to down the page.                        |                                                           Positive or negative number.                                                            |

|  `alignment`  |  String  |    `top`    | The alignment of the marker element relative to the location it is displayed. e.g. `bottomright` - the marker will be below and on the right of the location. | `top`, `bottom`, `left`, `right`, `center`, `topleft`, `topright`, `bottomleft`, `bottomright` |

|   `zIndex`    |  Number  |    `50`     |                                                                    z-index of the marker.                                                                     |                                                                 Positive number.                                                                  |



## Licence



[MIT](https://en.wikipedia.org/wiki/MIT_License)



## Support



If you want to support this plugin it is possible :smile: 



[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UV5GR9QWPAEMS)