InstantSearch / React / V6 / API reference

Control | React InstantSearch V6 (Deprecated)

Deprecated content
This documentation is for a deprecated version of React InstantSearch. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of React InstantSearch for up-to-date information.

Signature

Signature 
<Control
  // Optional parameters
  translations={object}
/>

About this widget

The Control widget allows the user to control the different strategies for the refinement (enable/disable refine on map move).

Examples

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

import {
  GoogleMapsLoader,
  GeoSearch,
  Control,
  Marker,
} from 'react-instantsearch-dom-maps';

<div style={{ height: 500 }}>
  <GoogleMapsLoader apiKey="GOOGLE_MAPS_API_KEY">
    {google => (
      <GeoSearch google={google}>
        {({ hits }) => (
          <div>
            <Control />
            {hits.map(hit => (
              <Marker key={hit.objectID} hit={hit} />
            ))}
          </div>
        )}
      </GeoSearch>
    )}
  </GoogleMapsLoader>
</div>

Props

translations

Optional
Type: object

A mapping of keys to translation values.

  • control: the label of the radio button.
  • redo: the label of the redo button.
Copy 
1
2
3
4
5
6

<Control
  translations={{
    control: 'Search as I move the map',
    redo: 'Redo search here',
  }}
/>
Did you find this page helpful?