@maplibre/maplibre-react-native 10.0.0-alpha.26 → 10.0.0-alpha.28

package/docs/GettingStarted.md

@@ -1,113 +0,0 @@
-# Getting Started
-
-This quickstart guide provides a zero-to-map intro using React Native. From there you can check out the
-[examples](/packages/examples) folder if you want to jump in the deep end.
-
-## Prerequisites
-
-1. On Android we support API 23 and higher
-2. You will need a vector tile source (such as Stadia Maps or MapTiler) for production use; a demonstration URL is used in the below example.
-
-## Dependencies
-
-- [node](https://nodejs.org)
-- [npm](https://www.npmjs.com/)
-- [React Native](https://facebook.github.io/react-native/) (0.60+)
-
-## Installation
-
-### Set up a React Native project
-
-If you don't have an existing React Native project, create one:
-
-```shell
-npx react-native init MyApp
-```
-
-### Install Package
-
-From your React Native project's root directory, add the package via
-either `yarn` or `npm` (pick one).
-
-```shell
-# install with Yarn
-yarn add @maplibre/maplibre-react-native
-
-```
-
-```shell
-# install with NPM
-npm install @maplibre/maplibre-react-native --save
-```
-
-### Review platform specific Details
-
-Check out the installation guide(s) for additional information about platform-specific setup, quirks,
-and steps required before running.
-
-- [Android](/android/install.md)
-- [iOS](/ios/install.md)
-- [Expo](/plugin/install.md)
-
-## Adding a map
-
-Here is an example minimal App.js
-
-```js
-import React, {Component} from 'react';
-import {StyleSheet, View} from '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.
-MapLibreGL.setAccessToken(null);
-
-const styles = StyleSheet.create({
-  page: {
-    flex: 1,
-    justifyContent: 'center',
-    alignItems: 'center',
-    backgroundColor: '#F5FCFF',
-  },
-  map: {
-    flex: 1,
-    alignSelf: 'stretch',
-  },
-});
-
-export default class App extends Component {
-  render() {
-    return (
-      <View style={styles.page}>
-        <MapLibreGL.MapView
-          style={styles.map}
-          logoEnabled={false}
-          styleURL="https://demotiles.maplibre.org/style.json"
-        />
-      </View>
-    );
-  }
-}
-```
-
-## Run it!
-
-### iOS
-
-```shell
-# Run with yarn
-yarn run ios
-
-# or Run with NPM
-npm run ios
-```
-
-### Android
-
-```shell
-# Run with yarn
-yarn run android
-
-# or Run with NPM
-npm run android
-```

package/docs/HeadingIndicator.md

@@ -1,11 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/HeadingIndicator.tsx -->
-# `<MapLibreGL.HeadingIndicator />`
-
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| heading | `number` | `none` | `false` | FIX ME NO DESCRIPTION |
-
-

package/docs/HeatmapLayer.md

@@ -1,214 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/HeatmapLayer.tsx -->
-# `<MapLibreGL.HeatmapLayer />`
-HeatmapLayer is a style layer that renders one or more filled circles on the map.
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| style | `HeatmapLayerStyleProps` | `none` | `false` | Customizable style attributes |
-| sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
-
-
-## Styles
-
-* <a href="#name">`visibility`</a><br/>
-* <a href="#name-1">`heatmapRadius`</a><br/>
-* <a href="#name-2">`heatmapWeight`</a><br/>
-* <a href="#name-3">`heatmapIntensity`</a><br/>
-* <a href="#name-4">`heatmapColor`</a><br/>
-* <a href="#name-5">`heatmapOpacity`</a><br/>
-
-
-### `visibility`
-
-Whether this layer is displayed.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>enum</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>visible</code></dd>
-    <dt>Supported Values</dt>
-    <dd>
-        <ul>
-                <li>
-                    <code>visible</code>: The layer is shown.
-                </li>
-                <li>
-                    <code>none</code>: The layer is not shown.
-                </li>
-        </ul>
-    </dd>
-</dl>
-
-
-
-### `heatmapRadius`
-
-Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>30</code></dd>
-        </ul>
-    </dd>
-        <dt>Units</dt>
-        <dd><code>pixels</code></dd>
-        <dt>Minimum</dt>
-        <dd><code>1</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom, feature, feature-state</code></dd>
-</dl>
-
-### `heatmapRadiusTransition`
-
-The transition affecting any changes to this layer’s heatmapRadius property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `heatmapWeight`
-
-A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>1</code></dd>
-        </ul>
-    </dd>
-        <dt>Minimum</dt>
-        <dd><code>0</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom, feature, feature-state</code></dd>
-</dl>
-
-
-
-### `heatmapIntensity`
-
-Similar to `heatmapWeight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>1</code></dd>
-        </ul>
-    </dd>
-        <dt>Minimum</dt>
-        <dd><code>0</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `heatmapIntensityTransition`
-
-The transition affecting any changes to this layer’s heatmapIntensity property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `heatmapColor`
-
-Defines the color of each pixel based on its density value in a heatmap.  Should be an expression that uses `["heatmapDensity"]` as input.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>color</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red</code></dd>
-        </ul>
-    </dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>heatmap-density</code></dd>
-</dl>
-
-
-
-### `heatmapOpacity`
-
-The global opacity at which the heatmap layer will be drawn.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>1</code></dd>
-        </ul>
-    </dd>
-        <dt>Minimum</dt>
-        <dd><code>0</code></dd>
-        <dt>Maximum</dt>
-        <dd><code>1</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `heatmapOpacityTransition`
-
-The transition affecting any changes to this layer’s heatmapOpacity property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-

package/docs/ImageSource.md

@@ -1,14 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/ImageSource.tsx -->
-# `<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
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| id | `string` | `none` | `true` | A string that uniquely identifies the source. |
-| url | `number \| string` | `none` | `false` | An HTTP(S) URL, absolute file URL, or local file URL to the source image.<br/>Gifs are currently not supported. |
-| coordinates | `tuple` | `none` | `false` | The top left, top right, bottom right, and bottom left coordinates for the image. |
-| children | `ReactElement \| ReactElement[]` | `none` | `false` | FIX ME NO DESCRIPTION |
-
-

package/docs/Images.md

@@ -1,15 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/Images.tsx -->
-# `<MapLibreGL.Images />`
-Images defines the images used in Symbol etc layers
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| images | `shape` | `none` | `false` | Specifies the external images in key-value pairs required for the shape source.<br/>Keys are names - see iconImage expressions, values can be either urls-s objects<br/>with format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'` |
-| &nbsp;&nbsp;[object Object] | `union` | `none` | `true` | FIX ME NO DESCRIPTION |
-| nativeAssetImages | `Array` | `none` | `false` | If you have an asset under Image.xcassets on iOS and the drawables directory on android<br/>you can specify an array of string names with assets as the key `['pin']`. |
-| id | `string` | `none` | `false` | FIX ME NO DESCRIPTION |
-| children | `ReactElement` | `none` | `true` | FIX ME NO DESCRIPTION |
-
-

package/docs/Light.md

@@ -1,167 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/Light.tsx -->
-# `<MapLibreGL.Light />`
-Light represents the light source for extruded geometries
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| style | `LightLayerStyleProps` | `none` | `false` | Customizable style attributes |
-
-
-## Styles
-
-* <a href="#name">`anchor`</a><br/>
-* <a href="#name-1">`position`</a><br/>
-* <a href="#name-2">`color`</a><br/>
-* <a href="#name-3">`intensity`</a><br/>
-
-
-### `anchor`
-
-Whether extruded geometries are lit relative to the map or viewport.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>enum</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>viewport</code></dd>
-    <dt>Supported Values</dt>
-    <dd>
-        <ul>
-                <li>
-                    <code>map</code>: The position of the light source is aligned to the rotation of the map.
-                </li>
-                <li>
-                    <code>viewport</code>: The position of the light source is aligned to the rotation of the viewport.
-                </li>
-        </ul>
-    </dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-
-
-### `position`
-
-Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>array<number></code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>[1.15,210,30]</code></dd>
-        </ul>
-    </dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `positionTransition`
-
-The transition affecting any changes to this layer’s position property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `color`
-
-Color tint for lighting extruded geometries.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>color</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>#ffffff</code></dd>
-        </ul>
-    </dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `colorTransition`
-
-The transition affecting any changes to this layer’s color property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `intensity`
-
-Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>0.5</code></dd>
-        </ul>
-    </dd>
-        <dt>Minimum</dt>
-        <dd><code>0</code></dd>
-        <dt>Maximum</dt>
-        <dd><code>1</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `intensityTransition`
-
-The transition affecting any changes to this layer’s intensity property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-