@maplibre/maplibre-react-native 10.0.0-alpha.2 → 10.0.0-alpha.21

package/docs/MarkerView.md

@@ -6,7 +6,7 @@
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the marker.<br/>See also #anchor. |
-| anchor | `shape` | `{x: 0.5, y: 0.5}` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
+| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
 | &nbsp;&nbsp;x | `number` | `none` | `true` | `x` of anchor |
 | &nbsp;&nbsp;y | `number` | `none` | `true` | `y` of anchor |
 | allowOverlap | `boolean` | `false` | `false` | FIX ME NO DESCRIPTION |

package/docs/NativeUserLocation.md

@@ -5,7 +5,8 @@
 ### props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
-| androidRenderMode | `'normal' \| 'compass' \| 'gps'` | `none` | `false` | Android render mode.<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
+| androidRenderMode | `"normal" \| "compass" \| "gps"` | `none` | `false` | Android render mode.<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
 | iosShowsUserHeadingIndicator | `boolean` | `none` | `false` | iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.<br/><br/>@platform ios |
+| androidPreferredFramesPerSecond | `number` | `none` | `false` | Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX. |
 
 

package/docs/PointAnnotation.md

@@ -11,11 +11,11 @@
 | selected | `boolean` | `none` | `false` | Manually selects/deselects annotation<br/>@type {[type]} |
 | draggable | `boolean` | `false` | `false` | Enable or disable dragging. Defaults to false. |
 | coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the annotation. |
-| anchor | `shape` | `{x: 0.5, y: 0.5}` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
+| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
 | &nbsp;&nbsp;x | `number` | `none` | `true` | See anchor |
 | &nbsp;&nbsp;y | `number` | `none` | `true` | See anchor |
 | children | `React.ReactElement \| [React.ReactElement, React.ReactElement]` | `none` | `true` | Expects one child, and an optional callout can be added as well |
-| style | `ViewProps['style']` | `none` | `false` | FIX ME NO DESCRIPTION |
+| style | `ViewProps["style"]` | `none` | `false` | FIX ME NO DESCRIPTION |
 
 ### methods
 #### refresh()

package/docs/RasterLayer.md

@@ -329,7 +329,7 @@ ___
 `rasterFadeDuration`
 
 #### Description
-Fade duration when a new tile is added.
+Fade duration when a new tile is added, or when a video is started or its coordinates are updated.
 
 #### Type
 `number`

package/docs/SymbolLayer.md

@@ -389,12 +389,12 @@ ___
 `iconPadding`
 
 #### Description
-Size of additional area round the icon bounding box used for detecting symbol collisions. Values are declared using CSS margin shorthand syntax: a single value applies to all four sides; two values apply to [top/bottom, left/right]; three values apply to [top, left/right, bottom]; four values apply to [top, right, bottom, left]. For backwards compatibility, a single bare number is accepted, and treated the same as a oneElement array  padding applied to all sides.
+Size of additional area round the icon bounding box used for detecting symbol collisions.
 
 #### Type
-`number`
+`array<number>`
 #### Default Value
-`2`
+`[2]`
 
 #### Units
 `pixels`
@@ -1122,7 +1122,7 @@ ___
 `iconColor`
 
 #### Description
-The color of the icon. This can only be used with sdf icons.
+The color of the icon. This can only be used with SDF icons.
 
 #### Type
 `color`
@@ -1204,7 +1204,9 @@ ___
 `iconHaloWidth`
 
 #### Description
-Distance of halo to the icon outline.
+Distance of halo to the icon outline. 
+
+The unit is in pixels only for SDF sprites that were created with a blur radius of 8, multiplied by the display density. I.e., the radius needs to be 16 for `@2x` sprites, etc.
 
 #### Type
 `number`

package/docs/UserLocation.md

