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

package/docs/Light.md

@@ -1,160 +1,167 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/Light.tsx -->
-## <MapLibreGL.Light />
-### Light represents the light source for extruded geometries
+# `<MapLibreGL.Light />`
+Light represents the light source for extruded geometries
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | style | `LightLayerStyleProps` | `none` | `false` | Customizable style attributes |
 
 
-### styles
+## 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/>
+* <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/>
 
-___
 
-#### Name
-`anchor`
+### `anchor`
 
-#### Description
 Whether extruded geometries are lit relative to the map or viewport.
 
-#### Type
-`enum`
-#### Default Value
-`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`
 
-#### Supported Values
-**map** - The position of the light source is aligned to the rotation of the map.<br />
-**viewport** - The position of the light source is aligned to the rotation of the viewport.<br />
-
-
-#### Expression
-
-Parameters: `zoom`
-
-___
-
-#### Name
-`position`
-
-#### Description
 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).
 
-#### Type
-`array<number>`
-#### Default Value
-`[1.15,210,30]`
-
-
-#### Expression
-
-Parameters: `zoom`
-___
+<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>
 
-#### Name
+### `positionTransition`
 
-`positionTransition`
+The transition affecting any changes to this layer’s position property.
 
-#### Description
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
 
-The transition affecting any changes to this layer’s position propery.
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
 
-#### Type
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 
-`{ duration, delay }`
 
-#### Units
-`milliseconds`
+### `color`
 
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`color`
-
-#### Description
 Color tint for lighting extruded geometries.
 
-#### Type
-`color`
-#### Default Value
-`#ffffff`
-
-
-#### Expression
-
-Parameters: `zoom`
-___
-
-#### Name
+<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`
+### `colorTransition`
 
-#### Description
+The transition affecting any changes to this layer’s color property.
 
-The transition affecting any changes to this layer’s color propery.
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
 
-#### Type
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
 
-`{ duration, delay }`
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 
-#### Units
-`milliseconds`
 
-#### Default Value
-`{duration: 300, delay: 0}`
+### `intensity`
 
-
-___
-
-#### Name
-`intensity`
-
-#### Description
 Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
 
-#### Type
-`number`
-#### Default Value
-`0.5`
-
-#### Minimum
-`0`
-
-
-#### Maximum
-`1`
-
-#### Expression
-
-Parameters: `zoom`
-___
-
-#### Name
-
-`intensityTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s intensity propery.
-
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
+<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>