@maplibre/maplibre-react-native 8.6.0-beta.0

package/docs/FillExtrusionLayer.md

@@ -0,0 +1,327 @@
+<!-- This file was autogenerated from FillExtrusionLayer.js do not modify -->
+## <MapboxGL.FillExtrusionLayer />
+### FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
+| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
+| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
+| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
+| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
+| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
+| filter | `array` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
+| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
+| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
+| style | `union` | `none` | `false` | Customizable style attributes |
+
+
+### styles
+
+* <a href="#name">visibility</a><br/>
+* <a href="#name-1">fillExtrusionOpacity</a><br/>
+* <a href="#name-2">fillExtrusionColor</a><br/>
+* <a href="#name-3">fillExtrusionTranslate</a><br/>
+* <a href="#name-4">fillExtrusionTranslateAnchor</a><br/>
+* <a href="#name-5">fillExtrusionPattern</a><br/>
+* <a href="#name-6">fillExtrusionHeight</a><br/>
+* <a href="#name-7">fillExtrusionBase</a><br/>
+
+___
+
+#### Name
+`visibility`
+
+#### Description
+Whether this layer is displayed.
+
+#### Type
+`enum`
+#### Default Value
+`visible`
+
+#### Supported Values
+**visible** - The layer is shown.<br />
+**none** - The layer is not shown.<br />
+
+
+
+___
+
+#### Name
+`fillExtrusionOpacity`
+
+#### Description
+The opacity of the entire fill extrusion layer. This is rendered on a perLayer, not perFeature, basis, and dataDriven styling is not available.
+
+#### Type
+`number`
+#### Default Value
+`1`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`fillExtrusionOpacityTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionOpacity propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillExtrusionColor`
+
+#### Description
+The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fillExtrusionOpacity` to set layer opacity.
+
+#### Type
+`color`
+#### Default Value
+`#000000`
+
+
+#### Disabled By
+`fillExtrusionPattern`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillExtrusionColorTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionColor propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillExtrusionTranslate`
+
+#### Description
+The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
+
+#### Type
+`array<number>`
+#### Default Value
+`[0,0]`
+
+#### Units
+`pixels`
+
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`fillExtrusionTranslateTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionTranslate propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillExtrusionTranslateAnchor`
+
+#### Description
+Controls the frame of reference for `fillExtrusionTranslate`.
+
+#### Type
+`enum`
+#### Default Value
+`map`
+
+#### Supported Values
+**map** - The fill extrusion is translated relative to the map.<br />
+**viewport** - The fill extrusion is translated relative to the viewport.<br />
+
+
+#### Requires
+`fillExtrusionTranslate`
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### Name
+`fillExtrusionPattern`
+
+#### Description
+Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.
+
+#### Type
+`resolvedImage`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
+___
+
+#### Name
+
+`fillExtrusionPatternTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionPattern propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillExtrusionHeight`
+
+#### Description
+The height with which to extrude this layer.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Units
+`meters`
+
+#### Minimum
+`0`
+
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillExtrusionHeightTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionHeight propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillExtrusionBase`
+
+#### Description
+The height with which to extrude the base of this layer. Must be less than or equal to `fillExtrusionHeight`.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Units
+`meters`
+
+#### Minimum
+`0`
+
+
+#### Requires
+`fillExtrusionHeight`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillExtrusionBaseTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillExtrusionBase propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+

package/docs/FillLayer.md

