@maplibre/maplibre-react-native 11.0.0-beta.24 → 11.0.0-beta.26

package/src/components/map/Map.tsx

@@ -79,88 +79,90 @@ export interface MapRef {
   /**
    * Returns the current center coordinates of the map
    *
+   * @returns Current center coordinates of the map
+   *
    * @example
    * await mapRef.current?.getCenter();
-   *
-   * @return Current center coordinates of the map
    */
   getCenter(): Promise<LngLat>;
 
   /**
    * Returns the current zoom level of the map
    *
+   * @returns Current zoom level of the map
+   *
    * @example
    * await mapRef.current?.getZoom();
-   *
-   * @return Current zoom level of the map
    */
   getZoom(): Promise<number>;
 
   /**
    * Returns the current bearing of the map
    *
+   * @returns Current bearing of the map
+   *
    * @example
    * await mapRef.current?.getBearing();
-   *
-   * @return Current bearing of the map
    */
   getBearing(): Promise<number>;
 
   /**
    * Returns the current pitch of the map
    *
+   * @returns Current pitch of the map
+   *
    * @example
    * await mapRef.current?.getPitch();
-   *
-   * @return Current pitch of the map
    */
   getPitch(): Promise<number>;
 
   /**
    * Returns the current bounds of the map
    *
+   * @returns Current bounds of the map
+   *
    * @example
    * await mapRef.current?.getBounds();
-   *
-   * @return Current bounds of the map
    */
   getBounds(): Promise<LngLatBounds>;
 
   /**
    * Returns the current view state of the map
    *
+   * @returns Current view state of the map
+   *
    * @example
    * await mapRef.current?.getViewState();
-   *
-   * @return Current view state of the map
    */
   getViewState(): Promise<ViewState>;
 
   /**
    * Converts geographic coordinates to pixel point of the view
    *
+   * @param lngLat - Geographic coordinate
+   * @returns Pixel point
+   *
    * @example
    * await mapRef.current?.project([13.04214014753952, 47.80554907882145]);
-   *
-   * @param lngLat Geographic coordinate
-   * @return Pixel point
    */
   project(lngLat: LngLat): Promise<PixelPoint>;
 
   /**
    * Converts a pixel point of the view to geographic coordinates.
    *
+   * @param point - Pixel point
+   * @returns Geographic coordinate
+   *
    * @example
    * await mapRef.current?.unproject([280, 640]);
-   *
-   * @param point Pixel point
-   * @return Geographic coordinate
    */
   unproject(point: PixelPoint): Promise<LngLat>;
 
   /**
    * Query rendered features at a point
    *
+   * @returns Queried features
+   *
    * @example
    * await mapRef.current?.queryRenderedFeatures(
    *   [240, 640],
@@ -169,8 +171,6 @@ export interface MapRef {
    *     layers: ["restaurants", "shops"],
    *   },
    * );
-   *
-   * @return Queried features
    */
   queryRenderedFeatures(
     pixelPoint: PixelPoint,
@@ -180,6 +180,8 @@ export interface MapRef {
   /**
    * Query rendered features within pixel bounds
    *
+   * @returns Queried features
+   *
    * @example
    * await mapRef.current?.queryRenderedFeatures(
    *   [100, 100, 400, 400],
@@ -188,8 +190,6 @@ export interface MapRef {
    *     layers: ["restaurants", "shops"],
    *   },
    * );
-   *
-   * @return Queried features
    */
   queryRenderedFeatures(
     pixelPointBounds: PixelPointBounds,
@@ -199,6 +199,8 @@ export interface MapRef {
   /**
    * Query rendered features within the current viewport
    *
+   * @returns Queried features
+   *
    * @example
    * await mapRef.current?.queryRenderedFeatures(
    *   {
@@ -206,8 +208,6 @@ export interface MapRef {
    *     layers: ["restaurants", "shops"],
    *   },
    * );
-   *
-   * @return Queried features
    */
   queryRenderedFeatures(
     options?: QueryRenderedFeaturesOptions,
@@ -216,21 +216,20 @@ export interface MapRef {
   /**
    * Takes static-map image of the currently displayed map
    *
-   * @param options.output Use "base64" to get a Base64 encoded string, or "file" to get a URI to an image file saved on disk
-   *
-   * @return Base64 encoded image or URI of image file
+   * @returns Base64 encoded image or URI of image file
    */
   createStaticMapImage(options: { output: "base64" | "file" }): Promise<string>;
 
   /**
-   * Sets the visibility of all the layers referencing the specified `source` and optionally `sourceLayer`
-   *
-   * @example
-   * await mapRef.current?.setSourceVisibility(false, 'composite', 'building')
+   * Sets the visibility of all the layers referencing the specified `source` and
+   * optionally `sourceLayer`
    *
    * @param visible - Visibility of the layers
    * @param source - Identifier of the target source (e.g. 'composite')
    * @param sourceLayer - Identifier of the target source-layer (e.g. 'building')
+   *
+   * @example
+   * await mapRef.current?.setSourceVisibility(false, 'composite', 'building')
    */
   setSourceVisibility(
     visible: boolean,
@@ -250,14 +249,14 @@ export interface MapProps extends ViewProps {
   /**
    * Style for wrapping React Native View
    *
-   * @default { flex: 1 }
+   * @defaultValue { flex: 1 }
    */
   style?: ViewProps["style"];
 
   /**
    * Maplibre style - either a URL or a Style JSON.
    *
-   * @see https://maplibre.org/maplibre-style-spec/
+   * @see {@link https://maplibre.org/maplibre-style-spec/}
    */
   mapStyle: string | StyleSpecification;
 
@@ -271,25 +270,28 @@ export interface MapProps extends ViewProps {
   light?: LightSpecification;
 
   /**
-   * The distance from the edges of the map view's frame to the edges of the map view's logical viewport.
+   * The distance from the edges of the map view's frame to the edges of the map
+   * view's logical viewport.
    */
   contentInset?: ViewPadding;
 
   /**
-   * iOS: The preferred frame rate at which the map view is rendered.
-   * The default value for this property is MLNMapViewPreferredFramesPerSecondDefault,
-   * which will adaptively set the preferred frame rate based on the capability of
-   * the user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.
+   * iOS: The preferred frame rate at which the map view is rendered. The default
+   * value for this property is MLNMapViewPreferredFramesPerSecondDefault, which
+   * will adaptively set the preferred frame rate based on the capability of the
+   * user’s device to maintain a smooth experience. This property can be set to
+   * arbitrary integer values.
    *
-   * Android: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.
-   * This property can be set to arbitrary integer values.
+   * Android: The maximum frame rate at which the map view is rendered, but it
+   * can't excess the ability of device hardware. This property can be set to
+   * arbitrary integer values.
    */
   preferredFramesPerSecond?: number;
 
   /**
    * Toggle pan interaction of the map
    *
-   * @default true
+   * @defaultValue true
    */
   dragPan?: boolean;
 
@@ -298,35 +300,36 @@ export interface MapProps extends ViewProps {
    *
    * On Android this also disables {@link doubleTapZoom} and {@link doubleTapHoldZoom}.
    *
-   * @default true
+   * @defaultValue true
    */
   touchZoom?: boolean;
 
   /**
    * Toggle double-tap zoom interaction of the map.
    *
-   * @default true
+   * @defaultValue true
    */
   doubleTapZoom?: boolean;
 
   /**
-   * Toggle double-tap-and-hold zoom interaction of the map (also known as quick zoom and one finger zoom).
+   * Toggle double-tap-and-hold zoom interaction of the map (also known as quick
+   * zoom and one finger zoom).
    *
-   * @default true
+   * @defaultValue true
    */
   doubleTapHoldZoom?: boolean;
 
   /**
    * Toggle rotate interaction of the map
    *
-   * @default true
+   * @defaultValue true
    */
   touchRotate?: boolean;
 
   /**
    * Toggle pitch interaction of the map
    *
-   * @default true
+   * @defaultValue true
    */
   touchPitch?: boolean;
 
@@ -377,7 +380,7 @@ export interface MapProps extends ViewProps {
   /**
    * Toggle the compass from hiding when facing north
    *
-   * @default true
+   * @defaultValue true
    */
   compassHiddenFacingNorth?: boolean;
 
@@ -398,7 +401,7 @@ export interface MapProps extends ViewProps {
    * Android only: Switch between TextureView (default) and GLSurfaceView for
    * rendering the map
    *
-   * @default "surface"
+   * @defaultValue "surface"
    */
   androidView?: "surface" | "texture";
 
@@ -406,8 +409,8 @@ export interface MapProps extends ViewProps {
    * Called when a user presses the map
    *
    * If the event bubbles up from a child `Source` with an `onPress` handler the
-   * `features` will be included. The event will emit on `Map` and `Source`.
-   * To prevent this use `event.stopPropagation()` in the `Source` handler.
+   * `features` will be included. The event will emit on `Map` and `Source` . To
+   * prevent this use `event.stopPropagation()` in the `Source` handler.
    */
   onPress?: (
     event:

package/src/components/sources/geojson-source/GeoJSONSource.tsx

@@ -24,35 +24,36 @@ import { getNativeFilter } from "../../../utils/getNativeFilter";
 
 export interface GeoJSONSourceRef {
   /**
-   * Get all features from the source that match the filter, regardless of visibility
+   * Get all features from the source that match the filter, regardless of
+   * visibility
+   *
+   * @param filter - Optional filter statement to filter the returned features
    *
    * @example
    * const data = await geoJSONSourceRef.current?.getData(clusterId);
-   *
-   * @param filter Optional filter statement to filter the returned features
    */
   getData(filter?: FilterSpecification): Promise<GeoJSON.FeatureCollection>;
 
   /**
    * Returns the zoom needed to expand the cluster.
    *
+   * @param clusterId - The feature cluster to expand.
+   * @returns Zoom level at which the cluster expands
+   *
    * @example
    * const zoom = await geoJSONSourceRef.current?.getClusterExpansionZoom(clusterId);
-   *
-   * @param clusterId The feature cluster to expand.
-   * @return Zoom level at which the cluster expands
    */
   getClusterExpansionZoom(clusterId: number): Promise<number>;
 
   /**
    * Returns the FeatureCollection from the cluster.
    *
-   * @example
-   * const collection = await geoJSONSourceRef.current?.getClusterLeaves(clusterId, limit, offset);
-   *
-   * @param clusterId The feature cluster to expand.
+   * @param clusterId - The feature cluster to expand.
    * @param limit - The number of points to return.
    * @param offset - The amount of points to skip (for pagination).
+   *
+   * @example
+   * const collection = await geoJSONSourceRef.current?.getClusterLeaves(clusterId, limit, offset);
    */
   getClusterLeaves(
     clusterId: number,
@@ -63,10 +64,10 @@ export interface GeoJSONSourceRef {
   /**
    * Returns the FeatureCollection from the cluster (on the next zoom level).
    *
+   * @param clusterId - The feature cluster to expand.
+   *
    * @example
    * const collection = await geoJSONSourceRef.current?.getClusterChildren(clusterId);
-   *
-   * @param  clusterId - The feature cluster to expand.
    */
   getClusterChildren(clusterId: number): Promise<GeoJSON.Feature[]>;
 }
@@ -79,7 +80,8 @@ export interface GeoJSONSourceProps extends BaseProps, PressableSourceProps {
 
   /**
    * Can be provided as one of:
-   * - An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle
+   * - An HTTP(S) URL, absolute file URL, or local file URL relative to the current
+   *   application’s resource bundle
    * - Any valid GeoJSON object
    */
   data: string | GeoJSON.GeoJSON;
@@ -90,51 +92,49 @@ export interface GeoJSONSourceProps extends BaseProps, PressableSourceProps {
   cluster?: boolean;
 
   /**
-   * Specifies the radius of each cluster if clustering is enabled.
-   * A value of 512 produces a radius equal to the width of a tile.
-   * The default value is 50.
+   * Specifies the radius of each cluster if clustering is enabled. A value of 512
+   * produces a radius equal to the width of a tile. The default value is 50.
    */
   clusterRadius?: number;
 
   /**
-   * Specifies minimum number of points to form a cluster if clustering is enabled.
-   * The default value is 2.
+   * Specifies minimum number of points to form a cluster if clustering is
+   * enabled. The default value is 2.
    */
   clusterMinPoints?: number;
 
   /**
-   * Specifies the maximum zoom level at which to cluster points if clustering is enabled.
-   * Defaults to one zoom level less than the value of maxzoom so that, at the maximum zoom,
-   * the data is not clustered.
+   * Specifies the maximum zoom level at which to cluster points if clustering is
+   * enabled. Defaults to one zoom level less than the value of maxzoom so that,
+   * at the maximum zoom, the data is not clustered.
    */
   clusterMaxZoom?: number;
 
   /**
-   * Specifies custom properties on the generated clusters if clustering
-   * is enabled, aggregating values from clustered points.
+   * Specifies custom properties on the generated clusters if clustering is
+   * enabled, aggregating values from clustered points.
    *
-   * Has the form `{ "property_name": [operator, map_expression]}`, where
-   *  `operator` is a custom reduce expression that references a special `["accumulated"]` value -
-   *   it accumulates the property value from clusters/points the cluster contains
-   *  `map_expression` produces the value of a single point
+   * Has the form `{ "property_name": [operator, map_expression]}` , where
+   * `operator` is a custom reduce expression that references a special
+   * `["accumulated"]` value - it accumulates the property value from
+   * clusters/points the cluster contains `map_expression` produces the value of a
+   * single point
    *
    * @example `{ "resultingSum": [["+", ["accumulated"], ["get", "resultingSum"]], ["get", "scalerank"]] }`
-   *
    */
   clusterProperties?: GeoJSONSourceSpecification["clusterProperties"];
 
   /**
-   * Specifies the maximum zoom level at which to create vector tiles.
-   * A greater value produces greater detail at high zoom levels.
-   * The default value is 18.
+   * Specifies the maximum zoom level at which to create vector tiles. A greater
+   * value produces greater detail at high zoom levels. The default value is 18.
    */
   maxzoom?: number;
 
   /**
-   * Specifies the size of the tile buffer on each side.
-   * A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.
-   * Larger values produce fewer rendering artifacts near tile edges and slower performance.
-   * The default value is 128.
+   * Specifies the size of the tile buffer on each side. A value of 0 produces no
+   * buffer. A value of 512 produces a buffer as wide as the tile itself. Larger
+   * values produce fewer rendering artifacts near tile edges and slower
+   * performance. The default value is 128.
    */
   buffer?: number;
 
@@ -143,14 +143,13 @@ export interface GeoJSONSourceProps extends BaseProps, PressableSourceProps {
    *
    * Higher means simpler geometries and faster performance.
    *
-   * @default 0.375
+   * @defaultValue 0.375
    */
   tolerance?: number;
 
   /**
-   * Whether to calculate line distance metrics.
-   * This is required for line layers that specify lineGradient values.
-   * The default value is false.
+   * Whether to calculate line distance metrics. This is required for line layers
+   * that specify lineGradient values. The default value is false.
    */
   lineMetrics?: boolean;
 
@@ -163,8 +162,8 @@ export interface GeoJSONSourceProps extends BaseProps, PressableSourceProps {
 }
 
 /**
- * GeoJSONSource is a map content source that supplies GeoJSON to be shown on the map.
- * The data may be provided as an url or a GeoJSON object.
+ * GeoJSONSource is a map content source that supplies GeoJSON to be shown on
+ * the map. The data may be provided as an url or a GeoJSON object.
  */
 export const GeoJSONSource = memo(
   ({ id, data, ref, ...props }: GeoJSONSourceProps) => {

package/src/components/sources/image-source/ImageSource.tsx

@@ -23,7 +23,8 @@ export interface ImageSourceProps extends BaseProps {
   url: string | number;
 
   /**
-   * The top left, top right, bottom right, and bottom left coordinates for the image.
+   * The top left, top right, bottom right, and bottom left coordinates for the
+   * image.
    */
   coordinates: [
     topLeft: LngLat,
@@ -36,8 +37,9 @@ export interface ImageSourceProps extends BaseProps {
 }
 
 /**
- * ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.
- * The georeferenced image scales and rotates as the user zooms and rotates the map
+ * ImageSource is a content source that is used for a georeferenced raster image
+ * to be shown on the map. The georeferenced image scales and rotates as the
+ * user zooms and rotates the map
  */
 export const ImageSource = memo(({ id, url, ...props }: ImageSourceProps) => {
   const frozenId = useFrozenId(id);

package/src/components/sources/raster-source/RasterSource.tsx

@@ -12,47 +12,51 @@ export interface RasterSourceProps extends BaseProps {
   id?: string;
 
   /**
-   * A URL to a TileJSON configuration file describing the source's contents and other metadata.
+   * A URL to a TileJSON configuration file describing the source's contents and
+   * other metadata.
    */
   url?: string;
 
   /**
-   * An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.
+   * An array of tile URL templates. If multiple endpoints are specified, clients
+   * may use any combination of endpoints.
+   *
    * @example "https://example.com/raster-tiles/{z}/{x}/{y}.png"
    */
   tiles?: string[];
 
   /**
-   * An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.
-   * The value should be between 0 and 22, inclusive, and less than
-   * maxzoom, if specified. The default value for this option is 0.
+   * An unsigned integer that specifies the minimum zoom level at which to display
+   * tiles from the source. The value should be between 0 and 22, inclusive, and
+   * less than maxzoom, if specified. The default value for this option is 0.
    */
   minzoom?: number;
 
   /**
-   * An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.
-   * The value should be between 0 and 22, inclusive, and less than
-   * minzoom, if specified. The default value for this option is 22.
+   * An unsigned integer that specifies the maximum zoom level at which to display
+   * tiles from the source. The value should be between 0 and 22, inclusive, and
+   * less than minzoom, if specified. The default value for this option is 22.
    */
   maxzoom?: number;
 
   /**
    * Size of the map tiles.
    *
-   * @default 512
+   * @defaultValue 512
    */
   tileSize?: number;
 
   /**
    * Influences the y direction of the tile coordinates. (tms inverts y-axis)
    *
-   * @default "xyz"
+   * @defaultValue "xyz"
    */
   scheme?: "xyz" | "tms";
 
   /**
-   * An HTML or literal text string defining the buttons to be displayed in an action sheet when the
-   * source is part of a map view's style and the map view's attribution button is pressed.
+   * An HTML or literal text string defining the buttons to be displayed in an
+   * action sheet when the source is part of a map view's style and the map view's
+   * attribution button is pressed.
    */
   attribution?: string;
 
@@ -60,9 +64,10 @@ export interface RasterSourceProps extends BaseProps {
 }
 
 /**
- * RasterSource is a map content source that supplies raster image tiles to be shown on the map.
- * The location of and metadata about the tiles are defined either by an option dictionary
- * or by an external file that conforms to the TileJSON specification.
+ * RasterSource is a map content source that supplies raster image tiles to be
+ * shown on the map. The location of and metadata about the tiles are defined
+ * either by an option dictionary or by an external file that conforms to the
+ * TileJSON specification.
  */
 export const RasterSource = memo(({ id, ...props }: RasterSourceProps) => {
   const frozenId = useFrozenId(id);

package/src/components/sources/vector-source/VectorSource.tsx

@@ -21,15 +21,13 @@ import { getNativeFilter } from "../../../utils/getNativeFilter";
 
 export interface VectorSourceRef {
   /**
-   * Returns all features that match the query parameters regardless of whether or not the feature is
-   * currently rendered on the map. The domain of the query includes all currently-loaded vector tiles
-   * and GeoJSON source tiles. This function does not check tiles outside of the visible viewport.
+   * Returns all features that match the query parameters regardless of whether or
+   * not the feature is currently rendered on the map. The domain of the query
+   * includes all currently-loaded vector tiles and GeoJSON source tiles. This
+   * function does not check tiles outside of the visible viewport.
    *
    * @example
    * vectorSource.features(['id1', 'id2'])
-   *
-   * @param  options.sourceLayer - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.
-   * @param  options.filter - an optional filter statement to filter the returned Features.
    */
   querySourceFeatures(options: {
     sourceLayer: string;
@@ -44,40 +42,43 @@ export interface VectorSourceProps extends BaseProps, PressableSourceProps {
   id?: string;
 
   /**
-   * A URL to a TileJSON configuration file describing the source’s contents and other metadata.
+   * A URL to a TileJSON configuration file describing the source’s contents and
+   * other metadata.
    */
   url?: string;
 
   /**
-   * An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.
-   * Example: https://example.com/vector-tiles/{z}/{x}/{y}.pbf
+   * An array of tile URL templates. If multiple endpoints are specified, clients
+   * may use any combination of endpoints. Example:
+   * https://example.com/vector-tiles/{z}/{x}/{y}.pbf
    */
   tiles?: string[];
 
   /**
-   * An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.
-   * The value should be between 0 and 22, inclusive, and less than
-   * maxzoom, if specified. The default value for this option is 0.
+   * An unsigned integer that specifies the minimum zoom level at which to display
+   * tiles from the source. The value should be between 0 and 22, inclusive, and
+   * less than maxzoom, if specified. The default value for this option is 0.
    */
   minzoom?: number;
 
   /**
-   * An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.
-   * The value should be between 0 and 22, inclusive, and less than
-   * minzoom, if specified. The default value for this option is 22.
+   * An unsigned integer that specifies the maximum zoom level at which to display
+   * tiles from the source. The value should be between 0 and 22, inclusive, and
+   * less than minzoom, if specified. The default value for this option is 22.
    */
   maxzoom?: number;
 
   /**
    * Influences the y direction of the tile coordinates. (tms inverts y-axis)
    *
-   * @default "xyz"
+   * @defaultValue "xyz"
    */
   scheme?: "xyz" | "tms";
 
   /**
-   * An HTML or literal text string defining the buttons to be displayed in an action sheet when the
-   * source is part of a map view’s style and the map view’s attribution button is pressed.
+   * An HTML or literal text string defining the buttons to be displayed in an
+   * action sheet when the source is part of a map view’s style and the map view’s
+   * attribution button is pressed.
    */
   attribution?: string;
 
@@ -90,8 +91,10 @@ export interface VectorSourceProps extends BaseProps, PressableSourceProps {
 }
 
 /**
- * VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.
- * The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.
+ * VectorSource is a map content source that supplies tiled vector data in
+ * Mapbox Vector Tile format to be shown on the map. The location of and
+ * metadata about the tiles are defined either by an option dictionary or by an
+ * external file that conforms to the TileJSON specification.
  */
 export const VectorSource = memo(({ id, ref, ...props }: VectorSourceProps) => {
   const nativeRef = useRef<