🧩 LMarker

Used to display clickable/draggable markers on the map.

🧪 Demo

<script setup lang="ts">
import { LMap, LMarker, LTileLayer } from '@maxel01/vue-leaflet'
import type { LatLngTuple } from 'leaflet'

const coordinates: LatLngTuple = [50, 50]
</script>

<template>
    <LMap :zoom="2" :center="[47.41322, -1.219482]">
        <LTileLayer
            url="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
            layer-type="base"
            name="OpenStreetMap"
        />
        <LMarker :lat-lng="coordinates" draggable />
    </LMap>
</template>

⚙️ Props

Prop name	Description	Type	Reactive	Default	Required
draggable	Whether the marker is draggable with mouse/touch or not.	boolean	true	-	false
icon	Icon instance to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. If not specified, a common instance of Icon.Default is used.	Icon	true	-	false
zIndexOffset	By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like 1000 (or high negative value, respectively).	number	true	-	false
latLng	The position of the marker	LatLngExpression	true	-	true

🔗 Inherited props

from LayerProps

Prop name	Description	Type	Reactive	Default	Required
visible	-	boolean	true	-	false
layerType	-	LayerType	true	-	false
name	-	string	true	-	false
attribution	String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.	string	true	-	false
pane	By default, the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. Not effective if the renderer option is set (the renderer option will override the pane option).	string	initOnly	-	false

from ComponentProps

Prop name	Description	Type	Reactive	Default	Required
options	Leaflet options to pass to the component constructor.	T	initOnly	-	false

📡 Emits

Event	Arguments	Description
update:visible	boolean	Triggers when the visible prop needs to be updated
ready	Marker	Triggers when the component is ready
update:latLng	LatLngExpression	Triggers when the latLng prop needs to be updated
update:lat-lng	LatLngExpression	Triggers when the latLng prop needs to be updated

🎯 Slots

Name	Description
default	Used to inject Leaflet child components like <LPopup> or <LTooltip> into the LMarker.

🧭 Exposes

Name	Type	Description
ready	Ref<boolean>	Indicates whether the component and its underlying Leaflet object are fully initialized.
leafletObject	Ref<Marker | undefined>	The underlying Leaflet instance. Can be used to directly interact with the Leaflet API (e.g. calling methods or accessing internal state).