npmpackage.info

Gathering detailed insights and metrics for react-map-gl-geocoder

Other packages similar to react-map-gl-geocoder

@mapbox/mapbox-gl-geocoder

5.0.3

A geocoder control for Mapbox GL JS

@maplibre/maplibre-gl-geocoder

1.7.0

A geocoder control for Maplibre GL JS

react-map-gl

7.1.7

React components for Mapbox GL JS-compatible libraries

@types/mapbox__mapbox-gl-geocoder

5.0.0

TypeScript definitions for @mapbox/mapbox-gl-geocoder

Gathering detailed insights and metrics for react-map-gl-geocoder

react-map-gl-geocoder

React wrapper for mapbox-gl-geocoder for use with react-map-gl

2.2.0

122

MIT

JavaScript

213.89 kB

1,320,097 1.7

Installations

npm install react-map-gl-geocoder

Score

53.6

Supply Chain

86.8

Quality

70.6

Maintenance

Vulnerability

95.6

License

Pull Requests

Open

33

Total

52

Closed

11

Merged

8

Issues

Open

15

Total

101

Closed

86

Releases

v2.1.0

Published on 29 Aug 2020

v2.0.0

2.0.0

Published on 28 Apr 2019

View all 2 releases

Developer

SamSamskies

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

14.15.3

NPM Version

6.14.9 Statistics

122 Stars

119 Commits

29 Forks

4 Watching

37 Branches

4 Contributors

Updated on 07 Oct 2024

Bundle Size

816.79 kB

Minified

213.89 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (88.3%)

HTML (11.7%)

Total Downloads

Cumulative downloads

Total Downloads

1,320,097

Last day

-18.9%

616

Compared to previous day

Last week

13.1%

3,577

Compared to previous week

Last month

-8.6%

14,682

Compared to previous month

Last year

-25.4%

202,753

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

react-map-gl-geocoder

React wrapper for mapbox-gl-geocoder for use with react-map-gl.

Demos

Simple Example - https://codesandbox.io/s/l7p179qr6m
Ignore Map Events Example - https://codesandbox.io/s/react-map-gl-geocoder-using-containerref-to-ignore-events-rewdh

Installation

npm

$ npm install react-map-gl-geocoder

Yarn

$ yarn add react-map-gl-geocoder

Styling

Import:

1import 'react-map-gl-geocoder/dist/mapbox-gl-geocoder.css'

Link tag in header:

1<link href='https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-geocoder/v4.2.0/mapbox-gl-geocoder.css' rel='stylesheet' />

Props

Only mapRef and mapboxApiAccessToken are required.

All non-primitive prop values besides mapRef and containerRef should be memoized.

Name	Type	Default	Description
mapRef	Object		Ref for react-map-gl map component.
containerRef	Object		This can be used to place the geocoder outside of the map. The `position` prop is ignored if this is passed in. Example: https://codesandbox.io/s/v0m14q5rly
onViewportChange	Function	() => {}	Is passed updated viewport values after executing a query.
mapboxApiAccessToken	String		https://www.mapbox.com/
inputValue	String		Sets the search input value
origin	String	"https://api.mapbox.com"	Use to set a custom API origin.
zoom	Number	16	On geocoded result what zoom level should the map animate to when a `bbox` isn't found in the response. If a `bbox` is found the map will fit to the `bbox`.
placeholder	String	"Search"	Override the default placeholder attribute value.
proximity	Object		A proximity argument: this is a geographical point given as an object with latitude and longitude properties. Search results closer to this point will be given higher priority.
trackProximity	Boolean	false	If true, the geocoder proximity will automatically update based on the map view.
collapsed	Boolean	false	If true, the geocoder control will collapse until hovered or in focus.
clearAndBlurOnEsc	Boolean	false	If true, the geocoder control will clear it's contents and blur when user presses the escape key.
clearOnBlur	Boolean	false	If true, the geocoder control will clear its value when the input blurs.
bbox	Array		A bounding box argument: this is a bounding box given as an array in the format [minX, minY, maxX, maxY]. Search results will be limited to the bounding box.
types	String		A comma seperated list of types that filter results to match those specified. See https://www.mapbox.com/developers/api/geocoding/#filter-type for available types.
countries	String		A comma separated list of country codes to limit results to specified country or countries.
minLength	Number	2	Minimum number of characters to enter before results are shown.
limit	Number	5	Maximum number of results to show.
language	String		Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
filter	Function		A function which accepts a Feature in the Carmen GeoJSON format to filter out results from the Geocoding API response before they are included in the suggestions list. Return `true` to keep the item, `false` otherwise.
localGeocoder	Function		A function accepting the query string which performs local geocoding to supplement results from the Mapbox Geocoding API. Expected to return an Array of GeoJSON Features in the Carmen GeoJSON format.
localGeocoderOnly	Boolean	false	If true, indicates that the localGeocoder results should be the only ones returned to the user. If false, indicates that the localGeocoder results should be combined with those from the Mapbox API with the localGeocoder results ranked higher.
reverseGeocode	Boolean	false	Enable reverse geocoding. Defaults to false. Expects coordinates to be lat, lon.
enableEventLogging	Boolean	true	Allow Mapbox to collect anonymous usage statistics from the plugin.
marker	Boolean or Object	true	If true, a Marker will be added to the map at the location of the user-selected result using a default set of Marker options. If the value is an object, the marker will be constructed using these options. If false, no marker will be added to the map.
render	Function		A function that specifies how the results should be rendered in the dropdown menu. Accepts a single Carmen GeoJSON object as input and return a string. Any html in the returned string will be rendered. Uses mapbox-gl-geocoder's default rendering if no function provided.
position	String	"top-right"	Position on the map to which the geocoder control will be added. Valid values are `"top-left"`, `"top-right"`, `"bottom-left"`, and `"bottom-right"`.
onInit	Function	() => {}	Is passed Mapbox geocoder instance as param and is executed after Mapbox geocoder is initialized.
onClear	Function	() => {}	Executed when the input is cleared.
onLoading	Function	() => {}	Is passed `{ query }` as a param and is executed when the geocoder is looking up a query.
onResults	Function	() => {}	Is passed `{ results }` as a param and is executed when the geocoder returns a response.
onResult	Function	() => {}	Is passed `{ result }` as a param and is executed when the geocoder input is set.
onError	Function	() => {}	Is passed `{ error }` as a param and is executed when an error occurs with the geocoder.