@@ -6,22 +6,31 @@
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | animated | `boolean` | `true` | `false` | Whether location icon is animated between updates |
-| renderMode | `'normal' \| 'native'` | `'normal'` | `false` | Which render mode to use.<br/>Can either be `normal` or `native` |
-| androidRenderMode | `'normal' \| 'compass' \| 'gps'` | `none` | `false` | native/android only render mode<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
+| renderMode | `"normal" \| "native"` | `"normal"` | `false` | Which render mode to use.<br/>Can either be `normal` or `native` |
+| androidRenderMode | `"normal" \| "compass" \| "gps"` | `none` | `false` | native/android only render mode<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
 | visible | `boolean` | `true` | `false` | Whether location icon is visible |
 | showsUserHeadingIndicator | `boolean` | `false` | `false` | Show or hide small arrow which indicates direction the device is pointing relative to north. |
 | minDisplacement | `number` | `0` | `false` | Minimum amount of movement before GPS location is updated in meters |
+| androidPreferredFramesPerSecond | `number` | `none` | `false` | Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX.<br/><br/>@platform android |
 | children | `ReactElement \| ReactElement[]` | `none` | `false` | Custom location icon of type mapbox-gl-native components<br/><br/>NOTE: Forking maintainer does not understand the above comment. |
 
 ### methods
-#### setLocationManager({running}: {running: boolean})
+#### setLocationManager({
+  running,
+}: {
+  running: boolean;
+})
 
 Whether to start or stop listening to the locationManager<br/><br/>Notice, that listening will start automatically when<br/>either `onUpdate` or `visible` are set
 
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `{running}: {running: boolean}` | `{running:boolean}` | `Yes` | undefined |
+| `{
+  running,
+}: {
+  running: boolean;
+}` | `{running:boolean;}` | `Yes` | undefined |
 
 
 #### needsLocationManagerRunning()

package/docs/docs.json

@@ -25,24 +25,9 @@
       {
         "name": "symbolStyle",
         "docblock": null,
-        "modifiers": [
-          "get"
-        ],
+        "modifiers": [],
         "params": [],
-        "returns": {
-          "type": {
-            "name": "union",
-            "raw": "SymbolLayerStyleProps | undefined",
-            "elements": [
-              {
-                "name": "SymbolLayerStyleProps"
-              },
-              {
-                "name": "undefined"
-              }
-            ]
-          }
-        }
+        "returns": null
       }
     ],
     "props": [
@@ -232,7 +217,7 @@
         "required": false,
         "type": "ViewStyle",
         "default": "none",
-        "description": "Style property for the native RCTMGLCallout container, set at your own risk."
+        "description": "Style property for the native RCTMLNCallout container, set at your own risk."
       },
       {
         "name": "contentStyle",
@@ -268,14 +253,14 @@
     "methods": [
       {
         "name": "fitBounds",
-        "docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} northEastCoordinates - North east coordinate of bound\n@param {Array<Number>} southWestCoordinates - South west coordinate of bound\n@param {Number=} padding - Camera padding for bound\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
+        "docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} northEastCoordinates - North east coordinate of bound\n@param {Array<Number>} southWestCoordinates - South west coordinate of bound\n@param {Number|Array<Number>|undefined} padding - Padding for the bounds\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
         "modifiers": [],
         "params": [
           {
             "name": "northEastCoordinates",
             "description": "North east coordinate of bound",
             "type": {
-              "name": "Array"
+              "name": "GeoJSON.Position"
             },
             "optional": false
           },
@@ -283,15 +268,15 @@
             "name": "southWestCoordinates",
             "description": "South west coordinate of bound",
             "type": {
-              "name": "Array"
+              "name": "GeoJSON.Position"
             },
             "optional": false
           },
           {
             "name": "padding",
-            "description": "Camera padding for bound",
+            "description": "Padding for the bounds",
             "type": {
-              "name": "Number"
+              "name": "Number \\| Array"
             },
             "optional": true
           },
@@ -492,8 +477,8 @@
       {
         "name": "animationMode",
         "required": false,
-        "type": "'flyTo' \\| 'easeTo' \\| 'linearTo' \\| 'moveTo'",
-        "default": "'easeTo'",
+        "type": "\"flyTo\" \\| \"easeTo\" \\| \"linearTo\" \\| \"moveTo\"",
+        "default": "\"easeTo\"",
         "description": "The easing or path the camera uses to animate to a new configuration."
       },
       {
@@ -1087,6 +1072,23 @@
           ]
         },
         "transition": true
+      },
+      {
+        "name": "fillExtrusionVerticalGradient",
+        "type": "boolean",
+        "values": [],
+        "default": true,
+        "description": "Whether to apply a vertical gradient to the sides of a fillExtrusion layer. If true, sides will be shaded slightly darker farther down.",
+        "requires": [],
+        "disabledBy": [],
+        "allowedFunctionTypes": [],
+        "expression": {
+          "interpolated": false,
+          "parameters": [
+            "zoom"
+          ]
+        },
+        "transition": false
       }
     ]
   },
