Skip to content

Commit

Permalink
Improve searchOnEnter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Jul 5, 2023
1 parent dd64649 commit fe53a23
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## v0.5.0

- Adds arrow key-based navigation!
- Adds arrow key-based navigation!
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,13 @@ A single point used to influence results (doesn't follow the map viewport).

### `searchOnEnter`

Controls if pressing the Enter key uses the `/search` endpoint instead of the default `/autocomplete` endpoint.
For address-based forward geocoding applications, it often makes sense to use the forward geocoding (`/search`) endpoint
rather than autocomplete search, once you know that the user has completed their input. The full forward geocoding
endpoint is able to interpolate addresses, and may provide better results with complete input than the autocomplete
endpoint. Opting in to this behavior will send a final forward geocoding request if the user presses enter.

Note: the `/search` endpoint is not available to all plans, so check if your plan supports `/search` before enabling
this.
this. You can find the full feature comparison on our [pricing page](https://stadiamaps.com/pricing/).

### `maxResults`

Expand Down

0 comments on commit fe53a23

Please sign in to comment.