npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-mapbox-gl-wrapper

v1.2.5

Published

Mapbox GL Javascript wrapper for ReactJS

Downloads

16

Readme

react-mapbox-wrapper

Build Status npm version

React wrapper for mapboxgl-js API.

Made with ❤️ by MeilleursAgents

Usage

import React from 'react';
import MapboxMap from 'react-mapbox-wrapper';

export default function SimpleMap() {
  return (
    <div style={{ height: 400, width: 400 }}>
      <MapboxMap
        accessToken="<your acess token here>"
        coordinates={{ lat: 48.872198, lng: 2.3366308 }}
      />
    </div>
  );
}

SimpleMap.displayName = 'SimpleMap';

See examples folder for more example.

Getting started

Read carefully the getting started section of Mapbox GL API.

If you use Webpack, you should add the following parameter in order to properly build your app.

module: {
    noParse: /(mapbox-gl)\.js$/,
}

react-mapbox-wrapper import the corresponding CSS stylesheet from Javascript, you don't have to do it.

API

MapboxMap

React Component that render a Mapbox Map. Extra props are directly passed to the Map constructor. Following props are handled by wrapper for updating or handling behavior in the React philosophy.

Wrapper is CSS flex-ready for width but you have to set a height for having visible Mapbox.

| Props | Type | Default | Description | | -- | -- | -- | -- | | accessToken | String | required | Mapbox Access Token (find it here) | | coordinates | Object | required | Coordinates of the map center In the form { lng: 3.4, lat: 1.2 } | | className | string | '' | className added to map's wrapper. Your should provide a height in order to render the map (default at 0) | | children | Node | null | Rendered children, typically a Marker and/or Circle | | minZoom | number | undefined | The minimum zoom level of the map (0-24). | | maxZoom | number | undefined | The maximum zoom level of the map (0-24). | | zoom | number | 15 | The viewport zoom | | onChange | func | undefined | Callback function called on every viewport change (moveend, zoomend) Callback receive param with the following shape { zoom: 15, coordinates: { lng: 3.4, lat: 1.2 } } | | onClick | func | undefined | Callback function called on map's click | | onLoad | func | undefined | Callback function called on map's load with current Mapbox instance param | | onZoomStart | func | undefined | Callback function called on map's zoomstart | | onZoomEnd | func | undefined | Callback function called on map's zoomend with a debounce of 300ms in order to avoid too many render() call | | renderNotSupported | func | Simple message | Callback function called when browser does not support mapbox-gl | | style | String | | Mapbox style layer | | withCompass | bool | false | Show compass Navigation Control | | withFullscreen | bool | false | Show Fullscreen Control | | withZoom | bool | false | Show zoom Navigation Control |

Marker

React Component that render a Marker. Extra props are directly passed to the Marker constructor

| Props | Type | Default | Description | | -- | -- | -- | -- | | children | Node | null | Marker HTML DOM, default marker will be used if not provided | | coordinates | Object | required | Coordinates of the marker In the form { lng: 3.4, lat: 1.2 } | | draggable | bool | false | Allow user to drag'n'drop Marker | | getRef | func | | Callback function called with marker's ref (useful for calling #moveToTop() function) | | map | Object | required | Mapbox Map where marker will be added (can be obtained with MapboxMap#onLoad props fn) | | onDragEnd | func | | Callback function called on marker's dragend | | onMouseOut | func | | Callback function called on marker or popup mouseOut | | onMouseOver | func | | Callback function called on marker or popup mouseOver | | popup | Node | | Popup attached to the marker, displayed on click to marker | | popupCloseButton | bool | false | Popup closeButton param | | popupOffset | number | | Popup offset param | | popupOnOver | bool | false | Trigger popup show on mouse over (only available if children are provided, default marker cannot be bind) |

Circle

React Component that render a Circle. Extra props are directly passed to the Marker constructor

| Props | Type | Default | Description | | -- | -- | -- | -- | | coordinates | Object | required | Coordinates of the marker In the form { lng: 3.4, lat: 1.2 } | | id | string | required | Identifier of circle, used to name the underlying layer | | map | Object | required | Mapbox Map where marker will be added (can be obtained with MapboxMap#onLoad props fn) | | onClick | func | | Callback function called on circle's click | | paint | Object | | Paint option of the layer | | radius | number | required | Radius of circle, in kilometers | | unit | string | kilometers | Unit of the radius. values can be : kilometers, meters, miles, feet |

Development

npm install && npm run peers # install both dependencies and peers

You can use npm link while developping new features on this repo for use in targeted repository.

npm link /path/to/react-mapbox-wrapper

Git hooks

You can use our pre-commit hook for ensuring consistent format and linting before committing by running command:

./tools/install_hooks.sh