Skip to main content

Web Reference

The Search JS Web framework is the main entry-point to Mapbox Search JS, and provides rich UI components on top of Search JS Core.

This reference documentation is divided into several sections:

  • Address Autofill. This section includes reference documentation for elements, functions, and types related to the Address Autofill and Address Confirmation features.
  • Search Box. This section includes reference documentation for elements, functions, and types related to the Search Box feature.
  • Geocoding. This section includes reference documentation for elements, functions, and types related to the Geocoding feature.
  • Address minimap.This section includes reference documentation for elements, functions, and types related to the Minimap feature.
  • Theming. This section describes the Control Theme API reference, which allows you to fully customize Search JS Web elements to match your design system.
  • Properties and options. This section describes option and property types shared by multiple web components.
  • Events and event types. This section describes the different types of events that Search JS Web can raise.
  • Configuration. This section describes shared settings across Search JS Web components.

Each section describes classes or objects as well as their properties, parameters, instance members, and associated events. Many sections also include inline code examples and related resources.

Was this page helpful?