Skip to content

Autocomplete: Close the menu on any outside interactions #1614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Autocomplete: Close the menu on any outside interactions #1614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c769930
Autocomplete: Close the menu on any outside interactions
scottgonzalez Oct 15, 2015
d7c4815
fixup: Add test
scottgonzalez Oct 16, 2015
7045e12
fixup: Test cleanup
scottgonzalez Oct 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions tests/unit/autocomplete/core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,4 +398,28 @@ asyncTest( "Search if the user retypes the same value (#7434)", function() {
} );
} );

asyncTest( "Close on click outside when focus remains", function() {
expect( 2 );

var element = $( "#autocomplete" ).autocomplete( {
source: [ "java", "javascript" ],
delay: 0
} );
var menu = element.autocomplete( "widget" );

$( "body" ).on( "mousedown", function( event ) {
event.preventDefault();
} );

element.val( "j" ).autocomplete( "search", "j" );
setTimeout(function() {
ok( menu.is( ":visible" ), "menu displays initially" );
$( "body" ).simulate( "mousedown" );
setTimeout(function() {
ok( menu.is( ":hidden" ), "menu closes after clicking elsewhere" );
start();
} );
} );
} );

} );
41 changes: 23 additions & 18 deletions ui/widgets/autocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,24 +245,6 @@ $.widget( "ui.autocomplete", {
this.element.trigger( "focus" );
}
} );

// Clicking on the scrollbar causes focus to shift to the body
// but we can't detect a mouseup or a click immediately afterward
// so we have to track the next mousedown and close the menu if
// the user clicks somewhere outside of the autocomplete
var menuElement = this.menu.element[ 0 ];
if ( !$( event.target ).closest( ".ui-menu-item" ).length ) {
this._delay( function() {
var that = this;
this.document.one( "mousedown", function( event ) {
if ( event.target !== that.element[ 0 ] &&
event.target !== menuElement &&
!$.contains( menuElement, event.target ) ) {
that.close();
}
} );
} );
}
},
menufocus: function( event, ui ) {
var label, item;
Expand Down Expand Up @@ -368,6 +350,20 @@ $.widget( "ui.autocomplete", {
}
},

_isEventTargetInWidget: function( event ) {
var menuElement = this.menu.element[ 0 ];

return event.target === this.element[ 0 ] ||
event.target === menuElement ||
$.contains( menuElement, event.target );
},

_closeOnClickOutside: function( event ) {
if ( !this._isEventTargetInWidget( event ) ) {
this.close();
}
},

_appendTo: function() {
var element = this.options.appendTo;

Expand Down Expand Up @@ -496,6 +492,10 @@ $.widget( "ui.autocomplete", {
},

_close: function( event ) {

// Remove the handler that closes the menu on outside clicks
this._off( this.document, "mousedown" );

if ( this.menu.element.is( ":visible" ) ) {
this.menu.element.hide();
this.menu.blur();
Expand Down Expand Up @@ -546,6 +546,11 @@ $.widget( "ui.autocomplete", {
if ( this.options.autoFocus ) {
this.menu.next();
}

// Listen for interactions outside of the widget (#6642)
this._on( this.document, {
mousedown: "_closeOnClickOutside"
} );
},

_resizeMenu: function() {
Expand Down