Skip to content

useLeafletDeps

Returns undefined if any of the dependencies is falsy, otherwise returns the value from the source.

Demo

Usage

vue
<script setup lang="ts">
import { ref } from 'vue';
import {
  useLeafletMap,
  useLeafletTileLayer,
  useLeafletDisplayLayer,
  useLeafletMarker,
  useLeafletDeps
} from 'vue-use-leaflet';

const el = ref<HTMLElement | null>(null);
const map = useLeafletMap(el);
const tileLayer = useLeafletTileLayer(
  'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
);
useLeafletDisplayLayer(map, tileLayer);

// init dependency
const dep = ref(false);

// create marker
const marker = useLeafletMarker([0, 0]);

// display marker when dependency is truthy
useLeafletDisplayLayer(map, useLeafletDeps(marker, dep));
</script>

<template>
  <div ref="el" style="height: 250px"></div>
</template>
<script setup lang="ts">
import { ref } from 'vue';
import {
  useLeafletMap,
  useLeafletTileLayer,
  useLeafletDisplayLayer,
  useLeafletMarker,
  useLeafletDeps
} from 'vue-use-leaflet';

const el = ref<HTMLElement | null>(null);
const map = useLeafletMap(el);
const tileLayer = useLeafletTileLayer(
  'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
);
useLeafletDisplayLayer(map, tileLayer);

// init dependency
const dep = ref(false);

// create marker
const marker = useLeafletMarker([0, 0]);

// display marker when dependency is truthy
useLeafletDisplayLayer(map, useLeafletDeps(marker, dep));
</script>

<template>
  <div ref="el" style="height: 250px"></div>
</template>

Type Declarations

ts
export type UseLeafletDepsReturn<T> = ComputedRef<T | undefined>;
export declare function useLeafletDeps<T = any>(
  source: MaybeRefOrGetter<T>,
  ...deps: MaybeRefOrGetter<any>[]
): UseLeafletDepsReturn<T>;
export type UseLeafletDepsReturn<T> = ComputedRef<T | undefined>;
export declare function useLeafletDeps<T = any>(
  source: MaybeRefOrGetter<T>,
  ...deps: MaybeRefOrGetter<any>[]
): UseLeafletDepsReturn<T>;

Source

SourceDemoDocs

Released under the MIT License.