react-native-maps 0.31.1 → 1.0.0-beta.3

package/lib/MapMarker.d.ts

@@ -0,0 +1,289 @@
+import * as React from 'react';
+import { Animated, ViewProps, ImageURISource, ImageRequireSource, View } from 'react-native';
+import { MapManagerCommand, NativeComponent, ProviderContext, UIManagerCommand } from './decorateMapComponent';
+import { CalloutPressEvent, LatLng, MarkerDeselectEvent, MarkerDragEvent, MarkerDragStartEndEvent, MarkerPressEvent, MarkerSelectEvent, Modify, Point } from './sharedTypes';
+export declare type Props = ViewProps & {
+    /**
+     * Sets the anchor point for the marker.
+     * The anchor specifies the point in the icon image that is anchored to the marker's position on the Earth's surface.
+     *
+     * The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],
+     * where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.
+     *
+     * The anchoring point in a W x H image is the nearest discrete grid point in a (W + 1) x (H + 1) grid, obtained by scaling the then rounding.
+     * For example, in a 4 x 2 image, the anchor point (0.7, 0.6) resolves to the grid point at (3, 1).
+     *
+     * @default {x: 0.5, y: 1.0}
+     * @platform iOS: Google Maps only. For Apple Maps, see the `centerOffset` prop
+     * @platform Android: Supported
+     */
+    anchor?: Point;
+    /**
+     * Specifies the point in the marker image at which to anchor the callout when it is displayed.
+     * This is specified in the same coordinate system as the anchor.
+     *
+     * See the `anchor` prop for more details.
+     *
+     * @default {x: 0.5, y: 0.0}
+     * @platform iOS: Google Maps only. For Apple Maps, see the `calloutOffset` prop
+     * @platform Android: Supported
+     */
+    calloutAnchor?: Point;
+    /**
+     * The offset (in points) at which to place the callout bubble.
+     * When this property is set to (0, 0),
+     * the anchor point of the callout bubble is placed on the top-center point of the marker view’s frame.
+     *
+     * Specifying positive offset values moves the callout bubble down and to the right,
+     * while specifying negative values moves it up and to the left
+     *
+     * @default {x: 0.0, y: 0.0}
+     * @platform iOS: Apple Maps only. For Google Maps, see the `calloutAnchor` prop
+     * @platform Android: Not supported. See see the `calloutAnchor` prop
+     */
+    calloutOffset?: Point;
+    /**
+     * The offset (in points) at which to display the annotation view.
+     *
+     * By default, the center point of an annotation view is placed at the coordinate point of the associated annotation.
+     *
+     * Positive offset values move the annotation view down and to the right, while negative values move it up and to the left.
+     *
+     * @default {x: 0.0, y: 0.0}
+     * @platform iOS: Apple Maps only. For Google Maps, see the `anchor` prop
+     * @platform Android: Not supported. See see the `anchor` prop
+     */
+    centerOffset?: Point;
+    /**
+     * The coordinate for the marker.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    coordinate: LatLng;
+    /**
+     * The description of the marker.
+     *
+     * This is only used if the <Marker /> component has no children that are a `<Callout />`,
+     * in which case the default callout behavior will be used,
+     * which will show both the `title` and the `description`, if provided.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    description?: string;
+    /**
+     * if `true` allows the marker to be draggable (re-positioned).
+     *
+     * @default false
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    draggable?: boolean;
+    /**
+     * Sets whether this marker should be flat against the map true or a billboard facing the camera.
+     *
+     * @default false
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    flat?: boolean;
+    /**
+     * Marker icon to render (equivalent to `icon` property of GMSMarker Class).
+     * Only local image resources are allowed to be used.
+     *
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    icon?: ImageURISource | ImageRequireSource;
+    /**
+     * A string that can be used to identify this marker.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    identifier?: string;
+    /**
+     * A custom image to be used as the marker's icon. Only local image resources are allowed to be used.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    image?: ImageURISource | ImageRequireSource;
+    /**
+     * When true, the marker will be pre-selected.
+     * Setting this to true allows the user to drag the marker without needing to tap on it first to focus it.
+     *
+     * @default false
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    isPreselected?: boolean;
+    /**
+     * Callback that is called when the user taps the callout view.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    onCalloutPress?: (event: CalloutPressEvent) => void;
+    /**
+     * Callback that is called when the marker is deselected, before the callout is hidden.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    onDeselect?: (event: MarkerDeselectEvent) => void;
+    /**
+     * Callback called continuously as the marker is dragged
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    onDrag?: (event: MarkerDragEvent) => void;
+    /**
+     * Callback that is called when a drag on the marker finishes.
+     * This is usually the point you will want to setState on the marker's coordinate again
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    onDragEnd?: (event: MarkerDragStartEndEvent) => void;
+    /**
+     * Callback that is called when the user initiates a drag on the marker (if it is draggable)
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    onDragStart?: (event: MarkerDragStartEndEvent) => void;
+    /**
+     * Callback that is called when the marker is tapped by the user.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    onPress?: (event: MarkerPressEvent) => void;
+    /**
+     * Callback that is called when the marker becomes selected.
+     * This will be called when the callout for that marker is about to be shown.
+     *
+     * @platform iOS: Apple Maps only.
+     * @platform Android: Not supported
+     */
+    onSelect?: (event: MarkerSelectEvent) => void;
+    /**
+     * The marker's opacity between 0.0 and 1.0.
+     *
+     * @default 1.0
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    opacity?: number;
+    /**
+     * If no custom marker view or custom image is provided, the platform default pin will be used, which can be customized by this color.
+     * Ignored if a custom marker is being used.<br/><br/>
+     * For Android, the set of available colors is limited. Unsupported colors will fall back to red.
+     * See [#887](https://github.com/react-community/react-native-maps/issues/887) for more information.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    pinColor?: string;
+    /**
+     * A float number indicating marker's rotation angle, in degrees.
+     *
+     * @default 0
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    rotation?: number;
+    /**
+     * Sets whether this marker should propagate `onPress` events.
+     * Enabling it will stop the parent `MapView`'s `onPress` from being called.
+     *
+     * Android does not propagate `onPress` events.
+     *
+     * See [#1132](https://github.com/react-community/react-native-maps/issues/1132) for more information.
+     *
+     * @default false
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    stopPropagation?: boolean;
+    /**
+     * Sets whether marker should be tappable.
+     * If set to false, the marker will not have onPress events.
+     *
+     * @default true
+     * @platform iOS: Google Maps only
+     * @platform Android: Not supported
+     */
+    tappable?: boolean;
+    /**
+     * The title of the marker.
+     * This is only used if the <Marker /> component has no `<Callout />` children.
+     *
+     * If the marker has <Callout /> children, default callout behavior will be used,
+     * which will show both the `title` and the `description`, if provided.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    title?: string;
+    /**
+     * Sets whether this marker should track view changes in info window.
+     * Enabling it will let marker change content of info window after first render pass, but will lead to decreased performance,
+     * so it's recommended to disable it whenever you don't need it.
+     * **Note**: iOS Google Maps only.
+     *
+     * @default false
+     * @platform iOS: Google Maps only
+     * @platform Android: Not supported
+     */
+    tracksInfoWindowChanges?: boolean;
+    /**
+     * Sets whether this marker should track view changes.
+     * It's recommended to turn it off whenever it's possible to improve custom marker performance.
+     *
+     * @default true
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    tracksViewChanges?: boolean;
+    /**
+     * The order in which this tile overlay is drawn with respect to other overlays.
+     * An overlay with a larger z-index is drawn over overlays with smaller z-indices.
+     * The order of overlays with the same z-index is arbitrary.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    zIndex?: number;
+};
+declare type OmittedProps = Omit<Props, 'stopPropagation'>;
+declare type NativeProps = Modify<OmittedProps, {
+    icon?: string;
+    image?: Props['image'] | string;
+}> & {
+    ref: React.RefObject<View>;
+};
+export declare class MapMarker extends React.Component<Props> {
+    context: React.ContextType<typeof ProviderContext>;
+    getNativeComponent: () => NativeComponent<NativeProps>;
+    getMapManagerCommand: (name: string) => MapManagerCommand;
+    getUIManagerCommand: (name: string) => UIManagerCommand;
+    static Animated: Animated.AnimatedComponent<typeof MapMarker>;
+    private marker;
+    constructor(props: Props);
+    setNativeProps(props: Partial<NativeProps>): void;
+    showCallout(): void;
+    hideCallout(): void;
+    redrawCallout(): void;
+    animateMarkerToCoordinate(coordinate: LatLng, duration?: number): void;
+    redraw(): void;
+    _getHandle(): number | null;
+    _runCommand(name: NativeCommandName, args: any[]): void;
+    render(): JSX.Element;
+}
+declare const _default: typeof MapMarker;
+export default _default;
+declare type NativeCommandName = 'showCallout' | 'hideCallout' | 'redrawCallout' | 'animateMarkerToCoordinate' | 'redraw';

package/lib/MapMarker.js

@@ -0,0 +1,113 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapMarker = void 0;
+const React = __importStar(require("react"));
+const react_native_1 = require("react-native");
+const decorateMapComponent_1 = __importStar(require("./decorateMapComponent"));
+class MapMarker extends React.Component {
+    getNativeComponent;
+    getMapManagerCommand;
+    getUIManagerCommand;
+    static Animated;
+    marker;
+    constructor(props) {
+        super(props);
+        this.marker = React.createRef();
+        this.showCallout = this.showCallout.bind(this);
+        this.hideCallout = this.hideCallout.bind(this);
+        this.redrawCallout = this.redrawCallout.bind(this);
+        this.animateMarkerToCoordinate = this.animateMarkerToCoordinate.bind(this);
+    }
+    setNativeProps(props) {
+        this.marker.current?.setNativeProps(props);
+    }
+    showCallout() {
+        this._runCommand('showCallout', []);
+    }
+    hideCallout() {
+        this._runCommand('hideCallout', []);
+    }
+    redrawCallout() {
+        this._runCommand('redrawCallout', []);
+    }
+    animateMarkerToCoordinate(coordinate, duration = 500) {
+        this._runCommand('animateMarkerToCoordinate', [coordinate, duration]);
+    }
+    redraw() {
+        this._runCommand('redraw', []);
+    }
+    _getHandle() {
+        return (0, react_native_1.findNodeHandle)(this.marker.current);
+    }
+    _runCommand(name, args) {
+        switch (react_native_1.Platform.OS) {
+            case 'android':
+                react_native_1.UIManager.dispatchViewManagerCommand(this._getHandle(), this.getUIManagerCommand(name), args);
+                break;
+            case 'ios':
+                this.getMapManagerCommand(name)(this._getHandle(), ...args);
+                break;
+            default:
+                break;
+        }
+    }
+    render() {
+        const { stopPropagation = false } = this.props;
+        let image;
+        if (this.props.image) {
+            image = react_native_1.Image.resolveAssetSource(this.props.image) || {};
+            image = image.uri || this.props.image;
+        }
+        let icon;
+        if (this.props.icon) {
+            icon = react_native_1.Image.resolveAssetSource(this.props.icon) || {};
+            icon = icon.uri;
+        }
+        const AIRMapMarker = this.getNativeComponent();
+        return (<AIRMapMarker {...this.props} ref={this.marker} image={image} icon={icon} style={[styles.marker, this.props.style]} onPress={event => {
+                if (stopPropagation) {
+                    event.stopPropagation();
+                }
+                if (this.props.onPress) {
+                    this.props.onPress(event);
+                }
+            }}/>);
+    }
+}
+exports.MapMarker = MapMarker;
+const styles = react_native_1.StyleSheet.create({
+    marker: {
+        position: 'absolute',
+        backgroundColor: 'transparent',
+    },
+});
+MapMarker.Animated = react_native_1.Animated.createAnimatedComponent(MapMarker);
+exports.default = (0, decorateMapComponent_1.default)(MapMarker, 'Marker', {
+    google: {
+        ios: decorateMapComponent_1.SUPPORTED,
+        android: decorateMapComponent_1.USES_DEFAULT_IMPLEMENTATION,
+    },
+});

package/lib/MapOverlay.d.ts

@@ -0,0 +1,86 @@
+import * as React from 'react';
+import { Animated, ViewProps, ImageURISource, ImageRequireSource, NativeSyntheticEvent } from 'react-native';
+import { MapManagerCommand, NativeComponent, ProviderContext, UIManagerCommand } from './decorateMapComponent';
+import { LatLng, Modify, Point } from './sharedTypes';
+declare type Props = ViewProps & {
+    /**
+     * The bearing in degrees clockwise from north. Values outside the range [0, 360) will be normalized.
+     *
+     * @default 0
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    bearing?: number;
+    /**
+     * The coordinates for the image (left-top corner, right-bottom corner). ie.```[[lat, long], [lat, long]]```
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    bounds: [Coordinate, Coordinate];
+    /**
+     * A custom image to be used as the overlay.
+     * Only required local image resources and uri (as for images located in the net) are allowed to be used.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    image: ImageURISource | ImageRequireSource;
+    /**
+     * Callback that is called when the user presses on the overlay
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    onPress?: (event: OverlayPressEvent) => void;
+    /**
+     * The opacity of the overlay.
+     *
+     * @default 1
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    opacity?: number;
+    /**
+     * Boolean to allow an overlay to be tappable and use the onPress function.
+     *
+     * @default false
+     * @platform iOS: Not supported
+     * @platform Android: Supported
+     */
+    tappable?: boolean;
+};
+declare type NativeProps = Modify<Props, {
+    image?: string;
+}>;
+export declare class MapOverlay extends React.Component<Props> {
+    context: React.ContextType<typeof ProviderContext>;
+    getNativeComponent: () => NativeComponent<NativeProps>;
+    getMapManagerCommand: (name: string) => MapManagerCommand;
+    getUIManagerCommand: (name: string) => UIManagerCommand;
+    static Animated: Animated.AnimatedComponent<typeof MapOverlay>;
+    render(): JSX.Element;
+}
+declare type Coordinate = [number, number];
+declare type OverlayPressEvent = NativeSyntheticEvent<{
+    /**
+     * @platform iOS: Apple Maps: `image-overlay-press`
+     * @platform Android: `overlay-press`
+     */
+    action: 'overlay-press' | 'image-overlay-press';
+    /**
+     * @platform iOS: Apple maps
+     */
+    name?: string;
+    /**
+     * @platform iOS: Apple Maps
+     * @platform Android
+     */
+    coordinate?: LatLng;
+    /**
+     * @platform Android
+     */
+    position?: Point;
+}>;
+declare const _default: typeof MapOverlay;
+export default _default;