@@ -0,0 +1,293 @@
+<!-- This file was autogenerated from FillLayer.js do not modify -->
+## <MapboxGL.FillLayer />
+### FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
+| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
+| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
+| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
+| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
+| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
+| filter | `array` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
+| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
+| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
+| style | `union` | `none` | `false` | Customizable style attributes |
+
+
+### styles
+
+* <a href="#name">visibility</a><br/>
+* <a href="#name-1">fillAntialias</a><br/>
+* <a href="#name-2">fillOpacity</a><br/>
+* <a href="#name-3">fillColor</a><br/>
+* <a href="#name-4">fillOutlineColor</a><br/>
+* <a href="#name-5">fillTranslate</a><br/>
+* <a href="#name-6">fillTranslateAnchor</a><br/>
+* <a href="#name-7">fillPattern</a><br/>
+
+___
+
+#### Name
+`visibility`
+
+#### Description
+Whether this layer is displayed.
+
+#### Type
+`enum`
+#### Default Value
+`visible`
+
+#### Supported Values
+**visible** - The layer is shown.<br />
+**none** - The layer is not shown.<br />
+
+
+
+___
+
+#### Name
+`fillAntialias`
+
+#### Description
+Whether or not the fill should be antialiased.
+
+#### Type
+`boolean`
+#### Default Value
+`true`
+
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### Name
+`fillOpacity`
+
+#### Description
+The opacity of the entire fill layer. In contrast to the `fillColor`, this value will also affect the 1px stroke around the fill, if the stroke is used.
+
+#### Type
+`number`
+#### Default Value
+`1`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillOpacityTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillOpacity propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillColor`
+
+#### Description
+The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
+
+#### Type
+`color`
+#### Default Value
+`#000000`
+
+
+#### Disabled By
+`fillPattern`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillColorTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillColor propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillOutlineColor`
+
+#### Description
+The outline color of the fill. Matches the value of `fillColor` if unspecified.
+
+#### Type
+`color`
+
+
+#### Disabled By
+`fillPattern`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillOutlineColorTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillOutlineColor propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillTranslate`
+
+#### Description
+The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
+
+#### Type
+`array<number>`
+#### Default Value
+`[0,0]`
+
+#### Units
+`pixels`
+
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`fillTranslateTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillTranslate propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`fillTranslateAnchor`
+
+#### Description
+Controls the frame of reference for `fillTranslate`.
+
+#### Type
+`enum`
+#### Default Value
+`map`
+
+#### Supported Values
+**map** - The fill is translated relative to the map.<br />
+**viewport** - The fill is translated relative to the viewport.<br />
+
+
+#### Requires
+`fillTranslate`
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### Name
+`fillPattern`
+
+#### Description
+Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.
+
+#### Type
+`resolvedImage`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
+___
+
+#### Name
+
+`fillPatternTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillPattern propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+

package/docs/GettingStarted.md

@@ -0,0 +1,72 @@
+# Getting Started
+
+Congratulations, you successfully installed maplibre-react-native! 🎉
+Where to go from here?
+You can head straight to [examples](/example) folder if you want to jump into the deep end.
+However, if you prefer an easier ramp-up, then make sure to stick around and check out the guides below.
+
+## Setting your accessToken
+
+FIXME: Rewrite this guide, but esp this section.
+
+In order to work, mapbox requires you to create an accessToken and set it in your app.
+If you haven't created one yet, make sure to sign up for an account [here](https://www.mapbox.com/signup/)
+You can create and manage your access tokens on your [Mapbox Account page](https://www.mapbox.com/account/)
+Once you have your accessToken, set it like this
+
+```js
+import MapboxGL from "@maplibre/maplibre-react-native";
+
+MapboxGL.setAccessToken("<YOUR_ACCESSTOKEN>");
+```
+
+## Setting connection status [Android only]
+
+If you are hosting styles and sources on localhost, you might need to set the connection status manually for Mapbox to be able to use them. See [mapbox/mapbox-gl-native#12819](https://github.com/mapbox/mapbox-gl-native/issues/12819).
+
+Manually sets the connectivity state of the app, bypassing any checks to the ConnectivityManager. Set to `true` for connected, `false` for disconnected, and `null` for ConnectivityManager to determine.
+
+```js
+import MapboxGL from "@maplibre/maplibre-react-native";
+
+MapboxGL.setConnected(true);
+```
+
+## Show a map
+
+```js
+import React, { Component } from "react";
+import { StyleSheet, View } from "react-native";
+import MapboxGL from "@maplibre/maplibre-react-native";
+
+MapboxGL.setAccessToken("<YOUR_ACCESSTOKEN>");
+
+const styles = StyleSheet.create({
+  page: {
+    flex: 1,
+    justifyContent: "center",
+    alignItems: "center",
+    backgroundColor: "#F5FCFF"
+  },
+  container: {
+    height: 300,
+    width: 300,
+    backgroundColor: "tomato"
+  },
+  map: {
+    flex: 1
+  }
+});
+
+export default class App extends Component {
+  render() {
+    return (
+      <View style={styles.page}>
+        <View style={styles.container}>
+          <MapboxGL.MapView style={styles.map} />
+        </View>
+      </View>
+    );
+  }
+}
+```

package/docs/HeadingIndicator.md

@@ -0,0 +1,10 @@
+<!-- This file was autogenerated from HeadingIndicator.js do not modify -->
+## <MapboxGL.HeadingIndicator />
+### 
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| heading | `number` | `none` | `false` | FIX ME NO DESCRIPTION |
+
+