mirror of
https://github.com/visgl/react-map-gl.git
synced 2025-12-08 20:16:02 +00:00
74 lines
2.2 KiB
Markdown
74 lines
2.2 KiB
Markdown
# Source
|
|
|
|
|
|
|
|
This component allows apps to create a [map source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources) using React. It may contain [Layer](/docs/api-reference/layer.md) components as children.
|
|
|
|
```js
|
|
import * as React from 'react';
|
|
import ReactMapGL, {Source, Layer} from 'react-map-gl';
|
|
|
|
const geojson = {
|
|
type: 'FeatureCollection',
|
|
features: [
|
|
{type: 'Feature', geometry: {type: 'Point', coordinates: [-122.4, 37.8]}}
|
|
]
|
|
};
|
|
|
|
const layerStyle = {
|
|
id: 'point',
|
|
type: 'circle',
|
|
paint: {
|
|
'circle-radius': 10,
|
|
'circle-color': '#007cbf'
|
|
}
|
|
};
|
|
|
|
function App() {
|
|
const [viewport, setViewport] = React.useState({
|
|
longitude: -122.45,
|
|
latitude: 37.78,
|
|
zoom: 14
|
|
});
|
|
return (
|
|
<ReactMapGL {...viewport} width="100vw" height="100vh" onViewportChange={setViewport}>
|
|
<Source id="my-data" type="geojson" data={geojson}>
|
|
<Layer {...layerStyle} />
|
|
</Source>
|
|
</ReactMapGL>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
The props provided to this component should be conforming to the [Mapbox source specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources)or [CanvasSourceOptions](https://docs.mapbox.com/mapbox-gl-js/api/#canvassourceoptions).
|
|
|
|
Note that the map component's [mapStyle](/docs/api-reference/static-map.md#mapstyle) prop defaults to `mapbox://styles/mapbox/light-v8`. To use an empty base map with your own sources, you need to override the prop, e.g.:
|
|
|
|
```js
|
|
const EMPTY_STYLE = {
|
|
version: 8,
|
|
sources: {},
|
|
layers: []
|
|
};
|
|
|
|
<ReactMapGL ... mapStyle={EMPTY_STYLE}>
|
|
```
|
|
|
|
When props change _shallowly_, the component will attempt to update the source. Do not define objects/arrays inline to avoid perf hit.
|
|
|
|
Once a `<Source>` is mounted, the following props should not change. If add/remove multiple JSX sources dynamically, make sure you use React's [key prop](https://reactjs.org/docs/lists-and-keys.html#keys) to give each element a stable identity.
|
|
|
|
##### `id` (String)
|
|
|
|
Unique identifier of the source. If not provided, a default id will be assigned.
|
|
|
|
##### `type` (String, required)
|
|
|
|
Type of the source.
|
|
|
|
## Source
|
|
|
|
[source.js](https://github.com/visgl/react-map-gl/tree/6.0-release/src/components/source.js)
|