package/lib/MapOverlay.js

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapOverlay = void 0;
+const React = __importStar(require("react"));
+const react_native_1 = require("react-native");
+const decorateMapComponent_1 = __importStar(require("./decorateMapComponent"));
+class MapOverlay extends React.Component {
+    getNativeComponent;
+    getMapManagerCommand;
+    getUIManagerCommand;
+    static Animated;
+    render() {
+        const { opacity = 1.0 } = this.props;
+        let image;
+        if (typeof this.props.image !== 'number' &&
+            this.props.image.uri?.startsWith('http')) {
+            image = this.props.image.uri;
+        }
+        else {
+            const sourceAsset = react_native_1.Image.resolveAssetSource(this.props.image) || {};
+            image = sourceAsset.uri;
+        }
+        const AIRMapOverlay = this.getNativeComponent();
+        return (<AIRMapOverlay {...this.props} opacity={opacity} image={image} style={[styles.overlay, this.props.style]}/>);
+    }
+}
+exports.MapOverlay = MapOverlay;
+const styles = react_native_1.StyleSheet.create({
+    overlay: {
+        position: 'absolute',
+        backgroundColor: 'transparent',
+    },
+});
+MapOverlay.Animated = react_native_1.Animated.createAnimatedComponent(MapOverlay);
+exports.default = (0, decorateMapComponent_1.default)(MapOverlay, 'Overlay', {
+    google: {
+        ios: decorateMapComponent_1.SUPPORTED,
+        android: decorateMapComponent_1.USES_DEFAULT_IMPLEMENTATION,
+    },
+});