@@ -1586,7 +1588,8 @@
       }
     ],
     "composes": [
-      "BaseProps"
+      "BaseProps",
+      "BaseLayerProps"
     ],
     "fileNameWithExt": "Light.tsx",
     "name": "Light",
@@ -2147,10 +2150,19 @@
             "name": "Promise",
             "elements": [
               {
-                "name": "Bounds"
+                "name": "tuple",
+                "raw": "[northEast: GeoJSON.Position, southWest: GeoJSON.Position]",
+                "elements": [
+                  {
+                    "name": "unknown"
+                  },
+                  {
+                    "name": "unknown"
+                  }
+                ]
               }
             ],
-            "raw": "Promise<Bounds>"
+            "raw": "Promise<VisibleBounds>"
           }
         },
         "description": "The coordinate bounds(ne, sw) visible in the users’s viewport.",
@@ -2166,12 +2178,11 @@
         ],
         "params": [
           {
-            "name": "coordinate",
-            "description": "A point expressed in the map view’s coordinate system.",
+            "name": "point",
+            "optional": false,
             "type": {
-              "name": "GeoJSON.Position"
-            },
-            "optional": false
+              "name": "tuple"
+            }
           },
           {
             "name": "filter",
@@ -2421,7 +2432,7 @@
       {
         "name": "style",
         "required": false,
-        "type": "ViewProps['style']",
+        "type": "ViewProps[\"style\"]",
         "default": "none",
         "description": "Style for wrapping React Native View"
       },
@@ -2444,7 +2455,7 @@
         "required": false,
         "type": "number",
         "default": "none",
-        "description": "iOS: The preferred frame rate at which the map view is rendered.\nThe default value for this property is MGLMapViewPreferredFramesPerSecondDefault,\nwhich will adaptively set the preferred frame rate based on the capability of\nthe user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.\n\nAndroid: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.\nThis property can be set to arbitrary integer values."
+        "description": "iOS: The preferred frame rate at which the map view is rendered.\nThe default value for this property is MLNMapViewPreferredFramesPerSecondDefault,\nwhich will adaptively set the preferred frame rate based on the capability of\nthe user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.\n\nAndroid: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.\nThis property can be set to arbitrary integer values."
       },
       {
         "name": "localizeLabels",
@@ -2491,7 +2502,7 @@
       {
         "name": "attributionPosition",
         "required": false,
-        "type": "\\| {\n    top?: number;\n    left?: number;\n  }\n\\| {\n    top?: number;\n    right?: number;\n  }\n\\| {\n    bottom?: number;\n    left?: number;\n  }\n\\| {\n    bottom?: number;\n    right?: number;\n  }",
+        "type": "\\| { top?: number; left?: number }\n\\| { top?: number; right?: number }\n\\| { bottom?: number; left?: number }\n\\| { bottom?: number; right?: number }",
         "default": "none",
         "description": "Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map"
       },
@@ -2512,7 +2523,7 @@
       {
         "name": "logoPosition",
         "required": false,
-        "type": "\\| {\n    top?: number;\n    left?: number;\n  }\n\\| {\n    top?: number;\n    right?: number;\n  }\n\\| {\n    bottom?: number;\n    left?: number;\n  }\n\\| {\n    bottom?: number;\n    right?: number;\n  }",
+        "type": "\\| { top?: number; left?: number }\n\\| { top?: number; right?: number }\n\\| { bottom?: number; left?: number }\n\\| { bottom?: number; right?: number }",
         "default": "none",
         "description": "Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map"
       },
@@ -2616,7 +2627,7 @@
             }
           ]
         },
