@maplibre/maplibre-react-native 8.6.0-beta.1 → 9.0.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@ Please add unreleased changes in the following style:
 PR Title ([#123](link to my pr))
 ```
 
+## 9.0.0
+
+Completed fork from RNMapbox, removed support for the proprietary Mapbox SDK, and updated to the latest
+MapLibre GL Native SDKs for iOS and Android.
+
+Breaking changes: Mapbox-specific names have been renamed to MapLibre.
+
 ## 8.6.0-beta.0
 
 fix: add TypeScript type for MapViews's preferredFramesPerSecond prop ([#1717](https://github.com/rnmapbox/maps/pull/1717))

package/CONTRIBUTING.md

@@ -48,7 +48,7 @@ can mitigate some of the pain with this.
 Documentation is generated from code blocks and comments.  
 It will be auto-generated when you commit changes.  
 If any changes are generated from your edits, the changed files will need to be added using `git add` before attempting the commit again.  
-To manually generate the changes, run `npm run generate`.  
+To manually generate the changes, run `yarn generate`.  
 
 Notice, that changing the documentation in the individual <COMPONENT>.md within `/docs` will not suffice.  
 The correct way is the above described

package/README.md

@@ -13,8 +13,6 @@ React Native Library for building maps with the Mapbox iOS and Android mobile SD
 supported both Mapbox and MapLibre for some time, but as the MapLibre and Mapbox SDKs have
 diverged, it has become necessary to separate the projects into specific wrappers by underlying renderer.
 
-**This project is in the process of being onboarded and prepared for broad use by the MapLibre community. PRs and tickets welcomed.** Track the status over at: https://github.com/maplibre/maplibre/issues/134
-
 ---
 
 [![npm version](https://badge.fury.io/js/%40maplibre%2Fmaplibre-react-native.svg)](https://badge.fury.io/js/%40maplibre%2Fmaplibre-react-native)  
@@ -74,14 +72,10 @@ diverged, it has become necessary to separate the projects into specific wrapper
 
 ### Misc
 
-- [MapboxGL](/docs/MapboxGL.md)
+- [MapLibreGL](/docs/MapLibreGL.md)
 - [CustomHttpHeaders](/docs/CustomHttpHeaders.md)
 - [Logger](/docs/Logger.md)
 
-## Expo Support
-
-This package is not available in the [Expo Go](https://expo.io/client) app. Learn how you can use it with [custom dev clients](/plugin/install.md).
-
 ## Contributing / local development
 
 Read the [CONTRIBUTING.md](CONTRIBUTING.md) guide in order to get familiar with how we do things around here and

package/android/install.md

@@ -9,7 +9,7 @@ you have to have a line like this in your code before using the SDK.
 You can put this near the top of your `App.js` for convenience.
 
 ```javascript
-MapboxGL.setAccessToken(null);
+MapLibreGL.setAccessToken(null);
 ```
 
 ## Setting connection status
@@ -25,7 +25,7 @@ Manually sets the connectivity state of the app, bypassing any checks to the
 and `null` for the normal `ConnectivityManager` behavior.
 
 ```js
-import MapboxGL from "@maplibre/maplibre-react-native";
+import MapLibreGL from "@maplibre/maplibre-react-native";
 
-MapboxGL.setConnected(true);
+MapLibreGL.setConnected(true);
 ```

package/android/rctmgl/build.gradle

@@ -35,7 +35,7 @@ dependencies {
     implementation "com.facebook.react:react-native:+"
 
     // MapLibre SDK
-    implementation "org.maplibre.gl:android-sdk:9.5.2"
+    implementation "org.maplibre.gl:android-sdk:9.6.0"
     implementation "org.maplibre.gl:android-sdk-turf:5.9.0"
 
     // Dependencies

package/android/rctmgl/src/main/java/com/mapbox/rctmgl/components/styles/RCTMGLStyleFactory.java

@@ -36,6 +36,9 @@ public class RCTMGLStyleFactory {
         final RCTMGLStyleValue styleValue = style.getStyleValueForKey(styleKey);
 
         switch (styleKey) {
+            case "fillSortKey":
+              RCTMGLStyleFactory.setFillSortKey(layer, styleValue);
+              break;
             case "visibility":
               RCTMGLStyleFactory.setVisibility(layer, styleValue);
               break;
@@ -106,6 +109,9 @@ public class RCTMGLStyleFactory {
             case "lineRoundLimit":
               RCTMGLStyleFactory.setLineRoundLimit(layer, styleValue);
               break;
+            case "lineSortKey":
+              RCTMGLStyleFactory.setLineSortKey(layer, styleValue);
+              break;
             case "visibility":
               RCTMGLStyleFactory.setVisibility(layer, styleValue);
               break;
@@ -411,6 +417,9 @@ public class RCTMGLStyleFactory {
         final RCTMGLStyleValue styleValue = style.getStyleValueForKey(styleKey);
 
         switch (styleKey) {
+            case "circleSortKey":
+              RCTMGLStyleFactory.setCircleSortKey(layer, styleValue);
+              break;
             case "visibility":
               RCTMGLStyleFactory.setVisibility(layer, styleValue);
               break;
@@ -758,6 +767,14 @@ public class RCTMGLStyleFactory {
       }
     }
 
+    public static void setFillSortKey(FillLayer layer, RCTMGLStyleValue styleValue) {
+      if (styleValue.isExpression()) {
+        layer.setProperties(PropertyFactory.fillSortKey(styleValue.getExpression()));
+      } else {
+        layer.setProperties(PropertyFactory.fillSortKey(styleValue.getFloat(VALUE_KEY)));
+      }
+    }
+
     public static void setVisibility(FillLayer layer, RCTMGLStyleValue styleValue) {
       layer.setProperties(PropertyFactory.visibility(styleValue.getString(VALUE_KEY)));
     }
@@ -894,6 +911,14 @@ public class RCTMGLStyleFactory {
       }
     }
 
+    public static void setLineSortKey(LineLayer layer, RCTMGLStyleValue styleValue) {
+      if (styleValue.isExpression()) {
+        layer.setProperties(PropertyFactory.lineSortKey(styleValue.getExpression()));
+      } else {
+        layer.setProperties(PropertyFactory.lineSortKey(styleValue.getFloat(VALUE_KEY)));
+      }
+    }
+
     public static void setVisibility(LineLayer layer, RCTMGLStyleValue styleValue) {
       layer.setProperties(PropertyFactory.visibility(styleValue.getString(VALUE_KEY)));
     }
@@ -1606,6 +1631,14 @@ public class RCTMGLStyleFactory {
       }
     }
 
+    public static void setCircleSortKey(CircleLayer layer, RCTMGLStyleValue styleValue) {
+      if (styleValue.isExpression()) {
+        layer.setProperties(PropertyFactory.circleSortKey(styleValue.getExpression()));
+      } else {
+        layer.setProperties(PropertyFactory.circleSortKey(styleValue.getFloat(VALUE_KEY)));
+      }
+    }
+
     public static void setVisibility(CircleLayer layer, RCTMGLStyleValue styleValue) {
       layer.setProperties(PropertyFactory.visibility(styleValue.getString(VALUE_KEY)));
     }

package/app.plugin.js

@@ -1 +1 @@
-module.exports = require('./plugin/build/withMapbox');
+module.exports = require('./plugin/build/withMapLibre');

package/docs/Annotation.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from Annotation.js do not modify -->
-## <MapboxGL.Annotation />
+## <MapLibreGL.Annotation />
 ### 
 
 ### props

package/docs/Annotations.md

@@ -1,4 +1,4 @@
-Comparsion of various annotations available in React native mapbox:
+Comparsion of various annotations available in MapLibre React Native:
 
 |*Feature*              | *SymbolLayer*      |*PointAnnotation*                     |*MarkerView*             |*CircleLayer*        |
 |-----------------------|--------------------|--------------------------------------|-------------------------|---------------------|
@@ -8,10 +8,5 @@ Comparsion of various annotations available in React native mapbox:
 |Control Z-index        | ✓            |iOS: always on top, android: n/a      |always on top            | ✓             |
 |Clustering             | ✓            |                                      |                         | ✓             |
 |Style with expressions | ✓            |                                      |                         | ✓             |
-|iOS implementation     | [MGLStyleSymbolLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLSymbolStyleLayer.html)     |[MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html)                     |[MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html)       |[MGLCircleStyleLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLCircleStyleLayer.html)       |
-|android implementation | [SymbolLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/SymbolLayer.html)|[annotation.Symbol](https://docs.mapbox.com/android/api/plugins/annotation/0.8.0/com/mapbox/mapboxsdk/plugins/annotation/Symbol.html)|[annotation.Marker](https://docs.mapbox.com/android/api/plugins/markerview/0.4.0/com/mapbox/mapboxsdk/plugins/markerview/MarkerView.html) |[CircleLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/CircleLayer.html)|
-
-
-Related links:
-* iOS [markers and annotations](https://docs.mapbox.com/ios/maps/overview/markers-and-annotations/)
-* android [annotation plugin](https://docs.mapbox.com/android/plugins/overview/annotation/)
+|iOS implementation     | [MGLSymbolStyleLayer](https://maplibre.org/maplibre-gl-native/ios/api/Classes/MGLSymbolStyleLayer.html)     |[MGLAnnotationView](https://maplibre.org/maplibre-gl-native/ios/api/Classes/MGLAnnotationView.html)                     |[MGLAnnotationView](https://maplibre.org/maplibre-gl-native/ios/api/Classes/MGLAnnotationView.html)       |[MGLCircleStyleLayer](https://maplibre.org/maplibre-gl-native/ios/api/Classes/MGLCircleStyleLayer.html)       |
+|android implementation | [SymbolLayer](https://maplibre.org/maplibre-gl-native/android/api/com/mapbox/mapboxsdk/style/layers/SymbolLayer.html)|[annotation.Symbol](https://docs.mapbox.com/android/api/plugins/annotation/0.8.0/com/mapbox/mapboxsdk/plugins/annotation/Symbol.html)|[annotation.Marker](https://docs.mapbox.com/android/api/plugins/markerview/0.4.0/com/mapbox/mapboxsdk/plugins/markerview/MarkerView.html) |[CircleLayer](https://maplibre.org/maplibre-gl-native/android/api/com/mapbox/mapboxsdk/style/layers/CircleLayer.html)|

package/docs/BackgroundLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from BackgroundLayer.js do not modify -->
-## <MapboxGL.BackgroundLayer />
+## <MapLibreGL.BackgroundLayer />
 ### 
 
 ### 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. |
+| sourceID | `string` | `MapLibreGL.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 |

package/docs/Callout.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from Callout.js do not modify -->
-## <MapboxGL.Callout />
+## <MapLibreGL.Callout />
 ### Callout that displays information about a selected annotation near the annotation.
 
 ### props

package/docs/Camera.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from Camera.js do not modify -->
-## <MapboxGL.Camera />
+## <MapLibreGL.Camera />
 ### 
 
 ### props
@@ -49,7 +49,7 @@
 | &nbsp;&nbsp;ne | `array` | `none` | `true` | northEastCoordinates - North east coordinate of bound |
 | &nbsp;&nbsp;sw | `array` | `none` | `true` | southWestCoordinates - South west coordinate of bound |
 | followUserLocation | `bool` | `none` | `false` | Should the map orientation follow the user's. |
-| followUserMode | `enum` | `none` | `false` | The mode used to track the user location on the map. One of; "normal", "compass", "course". Each mode string is also available as a member on the `MapboxGL.UserTrackingModes` object. `Follow` (normal), `FollowWithHeading` (compass), `FollowWithCourse` (course). NOTE: `followUserLocation` must be set to `true` for any of the modes to take effect. [Example](../example/src/examples/SetUserTrackingModes.js) |
+| followUserMode | `enum` | `none` | `false` | The mode used to track the user location on the map. One of; "normal", "compass", "course". Each mode string is also available as a member on the `MapLibreGL.UserTrackingModes` object. `Follow` (normal), `FollowWithHeading` (compass), `FollowWithCourse` (course). NOTE: `followUserLocation` must be set to `true` for any of the modes to take effect. [Example](../example/src/examples/SetUserTrackingModes.js) |
 | followZoomLevel | `number` | `none` | `false` | The zoomLevel on map while followUserLocation is set to `true` |
 | followPitch | `number` | `none` | `false` | The pitch on map while followUserLocation is set to `true` |
 | followHeading | `number` | `none` | `false` | The heading on map while followUserLocation is set to `true` |

package/docs/CircleLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from CircleLayer.js do not modify -->
-## <MapboxGL.CircleLayer />
+## <MapLibreGL.CircleLayer />
 ### CircleLayer is a style layer that renders one or more filled circles 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. |
+| sourceID | `string` | `MapLibreGL.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<br/>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 |
@@ -19,18 +19,35 @@
 
 ### styles
 
-* <a href="#name">visibility</a><br/>
-* <a href="#name-1">circleRadius</a><br/>
-* <a href="#name-2">circleColor</a><br/>
-* <a href="#name-3">circleBlur</a><br/>
-* <a href="#name-4">circleOpacity</a><br/>
-* <a href="#name-5">circleTranslate</a><br/>
-* <a href="#name-6">circleTranslateAnchor</a><br/>
-* <a href="#name-7">circlePitchScale</a><br/>
-* <a href="#name-8">circlePitchAlignment</a><br/>
-* <a href="#name-9">circleStrokeWidth</a><br/>
-* <a href="#name-10">circleStrokeColor</a><br/>
-* <a href="#name-11">circleStrokeOpacity</a><br/>
+* <a href="#name">circleSortKey</a><br/>
+* <a href="#name-1">visibility</a><br/>
+* <a href="#name-2">circleRadius</a><br/>
+* <a href="#name-3">circleColor</a><br/>
+* <a href="#name-4">circleBlur</a><br/>
+* <a href="#name-5">circleOpacity</a><br/>
+* <a href="#name-6">circleTranslate</a><br/>
+* <a href="#name-7">circleTranslateAnchor</a><br/>
+* <a href="#name-8">circlePitchScale</a><br/>
+* <a href="#name-9">circlePitchAlignment</a><br/>
+* <a href="#name-10">circleStrokeWidth</a><br/>
+* <a href="#name-11">circleStrokeColor</a><br/>
+* <a href="#name-12">circleStrokeOpacity</a><br/>
+
+___
+
+#### Name
+`circleSortKey`
+
+#### Description
+Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
+
+#### Type
+`number`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
 
 ___
 

package/docs/CustomHttpHeaders.md

@@ -54,31 +54,31 @@ You can add and remove headers at runtime.
 #### To add a header
 
 ```javascript
-    MapboxGL.addCustomHeader('Authorization', '{auth header}');
+    MapLibreGL.addCustomHeader('Authorization', '{auth header}');
 ```
 
 #### To remove a header
 
 ```javascript
-    MapboxGL.removeCustomHeader('Authorization');
+    MapLibreGL.removeCustomHeader('Authorization');
 ```
 
 #### Working example
 
 ```javascript
 export default class HelloWorldApp extends Component {
-  componentDidMount() {
-    MapboxGL.addCustomHeader('Authorization', '{auth header}');
+  componentDidMount () {
+    MapLibreGL.addCustomHeader('Authorization', '{auth header}');
   }
 
-  render() {
-    MapboxGL.addCustomHeader('X-Some-Header', 'my-value');
+  render () {
+    MapLibreGL.addCustomHeader('X-Some-Header', 'my-value');
     return (
       <View style={styles.page}>
         <View style={styles.container}>
-          <MapboxGL.MapView 
-            style={styles.map} 
-            styleURL={STYLE_URL} />
+          <MapLibreGL.MapView
+            style={styles.map}
+            styleURL={STYLE_URL}/>
         </View>
       </View>
     );

package/docs/FillExtrusionLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from FillExtrusionLayer.js do not modify -->
-## <MapboxGL.FillExtrusionLayer />
+## <MapLibreGL.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. |
+| sourceID | `string` | `MapLibreGL.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 |

package/docs/FillLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from FillLayer.js do not modify -->
-## <MapboxGL.FillLayer />
+## <MapLibreGL.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. |
+| sourceID | `string` | `MapLibreGL.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 |
@@ -19,14 +19,31 @@
 
 ### 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/>
+* <a href="#name">fillSortKey</a><br/>
+* <a href="#name-1">visibility</a><br/>
+* <a href="#name-2">fillAntialias</a><br/>
+* <a href="#name-3">fillOpacity</a><br/>
+* <a href="#name-4">fillColor</a><br/>
+* <a href="#name-5">fillOutlineColor</a><br/>
+* <a href="#name-6">fillTranslate</a><br/>
+* <a href="#name-7">fillTranslateAnchor</a><br/>
+* <a href="#name-8">fillPattern</a><br/>
+
+___
+
+#### Name
+`fillSortKey`
+
+#### Description
+Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
+
+#### Type
+`number`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
 
 ___
 

package/docs/GettingStarted.md

@@ -17,16 +17,14 @@ This quickstart guide provides a zero-to-map intro, and from there you can check
 
 ## Installation
 
-### Step 0: Set up a React Native project
+### Set up a React Native project
 
 If you don't have an existing React Native project, create one:
 
 ```shell
-npx react-native init MyApp --version 0.68
+npx react-native init MyApp
 ```
 
-TODO: See if latest version works
-
 ### Install Package
 
 From your React Native project's root directory, add the package via
@@ -46,7 +44,7 @@ npm install @maplibre/maplibre-react-native --save
 ### Review platform specific info
 
 Check out the installation guide(s) for additional information about platform-specific setup, quirks,
-and steps requried before running.
+and steps required before running.
 
 - [Android](/android/install.md)
 - [iOS](/ios/install.md)
@@ -59,11 +57,11 @@ Here is an example minimal App.js
 ```js
 import React, {Component} from 'react';
 import {StyleSheet, View} from 'react-native';
-import MapboxGL from '@maplibre/maplibre-react-native';
+import MapLibreGL from '@maplibre/maplibre-react-native';
 
 // Will be null for most users (only Mapbox authenticates this way).
 // Required on Android. See Android installation notes.
-MapboxGL.setAccessToken(null);
+MapLibreGL.setAccessToken(null);
 
 const styles = StyleSheet.create({
   page: {
@@ -82,7 +80,7 @@ export default class App extends Component {
   render() {
     return (
       <View style={styles.page}>
-        <MapboxGL.MapView
+        <MapLibreGL.MapView
           style={styles.map}
           logoEnabled={false}
           styleURL="https://demotiles.maplibre.org/style.json"

package/docs/HeadingIndicator.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from HeadingIndicator.js do not modify -->
-## <MapboxGL.HeadingIndicator />
+## <MapLibreGL.HeadingIndicator />
 ### 
 
 ### props

package/docs/HeatmapLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from HeatmapLayer.js do not modify -->
-## <MapboxGL.HeatmapLayer />
+## <MapLibreGL.HeatmapLayer />
 ### HeatmapLayer is a style layer that renders one or more filled circles 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. |
+| sourceID | `string` | `MapLibreGL.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<br/>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 |

package/docs/ImageSource.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from ImageSource.js do not modify -->
-## <MapboxGL.ImageSource />
+## <MapLibreGL.ImageSource />
 ### ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.<br/>The georeferenced image scales and rotates as the user zooms and rotates the map
 
 ### props

package/docs/Images.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from Images.js do not modify -->
-## <MapboxGL.Images />
+## <MapLibreGL.Images />
 ### Images defines the images used in Symbol etc layers
 
 ### props

package/docs/Light.md

@@ -1,5 +1,5 @@
 <!-- This file was autogenerated from Light.js do not modify -->
-## <MapboxGL.Light />
+## <MapLibreGL.Light />
 ### Light represents the light source for extruded geometries
 
 ### props

package/docs/LineLayer.md

@@ -1,12 +1,12 @@
 <!-- This file was autogenerated from LineLayer.js do not modify -->
-## <MapboxGL.LineLayer />
+## <MapLibreGL.LineLayer />
 ### LineLayer is a style layer that renders one or more stroked polylines 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. |
+| sourceID | `string` | `MapLibreGL.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 |
@@ -23,18 +23,19 @@
 * <a href="#name-1">lineJoin</a><br/>
 * <a href="#name-2">lineMiterLimit</a><br/>
 * <a href="#name-3">lineRoundLimit</a><br/>
-* <a href="#name-4">visibility</a><br/>
-* <a href="#name-5">lineOpacity</a><br/>
-* <a href="#name-6">lineColor</a><br/>
-* <a href="#name-7">lineTranslate</a><br/>
-* <a href="#name-8">lineTranslateAnchor</a><br/>
-* <a href="#name-9">lineWidth</a><br/>
-* <a href="#name-10">lineGapWidth</a><br/>
-* <a href="#name-11">lineOffset</a><br/>
-* <a href="#name-12">lineBlur</a><br/>
-* <a href="#name-13">lineDasharray</a><br/>
-* <a href="#name-14">linePattern</a><br/>
-* <a href="#name-15">lineGradient</a><br/>
+* <a href="#name-4">lineSortKey</a><br/>
+* <a href="#name-5">visibility</a><br/>
+* <a href="#name-6">lineOpacity</a><br/>
+* <a href="#name-7">lineColor</a><br/>
+* <a href="#name-8">lineTranslate</a><br/>
+* <a href="#name-9">lineTranslateAnchor</a><br/>
+* <a href="#name-10">lineWidth</a><br/>
+* <a href="#name-11">lineGapWidth</a><br/>
+* <a href="#name-12">lineOffset</a><br/>
+* <a href="#name-13">lineBlur</a><br/>
+* <a href="#name-14">lineDasharray</a><br/>
+* <a href="#name-15">linePattern</a><br/>
+* <a href="#name-16">lineGradient</a><br/>
 
 ___
 
@@ -122,6 +123,22 @@ Parameters: `zoom`
 
 ___
 
+#### Name
+`lineSortKey`
+
+#### Description
+Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
+
+#### Type
+`number`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
+
+___
+
 #### Name
 `visibility`
 

package/docs/{MapboxGL.md → MapLibreGL.md}

@@ -1,4 +1,4 @@
-## MapboxGL
+## MapLibreGL
 ###
 
 ### methods
@@ -7,7 +7,7 @@
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `accessToken` | `String` | `Yes` | required acessToken to pull mapbox tiles, can be `null` if other tiles are used |
+| `accessToken` | `String` | `Yes` | access token to pull Mapbox-hosted tiles; can be `null` for other tile hosts |
 
 ##### Description
 sets the accessToken, which is required when you want to use mapbox tiles
@@ -18,7 +18,7 @@ not required when using other tiles
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `accessToken` | `String` | `Yes` | required acessToken to pull mapbox tiles, can be `null` if other tiles are used |
+| `accessToken` | `String` | `Yes` | access token to pull Mapbox-hosted tiles; can be `null` if for other tile hosts |
 
 ##### Description
 gets the accessToken
@@ -59,7 +59,7 @@ Either permission was granted or denied.
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `connected` | `Boolean` | `Yes` | whether or not mapbox is told to be connected or not |
+| `connected` | `Boolean` | `Yes` | whether or not the SDK should assume it is online |
 
 #### Description
-If you want to fully block online map - maybe to force offline maps
+If you want to fully block map tile requests over the network, such as for a low-data / offline application.