mapbox/mapbox-gl-geocoder

Geocoder input hijacks focus when used in form

Open

#402 opened on Nov 24, 2020

View on GitHub
 (5 comments) (5 reactions) (0 assignees)JavaScript (182 forks)github user discovery
help wanted

Repository metrics

Stars
 (386 stars)
PR merge metrics
 (PR metrics pending)

Description

Overview

When using the geocoder outside of a map, as part of a form, pressing the Enter key in another field will bring the focus of the form to the geocoder input. This is unexpected behavior which prevents users from submitting forms via Enter and breaks the overall flow of filling out a form.

Library Version

Reproducible Example

Expected Behavior

  • The Enter button should behave as it normally would in a form (i.e. submitting form when appropriate).

Current Behavior

  • The form changes focus to the geocoder input.

Notes

  • This issue doesn't seem to happen when the geocoder input is placed after the submit button, e.g.:
<!-- This order does not produce the focus-on-Enter issue -->
<input type="text" name="example_email" placeholder="Email">
<input type="submit" value="Submit" tabindex="-1">
<div class="geocoder"></div>

Contributor guide

Research direction
Inspect the keydown event handler in the geocoder component. Look for any event propagation or default prevention that might cause the enter key to focus the geocoder input instead of submitting the form.
Tech stack
javascript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75