-        "default": "{x: 0.5, y: 0.5}",
+        "default": "{ x: 0.5, y: 0.5 }",
         "description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
       },
       {
@@ -2655,7 +2666,7 @@
       {
         "name": "androidRenderMode",
         "required": false,
-        "type": "'normal' \\| 'compass' \\| 'gps'",
+        "type": "\"normal\" \\| \"compass\" \\| \"gps\"",
         "default": "none",
         "description": "Android render mode.\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
       },
@@ -2665,6 +2676,13 @@
         "type": "boolean",
         "default": "none",
         "description": "iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.\n\n@platform ios"
+      },
+      {
+        "name": "androidPreferredFramesPerSecond",
+        "required": false,
+        "type": "number",
+        "default": "none",
+        "description": "Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX."
       }
     ],
     "fileNameWithExt": "NativeUserLocation.tsx",
@@ -2753,7 +2771,7 @@
             }
           ]
         },
-        "default": "{x: 0.5, y: 0.5}",
+        "default": "{ x: 0.5, y: 0.5 }",
         "description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
       },
       {
@@ -2766,7 +2784,7 @@
       {
         "name": "style",
         "required": false,
-        "type": "ViewProps['style']",
+        "type": "ViewProps[\"style\"]",
         "default": "none",
         "description": "FIX ME NO DESCRIPTION"
       }
@@ -2965,7 +2983,7 @@
         "minimum": 0,
         "units": "milliseconds",
         "default": 300,
-        "description": "Fade duration when a new tile is added.",
+        "description": "Fade duration when a new tile is added, or when a video is started or its coordinates are updated.",
         "requires": [],
         "disabledBy": [],
         "allowedFunctionTypes": [],
@@ -3732,11 +3750,13 @@
       },
       {
         "name": "iconPadding",
-        "type": "number",
+        "type": "array<number>",
         "values": [],
         "units": "pixels",
-        "default": 2,
-        "description": "Size of additional area round the icon bounding box used for detecting symbol collisions. Values are declared using CSS margin shorthand syntax: a single value applies to all four sides; two values apply to [top/bottom, left/right]; three values apply to [top, left/right, bottom]; four values apply to [top, right, bottom, left]. For backwards compatibility, a single bare number is accepted, and treated the same as a oneElement array  padding applied to all sides.",
+        "default": [
+          2
+        ],
+        "description": "Size of additional area round the icon bounding box used for detecting symbol collisions.",
         "requires": [
           "iconImage"
         ],
@@ -4459,7 +4479,7 @@
         "type": "color",
         "values": [],
         "default": "#000000",
-        "description": "The color of the icon. This can only be used with sdf icons.",
+        "description": "The color of the icon. This can only be used with SDF icons.",
         "requires": [
           "iconImage"
         ],
@@ -4503,7 +4523,7 @@
         "minimum": 0,
         "units": "pixels",
         "default": 0,
-        "description": "Distance of halo to the icon outline.",
+        "description": "Distance of halo to the icon outline. \n\nThe unit is in pixels only for SDF sprites that were created with a blur radius of 8, multiplied by the display density. I.e., the radius needs to be 16 for `@2x` sprites, etc.",
         "requires": [
           "iconImage"
         ],
@@ -4769,10 +4789,10 @@
         ],
         "params": [
           {
-            "name": "{running}: {running: boolean}",
+            "name": "{\n  running,\n}: {\n  running: boolean;\n}",
             "optional": false,
             "type": {
-              "name": "{running:boolean}"
+              "name": "{running:boolean;}"
             }
           }
         ],
@@ -4817,14 +4837,14 @@
       {
         "name": "renderMode",
         "required": false,
-        "type": "'normal' \\| 'native'",
-        "default": "'normal'",
+        "type": "\"normal\" \\| \"native\"",
+        "default": "\"normal\"",
         "description": "Which render mode to use.\nCan either be `normal` or `native`"
       },
       {
         "name": "androidRenderMode",
         "required": false,
-        "type": "'normal' \\| 'compass' \\| 'gps'",
+        "type": "\"normal\" \\| \"compass\" \\| \"gps\"",
         "default": "none",
         "description": "native/android only render mode\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
       },
@@ -4849,6 +4869,13 @@
         "default": "0",
         "description": "Minimum amount of movement before GPS location is updated in meters"
       },
+      {
+        "name": "androidPreferredFramesPerSecond",
+        "required": false,
+        "type": "number",
+        "default": "none",
+        "description": "Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX.\n\n@platform android"
+      },
       {
         "name": "children",
         "required": false,