feat(places): add Places widget

[francoischalifour]

Description

The Places.js widget for InstantSearch was not longer compatible with InstantSearch 4 because the widget lifecycle changed.

We'll no longer maintain the widget on the Places.js repo but rather provide a Places widget as part of InstantSearch itself. The reasoning behind this decision is that the widget hosted in Place.js couldn't be updated without also bumping Place.js to a major version. We are now more in control of when to release this widget.

This is a port of the existing widget with updated lifecycles and technical stack (TypeScript).

Usage

import algoliaPlaces from 'places.js';

const search = instantsearch({
  /* ... */
});

search.addWidgets([
  places({
    placesReference: algoliaPlaces,
    container: '#places',
    defaultPosition: ['37.7793', '-122.419'],
  }),
]);

API

So that Places.js isn't loaded with InstantSearch even though you don't use this widget, Places reference is now passed to the widget itself (similar to what we do for searchClient, insightsClient and googleReference).

placesReference

Places reference | required

The Algolia Places reference to use.

defaultPosition

string[] | optional

The default position when the input is empty.

Preview

See stories →

Impact

• Document the widget API on the documentation website
• Update the documentation for Place.js with InstantSearch.js 4

[Haroenv]

this looks really good! I'd be more inclined to call placesClient places though. This means you can't call the places widget places, but it's not exactly a client, since it's the UI too

[Haroenv]

(approve here is for the code alone, we need to make sure we don't rush this release of course)

[francoischalifour]

@Haroenv We could call that placesReference like we do for googleReference.

[Haroenv]

yes, that works better than client for me