Skip to main content

Minimap

Additional Developer Resources
Public beta for Mapbox Search JS
Mapbox Search JS is in public beta. During the public beta phase, frameworks may be subject to potential changes as they stabilize.

Minimap provides a UI that allows users confirm a physical location on a map, reducing delivery errors in both shipping and local dispatching contexts.

This page includes reference documentation for Minimap components and types in the Mapbox Search JS React framework.

Components

AddressMinimap

AddressMinimap is a React component that displays a marker for confirmation purposes.

Optionally, this marker is editable. When editable, the marker can be moved around the map and the updated location is sent back to the Mapbox Contribute workflow.

The goal of AddressMinimap is to reduce delivery or geolocation error in shipping and local dispatching contexts.

AddressMinimap expands to fill its container, and is hidden unless AddressMinimapProps#feature and AddressMinimapProps#show are truthy.

Internally, this wraps the <mapbox-address-minimap> element.

new AddressMinimap(props: AddressMinimapProps)

Parameters

props(AddressMinimapProps) 

Example

export function Component() {
  return (
    <AddressMinimap accessToken={'YOUR_MAPBOX_ACCESS_TOKEN'}>
    </AddressMinimap>
  );
}
Was this section on AddressMinimap helpful?

Options and Type Definitions

AddressMinimapProps

Type

Object

Properties

accessToken(string): The Mapbox access token to use for all requests.

If not explicitly set on the component, this will reference the value in the global config object.

    adjustBtnText(string): Custom adjust button text appearing on the map. If not provided, the default text will be used.
      canAdjustMarker(boolean): If true , the marker can be moved around the map. Defaults to false .

      When editable, the marker can be moved around the map and the updated location can be referenced from the AddressMinimapProps#onSaveMarkerLocation callback.

        cancelBtnText(string): Custom cancel button text appearing on the map, when marker adjustment is enabled. If not provided, the default text will be used.
          defaultMapStyle([string, string]): The map style to use for the default map style. Defaults to ['mapbox', 'streets-v11'] .
            feature(GeoJSON.Feature<GeoJSON.Point>): A GeoJSON Feature representing a Point geometry.

            The minimap is hidden unless AddressMinimapProps#feature is truthy.

              footer((boolean | string)): Custom footer text appearing below the map, when marker adjustment is enabled. If true or left undefined, the default footer text will be used. If false , the footer will not be shown.
                keepMarkerCentered(boolean): If true , the map when panned moves around the marker, keeping the marker centered. Defaults to false .
                  mapStyleMode(MapStyleMode): The map style to use, either 'default' or 'satellite' . The default map style is configurable with AddressMinimapProps#defaultMapStyle .
                    markerAnchor(Anchor): The anchor of the marker, relative to center of the expanded size. Defaults to 'bottom' .
                      onSaveMarkerLocation(function (coordinate: [number, number]): void): A client-defined callback that is triggered when the "Save" button is clicked in the editing interface, and gives access to the adjusted marker coordinate.
                        satelliteToggle(boolean): If true , the map will have an image toggle between Map and Satellite styles.
                          saveBtnText(string): Custom save button text appearing on the map, when marker adjustment is enabled. If not provided, the default text will be used.
                            show(boolean): Must be true for the minimap to be shown, in addition to AddressMinimapProps#feature being present.
                              theme(Theme): The Theme to use for styling interface buttons.
                                Was this section on AddressMinimapProps helpful?
                                Additional Developer Resources
                                Was this page helpful?