Skip to content
Permalink
Browse files
Autocomplete: Fix IE/Edge scrolling issues
IE11 and scrolling autocompletes didn't get along great; this should help fix
their relationship.

When you click on an autocomplete scrollbar in IE11, the menu temporarily
gains focus, which caused a couple problems.

1. Depending on how long you clicked, the dropdown could close.

2. Scrolling down by clicking the scrollbar's down arrow would misbehave. The
list would pop back up to the top with the first item selected.

We can fix both problems by modifying the focus/blur handling a bit.

1. There is a flag to instruct the control to ignore blurs, but it was getting
cleared too quickly; when the code refocused the input after it was blurred,
IE would send *another* blur event, which wasn't getting ignored and would
close the dropdown. We now wait for the focus/blur pair to process before
clearing the flag.

2. We remove the tabindex from the dropdown menu, which prevents menu's focus
handler from firing. When you focus a menu, it will select the first menu item
if none are selected. Selecting a menu item will scroll it into view if it's
not visible. This combination of behaviors was causing the strange behavior
when attempting to scroll down.

I couldn't figure out a way to write a unit test for this, since it's IE only
and seems to require user interaction. You can verify the previous behavior
(and the fix) on `demos/autocomplete/maxheight.html`

Fixes #9638
Closes gh-1785
  • Loading branch information
Ryan Oriecuia authored and scottgonzalez committed Jan 25, 2017
1 parent 4b9f324 commit 573e7e69c9b63752fb06a15d60ec2dded839e093
Showing with 11 additions and 23 deletions.
  1. +11 −23 ui/widgets/autocomplete.js
@@ -200,11 +200,6 @@ $.widget( "ui.autocomplete", {
this.previous = this._value();
},
blur: function( event ) {
if ( this.cancelBlur ) {
delete this.cancelBlur;
return;
}

clearTimeout( this.searching );
this.close( event );
this._change( event );
@@ -220,31 +215,24 @@ $.widget( "ui.autocomplete", {
role: null
} )
.hide()

// Support: IE 11 only, Edge <= 14
// For other browsers, we preventDefault() on the mousedown event
// to keep the dropdown from taking focus from the input. This doesn't
// work for IE/Edge, causing problems with selection and scrolling (#9638)
// Happily, IE and Edge support an "unselectable" attribute that
// prevents an element from receiving focus, exactly what we want here.
.attr( {
"unselectable": "on"
} )
.menu( "instance" );

this._addClass( this.menu.element, "ui-autocomplete", "ui-front" );
this._on( this.menu.element, {
mousedown: function( event ) {

// prevent moving focus out of the text field
// Prevent moving focus out of the text field
event.preventDefault();

// IE doesn't prevent moving focus even with event.preventDefault()
// so we set a flag to know when we should ignore the blur event
this.cancelBlur = true;
this._delay( function() {
delete this.cancelBlur;

// Support: IE 8 only
// Right clicking a menu item or selecting text from the menu items will
// result in focus moving out of the input. However, we've already received
// and ignored the blur event because of the cancelBlur flag set above. So
// we restore focus to ensure that the menu closes properly based on the user's
// next actions.
if ( this.element[ 0 ] !== $.ui.safeActiveElement( this.document[ 0 ] ) ) {
this.element.trigger( "focus" );
}
} );
},
menufocus: function( event, ui ) {
var label, item;

4 comments on commit 573e7e6

@roudhran

This comment has been minimized.

Copy link

@roudhran roudhran replied Apr 12, 2018

Hi @AttackTheDarkness I am totally new to the github. Forgive If this is silly question. May I know this autocomplete.js for Jquery-UI released version details. I've tried 1.12.1 version of JQuery-UI. But I can't find this fix there. I got this issue in IE and it sucks me.

@erichstark

This comment has been minimized.

Copy link

@erichstark erichstark replied Jan 17, 2019

@roudhran it is not included, because latest release is from 14.9.2016 https://github.com/jquery/jquery-ui/releases and this commit is from 2017. Maybe you have to build jquery-ui for your self.

@tHe-AK

This comment has been minimized.

Copy link

@tHe-AK tHe-AK replied Jan 9, 2020

Hi @AttackTheDarkness , I have made the changes in my local v1.12.1, issue is resolved for IE but facing an issue in Edge. The autocomplete menu is getting closed on clicking the top⯅/bottom⯆ icons in the scroll bar.
Do we have any fix for the same ?

@AttackTheDarkness

This comment has been minimized.

Copy link

@AttackTheDarkness AttackTheDarkness replied Jan 9, 2020

No. The previous problem was from the menu's blur handler firing when the scroll bar was used, so it's probably the same root cause. You can try setting a breakpoint in the blur handler and figuring out why it's firing, and trying an alternate approach. The above code uses the unselectable attribute which might have changed in later versions of Edge, try Googling around that and seeing if you get any insights.

Please sign in to comment.