Package Exports

maplibre-gl-style-flipper
maplibre-gl-style-flipper/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (maplibre-gl-style-flipper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

MapLibre GL Style Flipper

A custom control to switch between different map styles in MapLibre GL JS.

Features

Easy Integration: Add a style switcher control to your MapLibre GL JS map with just a few lines of code.
Customizable Styles: Define your own map styles with names, images, and URLs.
Responsive Design: Buttons adapt to different screen sizes.
Callback Support: Execute custom logic when the map style changes.

Installation

Install the package via npm:

npm install maplibre-gl-style-flipper

Or include it directly via a CDN:

<script src="https://unpkg.com/maplibre-gl-style-flipper@latest/dist/style-flipper-control.js"></script>

Usage

Basic Example

Here’s how to use the StyleFlipperControl in a simple HTML file:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>MapLibre GL Style Flipper</title>
    <script src="https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.css" rel="stylesheet" />
    <style>
        body, html {
            margin: 0;
            padding: 0;
            height: 100%;
        }
        #map {
            height: 100%;
            width: 100%;
        }
    </style>
</head>
<body>
    <div id="map"></div>
    <script type="module">
        import { StyleFlipperControl } from 'https://unpkg.com/maplibre-gl-style-flipper@1.0.1/index.js';

        // Define map styles
        const mapStyles = {
            "carto-positron": {
                code: "carto-positron",
                url: "https://basemaps.cartocdn.com/gl/positron-gl-style/style.json",
                image: "https://carto.com/help/images/building-maps/basemaps/positron_labels.png",
            },
            "carto-dark": {
                code: "carto-dark",
                url: "https://basemaps.cartocdn.com/gl/dark-matter-gl-style/style.json",
                image: "https://carto.com/help/images/building-maps/basemaps/dark_labels.png",
            },
            "carto-voyager": {
                code: "carto-voyager",
                url: "https://basemaps.cartocdn.com/gl/voyager-gl-style/style.json",
                image: "https://carto.com/help/images/building-maps/basemaps/voyager_labels.png",
            },
        };

        // Initialize the map
        const map = new maplibregl.Map({
            container: "map",
            style: mapStyles["carto-positron"].url, // Default style
            center: [0, 0], // Initial center
            zoom: 1, // Initial zoom
        });

        // Add navigation control
        map.addControl(new maplibregl.NavigationControl());

        // Create an instance of StyleFlipperControl
        const styleFlipperControl = new StyleFlipperControl(mapStyles);

        // Set the initial style code
        styleFlipperControl.setCurrentStyleCode("carto-positron");

        // Add the control to the map
        map.addControl(styleFlipperControl, "bottom-left");
    </script>
</body>
</html>

Explanation

Map Styles:
- The mapStyles object contains the styles you want to switch between. Each style has:
  - code: A unique identifier for the style.
  - url: The URL of the MapLibre GL style.
  - image: The path to an image that represents the style (used in the control buttons).
Map Initialization:
- The map is initialized with a default style (carto-positron in this case).
Style Flipper Control:
- The StyleFlipperControl is created with the mapStyles object and an optional callback function that triggers when the style changes.
- The control is added to the map using map.addControl().
Customization:
- You can customize the position of the control by changing the second argument of map.addControl() (e.g., "top-right", "bottom-left").

API Reference

`StyleFlipperControl`

Constructor

new StyleFlipperControl(styles, onStyleChange);

styles: An object containing map styles. Each key is a style name, and the value is an object with:
- code: A unique identifier for the style.
- url: The URL of the MapLibre GL style.
- image: The path to an image that represents the style.
onStyleChange (optional): A callback function that is triggered when the style changes. It receives two arguments:
- styleClass: The name of the selected style.
- styleCode: The code of the selected style.

Methods

setCurrentStyleCode(code):
- Sets the current style code and highlights the corresponding button.
- code: The code of the style to set as active.

Customization

CSS Styling

You can customize the appearance of the control by overriding the default CSS. Here’s an example:

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for details.