Examples

Simple Example

1import 'mapbox-gl/dist/mapbox-gl.css'
2import 'react-map-gl-geocoder/dist/mapbox-gl-geocoder.css'
3import React, { useState, useRef, useCallback } from 'react'
4import MapGL from 'react-map-gl'
5import Geocoder from 'react-map-gl-geocoder'
6
7// Ways to set Mapbox token: https://uber.github.io/react-map-gl/#/Documentation/getting-started/about-mapbox-tokens
8const MAPBOX_TOKEN = 'REPLACE_WITH_YOUR_MAPBOX_TOKEN'
9
10const Example = () => {
11  const [viewport, setViewport] = useState({
12    latitude: 37.7577,
13    longitude: -122.4376,
14    zoom: 8
15  });
16  const mapRef = useRef();
17  const handleViewportChange = useCallback(
18    (newViewport) => setViewport(newViewport),
19    []
20  );
21
22  // if you are happy with Geocoder default settings, you can just use handleViewportChange directly
23  const handleGeocoderViewportChange = useCallback(
24    (newViewport) => {
25      const geocoderDefaultOverrides = { transitionDuration: 1000 };
26
27      return handleViewportChange({
28        ...newViewport,
29        ...geocoderDefaultOverrides
30      });
31    },
32    []
33  );
34
35  return (
36    <div style={{ height: "100vh" }}>
37      <MapGL
38        ref={mapRef}
39        {...viewport}
40        width="100%"
41        height="100%"
42        onViewportChange={handleViewportChange}
43        mapboxApiAccessToken={MAPBOX_TOKEN}
44      >
45        <Geocoder
46          mapRef={mapRef}
47          onViewportChange={handleGeocoderViewportChange}
48          mapboxApiAccessToken={MAPBOX_TOKEN}
49          position="top-left"
50        />
51      </MapGL>
52    </div>
53  );
54};
55
56export default Example

Ignore Map Events Example

You can use the containerRef prop to place the Geocoder component outside of the MapGL component to avoid propagating the mouse events to the MapGL component. You can use CSS to position it over the map as shown in this example.

1import 'mapbox-gl/dist/mapbox-gl.css'
2import 'react-map-gl-geocoder/dist/mapbox-gl-geocoder.css'
3import React, { useState, useRef, useCallback } from 'react'
4import MapGL from 'react-map-gl'
5import Geocoder from 'react-map-gl-geocoder'
6
7// Ways to set Mapbox token: https://uber.github.io/react-map-gl/#/Documentation/getting-started/about-mapbox-tokens
8const MAPBOX_TOKEN = 'REPLACE_WITH_YOUR_MAPBOX_TOKEN'
9
10const Example = () => {
11  const [viewport, setViewport] = useState({
12    latitude: 37.7577,
13    longitude: -122.4376,
14    zoom: 8,
15  });
16  const geocoderContainerRef = useRef();
17  const mapRef = useRef();
18  const handleViewportChange = useCallback(
19    (newViewport) => setViewport(newViewport),
20    []
21  );
22
23  return (
24    <div style={{ height: "100vh" }}>
25      <div
26        ref={geocoderContainerRef}
27        style={{ position: "absolute", top: 20, left: 20, zIndex: 1 }}
28      />
29      <MapGL
30        ref={mapRef}
31        {...viewport}
32        width="100%"
33        height="100%"
34        onViewportChange={handleViewportChange}
35        mapboxApiAccessToken={MAPBOX_TOKEN}
36      >
37        <Geocoder
38          mapRef={mapRef}
39          containerRef={geocoderContainerRef}
40          onViewportChange={handleViewportChange}
41          mapboxApiAccessToken={MAPBOX_TOKEN}
42          position="top-left"
43        />
44      </MapGL>
45    </div>
46  );
47};

Sample Screenshot

react-map-gl-geocoder example screenshot

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

94 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w
Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf
Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

1.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-map-gl-geocoder

Other packages similar to react-map-gl-geocoder

react-map-gl-geocoder

Installations

Score

Pull Requests

33

52

11

8

Issues

15

101

86

Releases

Developer

SamSamskies

Developer Guide

CommonJS

No

14.15.3

6.14.9

Statistics

Bundle Size

816.79 kB

213.89 kB

Languages

Total Downloads

1,320,097

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

react-map-gl-geocoder

Demos

Installation

Styling

Props

Examples

Simple Example

Ignore Map Events Example

Sample Screenshot

10

10

0

0

0

0

0

0

0

0

1.7

/10