@mongodb-js/react-mapbox-gl-leaflet

1.0.0 • Public • Published 5 years ago

react-mapbox-gl-leaflet

React wrapper of mapbox-gl-leaflet for react-leaflet.

Demos

Package version	Dependency Versions	Demo
`1.0.0`	`react-leaflet@2.x.x`, `mapbox-gl-leaflet@0.0.3`	Link

Installation

npm install @mongodb-js/react-mapbox-gl-leaflet --save

You will also need to manually install the following peer dependencies:

npm install leaflet react react-dom react-leaflet mapbox-gl mapbox-gl-leaflet --save

Usage

Please consult the mapbox-gl-leaflet documentation for available prop options, the Mapbox Vector Tile Specification for defining the map tile data, and the Mapbox Style Specification for defining the visual appearance of the map.

import React from 'react';
import { Map } from 'react-leaflet';
import MapboxGlLayer from '@mongodb-js/react-mapbox-gl-leaflet';

const DemoComponent = () => {
  return (
    <Map>
      <MapboxGlLayer
        accessToken="for-usage-with-mapbox-api-only"
        style="https://your-tile-server.com/path/to/your/map-style.json"
        attribution="Copyright attribution message goes here" />
    </Map>
  );
}

Contributing

Pull requests of any kind are welcome from the community. Please ensure you have read the guidelines for Contributing and this project's Code of Conduct before raising a pull request.