[v8] Documentation #2471
Open
[v8] Documentation #2471
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisgervang
approved these changes
Jan 24, 2025
| @@ -1,20 +1,6 @@ | |||
|
|
|||
| # Introduction | |||
|
|
|||
| <p align="center"> | |||
| These docs are for | |||
| <a href="https://github.com/visgl/react-map-gl/tree/7.0-release/docs"> | |||
There was a problem hiding this comment.
Are these retained somewhere?
|
|
||
| #### LngLatLike | ||
|
|
||
| A [`LngLat`](#lnglat) object, an array of two numbers representing longitude and latitude, or an object with `lng` and `lat` or `lon` and `lat` properties. ([Mapbox](https://docs.mapbox.com/mapbox-gl-js/api/geography/#lnglatlike) | [Maplibre](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/LngLatLike/)) |
There was a problem hiding this comment.
These "-like" types should retain their old basemap doc urls since they're different than the wrapped type
|
|
||
| #### LngLatBoundsLike | ||
|
|
||
| A [`LngLatBounds`](#lnglatbounds) object, an array of [`LngLatLike`](#lnglatlike) objects in [sw, ne] order, or an array of numbers in [west, south, east, north] order. ([Mapbox](https://docs.mapbox.com/mapbox-gl-js/api/geography/#lnglatboundslike) | [Maplibre](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/LngLatBoundsLike/)) |
|
|
||
| #### PointLike | ||
|
|
||
| A [Point](#point) or an array of two numbers representing x and y screen coordinates in pixels ([Mapbox](https://docs.mapbox.com/mapbox-gl-js/api/geography/#pointlike) | [Maplibre](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/PointLike/)). |
|
|
||
| #### GeoJSONSource | ||
|
|
||
| A source containing GeoJSON. See `GeoJSONSource` ([Mapbox](https://docs.mapbox.com/mapbox-gl-js/api/sources/#geojsonsource) | [Maplibre](https://maplibre.org/maplibre-gl-js/docs/API/classes/GeoJSONSource/)). |
There was a problem hiding this comment.
Is there any difference between the Mapbox style spec and the API doc contents for these Source types? (I see how they're duped above, except for the links)
|
|
||
| Note: props in this section are not reactive. They are only used once when the Map instance is constructed. | ||
|
|
||
| #### `mapLib`: any {#maplib} |
There was a problem hiding this comment.
Just to confirm, this prop still exists?
Is there any type inference from its value?
I'm looking at Hubble.gl right now as an example of a library compatible with both maplibre and mapbox, so I'll be looking at how common types flow into the maps.
I don't think libs should use mapLib (instead, use either top-level Map component).
| @@ -2,12 +2,12 @@ | |||
|
|
|||
| ## Native Mapbox Layers | |||
|
|
|||
| You can inject data and mapbox native layers using the [Source](../api-reference/source.md) and [Layer](../api-reference/layer.md) components: | |||
| You can inject data and mapbox native layers using the [Source](../api-reference/mapbox/source.md) and [Layer](../api-reference/mapbox/layer.md) components: | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split API reference into separate sections for Mapbox and Maplibre