Skip to content
This repository has been archived by the owner on Oct 17, 2022. It is now read-only.

This is a svelte component to make layer legend for maplibre-gl

License

Notifications You must be signed in to change notification settings

watergis/svelte-maplibre-legend

Repository files navigation

This package was moved into watergis/svelte-maplibre-components

svelte-maplibre-legend

This is a svelte component to make layer legend for maplibre-gl

demo.gif

Install

npm i @watergis/svelte-maplibre-legend

or

yarn add @watergis/svelte-maplibre-legend

Usage

See Example.

<script lang="ts">
  import LayerListPanel from '@watergis/svelte-maplibre-legend';

  // create maplibre.Map object
  let map = new Map();

  // set style for legend
  style = map.getStyle()

  // to set filter to enable to show only relative layers and alias of layer name
  let relativeLayers: { [key: string]: string } = {
    pipeline: 'Pipeline'
  };
</script>

<LayerListPanel bind:map {style} {relativeLayers} />

<style>
  @import "https://cdn.jsdelivr.net/npm/[email protected]/css/bulma.min.css";
</style>

This library relies on Bulma CSS. Please import Bulma CSS from either NPM or CDN. For the Bulma CSS, further information can be found here

create-svelte

Everything you need to build a Svelte project, powered by create-svelte.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.