mirror of
https://github.com/jquery/jquery-ui.git
synced 2024-11-21 11:04:24 +00:00
ddc666ce8b
Prevents focusing the wrong item when typeahead causes a scroll while the mouse is over an item in the menu. Fixes #10458
647 lines
17 KiB
JavaScript
647 lines
17 KiB
JavaScript
/*!
|
|
* jQuery UI Menu @VERSION
|
|
* http://jqueryui.com
|
|
*
|
|
* Copyright 2014 jQuery Foundation and other contributors
|
|
* Released under the MIT license.
|
|
* http://jquery.org/license
|
|
*
|
|
* http://api.jqueryui.com/menu/
|
|
*/
|
|
(function( factory ) {
|
|
if ( typeof define === "function" && define.amd ) {
|
|
|
|
// AMD. Register as an anonymous module.
|
|
define([
|
|
"jquery",
|
|
"./core",
|
|
"./widget",
|
|
"./position"
|
|
], factory );
|
|
} else {
|
|
|
|
// Browser globals
|
|
factory( jQuery );
|
|
}
|
|
}(function( $ ) {
|
|
|
|
return $.widget( "ui.menu", {
|
|
version: "@VERSION",
|
|
defaultElement: "<ul>",
|
|
delay: 300,
|
|
options: {
|
|
icons: {
|
|
submenu: "ui-icon-carat-1-e"
|
|
},
|
|
items: "> *",
|
|
menus: "ul",
|
|
position: {
|
|
my: "left-1 top",
|
|
at: "right top"
|
|
},
|
|
role: "menu",
|
|
|
|
// callbacks
|
|
blur: null,
|
|
focus: null,
|
|
select: null
|
|
},
|
|
|
|
_create: function() {
|
|
this.activeMenu = this.element;
|
|
|
|
// Flag used to prevent firing of the click handler
|
|
// as the event bubbles up through nested menus
|
|
this.mouseHandled = false;
|
|
this.element
|
|
.uniqueId()
|
|
.addClass( "ui-menu ui-widget ui-widget-content" )
|
|
.toggleClass( "ui-menu-icons", !!this.element.find( ".ui-icon" ).length )
|
|
.attr({
|
|
role: this.options.role,
|
|
tabIndex: 0
|
|
});
|
|
|
|
if ( this.options.disabled ) {
|
|
this.element
|
|
.addClass( "ui-state-disabled" )
|
|
.attr( "aria-disabled", "true" );
|
|
}
|
|
|
|
this._on({
|
|
// Prevent focus from sticking to links inside menu after clicking
|
|
// them (focus should always stay on UL during navigation).
|
|
"mousedown .ui-menu-item": function( event ) {
|
|
event.preventDefault();
|
|
},
|
|
"click .ui-menu-item": function( event ) {
|
|
var target = $( event.target );
|
|
if ( !this.mouseHandled && target.not( ".ui-state-disabled" ).length ) {
|
|
this.select( event );
|
|
|
|
// Only set the mouseHandled flag if the event will bubble, see #9469.
|
|
if ( !event.isPropagationStopped() ) {
|
|
this.mouseHandled = true;
|
|
}
|
|
|
|
// Open submenu on click
|
|
if ( target.has( ".ui-menu" ).length ) {
|
|
this.expand( event );
|
|
} else if ( !this.element.is( ":focus" ) && $( this.document[ 0 ].activeElement ).closest( ".ui-menu" ).length ) {
|
|
|
|
// Redirect focus to the menu
|
|
this.element.trigger( "focus", [ true ] );
|
|
|
|
// If the active item is on the top level, let it stay active.
|
|
// Otherwise, blur the active item since it is no longer visible.
|
|
if ( this.active && this.active.parents( ".ui-menu" ).length === 1 ) {
|
|
clearTimeout( this.timer );
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"mouseenter .ui-menu-item": function( event ) {
|
|
// Ignore mouse events while typeahead is active, see #10458.
|
|
// Prevents focusing the wrong item when typeahead causes a scroll while the mouse
|
|
// is over an item in the menu
|
|
if ( this.previousFilter ) {
|
|
return;
|
|
}
|
|
var target = $( event.currentTarget );
|
|
// Remove ui-state-active class from siblings of the newly focused menu item
|
|
// to avoid a jump caused by adjacent elements both having a class with a border
|
|
target.siblings( ".ui-state-active" ).removeClass( "ui-state-active" );
|
|
this.focus( event, target );
|
|
},
|
|
mouseleave: "collapseAll",
|
|
"mouseleave .ui-menu": "collapseAll",
|
|
focus: function( event, keepActiveItem ) {
|
|
// If there's already an active item, keep it active
|
|
// If not, activate the first item
|
|
var item = this.active || this.element.find( this.options.items ).eq( 0 );
|
|
|
|
if ( !keepActiveItem ) {
|
|
this.focus( event, item );
|
|
}
|
|
},
|
|
blur: function( event ) {
|
|
this._delay(function() {
|
|
if ( !$.contains( this.element[0], this.document[0].activeElement ) ) {
|
|
this.collapseAll( event );
|
|
}
|
|
});
|
|
},
|
|
keydown: "_keydown"
|
|
});
|
|
|
|
this.refresh();
|
|
|
|
// Clicks outside of a menu collapse any open menus
|
|
this._on( this.document, {
|
|
click: function( event ) {
|
|
if ( this._closeOnDocumentClick( event ) ) {
|
|
this.collapseAll( event );
|
|
}
|
|
|
|
// Reset the mouseHandled flag
|
|
this.mouseHandled = false;
|
|
}
|
|
});
|
|
},
|
|
|
|
_destroy: function() {
|
|
// Destroy (sub)menus
|
|
this.element
|
|
.removeAttr( "aria-activedescendant" )
|
|
.find( ".ui-menu" ).addBack()
|
|
.removeClass( "ui-menu ui-widget ui-widget-content ui-menu-icons ui-front" )
|
|
.removeAttr( "role" )
|
|
.removeAttr( "tabIndex" )
|
|
.removeAttr( "aria-labelledby" )
|
|
.removeAttr( "aria-expanded" )
|
|
.removeAttr( "aria-hidden" )
|
|
.removeAttr( "aria-disabled" )
|
|
.removeUniqueId()
|
|
.show();
|
|
|
|
// Destroy menu items
|
|
this.element.find( ".ui-menu-item" )
|
|
.removeClass( "ui-menu-item" )
|
|
.removeAttr( "role" )
|
|
.removeAttr( "aria-disabled" )
|
|
.removeUniqueId()
|
|
.removeClass( "ui-state-hover" )
|
|
.removeAttr( "tabIndex" )
|
|
.removeAttr( "role" )
|
|
.removeAttr( "aria-haspopup" )
|
|
.children().each( function() {
|
|
var elem = $( this );
|
|
if ( elem.data( "ui-menu-submenu-carat" ) ) {
|
|
elem.remove();
|
|
}
|
|
});
|
|
|
|
// Destroy menu dividers
|
|
this.element.find( ".ui-menu-divider" ).removeClass( "ui-menu-divider ui-widget-content" );
|
|
},
|
|
|
|
_keydown: function( event ) {
|
|
var match, prev, character, skip, regex,
|
|
preventDefault = true;
|
|
|
|
function escape( value ) {
|
|
return value.replace( /[\-\[\]{}()*+?.,\\\^$|#\s]/g, "\\$&" );
|
|
}
|
|
|
|
switch ( event.keyCode ) {
|
|
case $.ui.keyCode.PAGE_UP:
|
|
this.previousPage( event );
|
|
break;
|
|
case $.ui.keyCode.PAGE_DOWN:
|
|
this.nextPage( event );
|
|
break;
|
|
case $.ui.keyCode.HOME:
|
|
this._move( "first", "first", event );
|
|
break;
|
|
case $.ui.keyCode.END:
|
|
this._move( "last", "last", event );
|
|
break;
|
|
case $.ui.keyCode.UP:
|
|
this.previous( event );
|
|
break;
|
|
case $.ui.keyCode.DOWN:
|
|
this.next( event );
|
|
break;
|
|
case $.ui.keyCode.LEFT:
|
|
this.collapse( event );
|
|
break;
|
|
case $.ui.keyCode.RIGHT:
|
|
if ( this.active && !this.active.is( ".ui-state-disabled" ) ) {
|
|
this.expand( event );
|
|
}
|
|
break;
|
|
case $.ui.keyCode.ENTER:
|
|
case $.ui.keyCode.SPACE:
|
|
this._activate( event );
|
|
break;
|
|
case $.ui.keyCode.ESCAPE:
|
|
this.collapse( event );
|
|
break;
|
|
default:
|
|
preventDefault = false;
|
|
prev = this.previousFilter || "";
|
|
character = String.fromCharCode( event.keyCode );
|
|
skip = false;
|
|
|
|
clearTimeout( this.filterTimer );
|
|
|
|
if ( character === prev ) {
|
|
skip = true;
|
|
} else {
|
|
character = prev + character;
|
|
}
|
|
|
|
regex = new RegExp( "^" + escape( character ), "i" );
|
|
match = this.activeMenu.find( this.options.items ).filter(function() {
|
|
return regex.test( $( this ).text() );
|
|
});
|
|
match = skip && match.index( this.active.next() ) !== -1 ?
|
|
this.active.nextAll( ".ui-menu-item" ) :
|
|
match;
|
|
|
|
// If no matches on the current filter, reset to the last character pressed
|
|
// to move down the menu to the first item that starts with that character
|
|
if ( !match.length ) {
|
|
character = String.fromCharCode( event.keyCode );
|
|
regex = new RegExp( "^" + escape( character ), "i" );
|
|
match = this.activeMenu.find( this.options.items ).filter(function() {
|
|
return regex.test( $( this ).text() );
|
|
});
|
|
}
|
|
|
|
if ( match.length ) {
|
|
this.focus( event, match );
|
|
if ( match.length > 1 ) {
|
|
this.previousFilter = character;
|
|
this.filterTimer = this._delay(function() {
|
|
delete this.previousFilter;
|
|
}, 1000 );
|
|
} else {
|
|
delete this.previousFilter;
|
|
}
|
|
} else {
|
|
delete this.previousFilter;
|
|
}
|
|
}
|
|
|
|
if ( preventDefault ) {
|
|
event.preventDefault();
|
|
}
|
|
},
|
|
|
|
_activate: function( event ) {
|
|
if ( !this.active.is( ".ui-state-disabled" ) ) {
|
|
if ( this.active.is( "[aria-haspopup='true']" ) ) {
|
|
this.expand( event );
|
|
} else {
|
|
this.select( event );
|
|
}
|
|
}
|
|
},
|
|
|
|
refresh: function() {
|
|
var menus, items,
|
|
that = this,
|
|
icon = this.options.icons.submenu,
|
|
submenus = this.element.find( this.options.menus );
|
|
|
|
this.element.toggleClass( "ui-menu-icons", !!this.element.find( ".ui-icon" ).length );
|
|
|
|
// Initialize nested menus
|
|
submenus.filter( ":not(.ui-menu)" )
|
|
.addClass( "ui-menu ui-widget ui-widget-content ui-front" )
|
|
.hide()
|
|
.attr({
|
|
role: this.options.role,
|
|
"aria-hidden": "true",
|
|
"aria-expanded": "false"
|
|
})
|
|
.each(function() {
|
|
var menu = $( this ),
|
|
item = menu.parent(),
|
|
submenuCarat = $( "<span>" )
|
|
.addClass( "ui-menu-icon ui-icon " + icon )
|
|
.data( "ui-menu-submenu-carat", true );
|
|
|
|
item
|
|
.attr( "aria-haspopup", "true" )
|
|
.prepend( submenuCarat );
|
|
menu.attr( "aria-labelledby", item.attr( "id" ) );
|
|
});
|
|
|
|
menus = submenus.add( this.element );
|
|
items = menus.find( this.options.items );
|
|
|
|
// Initialize menu-items containing spaces and/or dashes only as dividers
|
|
items.not( ".ui-menu-item" ).each(function() {
|
|
var item = $( this );
|
|
if ( that._isDivider( item ) ) {
|
|
item.addClass( "ui-widget-content ui-menu-divider" );
|
|
}
|
|
});
|
|
|
|
// Don't refresh list items that are already adapted
|
|
items.not( ".ui-menu-item, .ui-menu-divider" )
|
|
.addClass( "ui-menu-item" )
|
|
.uniqueId()
|
|
.attr({
|
|
tabIndex: -1,
|
|
role: this._itemRole()
|
|
});
|
|
|
|
// Add aria-disabled attribute to any disabled menu item
|
|
items.filter( ".ui-state-disabled" ).attr( "aria-disabled", "true" );
|
|
|
|
// If the active item has been removed, blur the menu
|
|
if ( this.active && !$.contains( this.element[ 0 ], this.active[ 0 ] ) ) {
|
|
this.blur();
|
|
}
|
|
},
|
|
|
|
_itemRole: function() {
|
|
return {
|
|
menu: "menuitem",
|
|
listbox: "option"
|
|
}[ this.options.role ];
|
|
},
|
|
|
|
_setOption: function( key, value ) {
|
|
if ( key === "icons" ) {
|
|
this.element.find( ".ui-menu-icon" )
|
|
.removeClass( this.options.icons.submenu )
|
|
.addClass( value.submenu );
|
|
}
|
|
if ( key === "disabled" ) {
|
|
this.element
|
|
.toggleClass( "ui-state-disabled", !!value )
|
|
.attr( "aria-disabled", value );
|
|
}
|
|
this._super( key, value );
|
|
},
|
|
|
|
focus: function( event, item ) {
|
|
var nested, focused;
|
|
this.blur( event, event && event.type === "focus" );
|
|
|
|
this._scrollIntoView( item );
|
|
|
|
this.active = item.first();
|
|
focused = this.active.addClass( "ui-state-focus" ).removeClass( "ui-state-active" );
|
|
// Only update aria-activedescendant if there's a role
|
|
// otherwise we assume focus is managed elsewhere
|
|
if ( this.options.role ) {
|
|
this.element.attr( "aria-activedescendant", focused.attr( "id" ) );
|
|
}
|
|
|
|
// Highlight active parent menu item, if any
|
|
this.active
|
|
.parent()
|
|
.closest( ".ui-menu-item" )
|
|
.addClass( "ui-state-active" );
|
|
|
|
if ( event && event.type === "keydown" ) {
|
|
this._close();
|
|
} else {
|
|
this.timer = this._delay(function() {
|
|
this._close();
|
|
}, this.delay );
|
|
}
|
|
|
|
nested = item.children( ".ui-menu" );
|
|
if ( nested.length && event && ( /^mouse/.test( event.type ) ) ) {
|
|
this._startOpening(nested);
|
|
}
|
|
this.activeMenu = item.parent();
|
|
|
|
this._trigger( "focus", event, { item: item } );
|
|
},
|
|
|
|
_scrollIntoView: function( item ) {
|
|
var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight;
|
|
if ( this._hasScroll() ) {
|
|
borderTop = parseFloat( $.css( this.activeMenu[0], "borderTopWidth" ) ) || 0;
|
|
paddingTop = parseFloat( $.css( this.activeMenu[0], "paddingTop" ) ) || 0;
|
|
offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop;
|
|
scroll = this.activeMenu.scrollTop();
|
|
elementHeight = this.activeMenu.height();
|
|
itemHeight = item.outerHeight();
|
|
|
|
if ( offset < 0 ) {
|
|
this.activeMenu.scrollTop( scroll + offset );
|
|
} else if ( offset + itemHeight > elementHeight ) {
|
|
this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight );
|
|
}
|
|
}
|
|
},
|
|
|
|
blur: function( event, fromFocus ) {
|
|
if ( !fromFocus ) {
|
|
clearTimeout( this.timer );
|
|
}
|
|
|
|
if ( !this.active ) {
|
|
return;
|
|
}
|
|
|
|
this.active.removeClass( "ui-state-focus" );
|
|
this.active = null;
|
|
|
|
this._trigger( "blur", event, { item: this.active } );
|
|
},
|
|
|
|
_startOpening: function( submenu ) {
|
|
clearTimeout( this.timer );
|
|
|
|
// Don't open if already open fixes a Firefox bug that caused a .5 pixel
|
|
// shift in the submenu position when mousing over the carat icon
|
|
if ( submenu.attr( "aria-hidden" ) !== "true" ) {
|
|
return;
|
|
}
|
|
|
|
this.timer = this._delay(function() {
|
|
this._close();
|
|
this._open( submenu );
|
|
}, this.delay );
|
|
},
|
|
|
|
_open: function( submenu ) {
|
|
var position = $.extend({
|
|
of: this.active
|
|
}, this.options.position );
|
|
|
|
clearTimeout( this.timer );
|
|
this.element.find( ".ui-menu" ).not( submenu.parents( ".ui-menu" ) )
|
|
.hide()
|
|
.attr( "aria-hidden", "true" );
|
|
|
|
submenu
|
|
.show()
|
|
.removeAttr( "aria-hidden" )
|
|
.attr( "aria-expanded", "true" )
|
|
.position( position );
|
|
},
|
|
|
|
collapseAll: function( event, all ) {
|
|
clearTimeout( this.timer );
|
|
this.timer = this._delay(function() {
|
|
// If we were passed an event, look for the submenu that contains the event
|
|
var currentMenu = all ? this.element :
|
|
$( event && event.target ).closest( this.element.find( ".ui-menu" ) );
|
|
|
|
// If we found no valid submenu ancestor, use the main menu to close all sub menus anyway
|
|
if ( !currentMenu.length ) {
|
|
currentMenu = this.element;
|
|
}
|
|
|
|
this._close( currentMenu );
|
|
|
|
this.blur( event );
|
|
this.activeMenu = currentMenu;
|
|
}, this.delay );
|
|
},
|
|
|
|
// With no arguments, closes the currently active menu - if nothing is active
|
|
// it closes all menus. If passed an argument, it will search for menus BELOW
|
|
_close: function( startMenu ) {
|
|
if ( !startMenu ) {
|
|
startMenu = this.active ? this.active.parent() : this.element;
|
|
}
|
|
|
|
startMenu
|
|
.find( ".ui-menu" )
|
|
.hide()
|
|
.attr( "aria-hidden", "true" )
|
|
.attr( "aria-expanded", "false" )
|
|
.end()
|
|
.find( ".ui-state-active" ).not( ".ui-state-focus" )
|
|
.removeClass( "ui-state-active" );
|
|
},
|
|
|
|
_closeOnDocumentClick: function( event ) {
|
|
return !$( event.target ).closest( ".ui-menu" ).length;
|
|
},
|
|
|
|
_isDivider: function( item ) {
|
|
|
|
// Match hyphen, em dash, en dash
|
|
return !/[^\-\u2014\u2013\s]/.test( item.text() );
|
|
},
|
|
|
|
collapse: function( event ) {
|
|
var newItem = this.active &&
|
|
this.active.parent().closest( ".ui-menu-item", this.element );
|
|
if ( newItem && newItem.length ) {
|
|
this._close();
|
|
this.focus( event, newItem );
|
|
}
|
|
},
|
|
|
|
expand: function( event ) {
|
|
var newItem = this.active &&
|
|
this.active
|
|
.children( ".ui-menu " )
|
|
.find( this.options.items )
|
|
.first();
|
|
|
|
if ( newItem && newItem.length ) {
|
|
this._open( newItem.parent() );
|
|
|
|
// Delay so Firefox will not hide activedescendant change in expanding submenu from AT
|
|
this._delay(function() {
|
|
this.focus( event, newItem );
|
|
});
|
|
}
|
|
},
|
|
|
|
next: function( event ) {
|
|
this._move( "next", "first", event );
|
|
},
|
|
|
|
previous: function( event ) {
|
|
this._move( "prev", "last", event );
|
|
},
|
|
|
|
isFirstItem: function() {
|
|
return this.active && !this.active.prevAll( ".ui-menu-item" ).length;
|
|
},
|
|
|
|
isLastItem: function() {
|
|
return this.active && !this.active.nextAll( ".ui-menu-item" ).length;
|
|
},
|
|
|
|
_move: function( direction, filter, event ) {
|
|
var next;
|
|
if ( this.active ) {
|
|
if ( direction === "first" || direction === "last" ) {
|
|
next = this.active
|
|
[ direction === "first" ? "prevAll" : "nextAll" ]( ".ui-menu-item" )
|
|
.eq( -1 );
|
|
} else {
|
|
next = this.active
|
|
[ direction + "All" ]( ".ui-menu-item" )
|
|
.eq( 0 );
|
|
}
|
|
}
|
|
if ( !next || !next.length || !this.active ) {
|
|
next = this.activeMenu.find( this.options.items )[ filter ]();
|
|
}
|
|
|
|
this.focus( event, next );
|
|
},
|
|
|
|
nextPage: function( event ) {
|
|
var item, base, height;
|
|
|
|
if ( !this.active ) {
|
|
this.next( event );
|
|
return;
|
|
}
|
|
if ( this.isLastItem() ) {
|
|
return;
|
|
}
|
|
if ( this._hasScroll() ) {
|
|
base = this.active.offset().top;
|
|
height = this.element.height();
|
|
this.active.nextAll( ".ui-menu-item" ).each(function() {
|
|
item = $( this );
|
|
return item.offset().top - base - height < 0;
|
|
});
|
|
|
|
this.focus( event, item );
|
|
} else {
|
|
this.focus( event, this.activeMenu.find( this.options.items )
|
|
[ !this.active ? "first" : "last" ]() );
|
|
}
|
|
},
|
|
|
|
previousPage: function( event ) {
|
|
var item, base, height;
|
|
if ( !this.active ) {
|
|
this.next( event );
|
|
return;
|
|
}
|
|
if ( this.isFirstItem() ) {
|
|
return;
|
|
}
|
|
if ( this._hasScroll() ) {
|
|
base = this.active.offset().top;
|
|
height = this.element.height();
|
|
this.active.prevAll( ".ui-menu-item" ).each(function() {
|
|
item = $( this );
|
|
return item.offset().top - base + height > 0;
|
|
});
|
|
|
|
this.focus( event, item );
|
|
} else {
|
|
this.focus( event, this.activeMenu.find( this.options.items ).first() );
|
|
}
|
|
},
|
|
|
|
_hasScroll: function() {
|
|
return this.element.outerHeight() < this.element.prop( "scrollHeight" );
|
|
},
|
|
|
|
select: function( event ) {
|
|
// TODO: It should never be possible to not have an active item at this
|
|
// point, but the tests don't trigger mouseenter before click.
|
|
this.active = this.active || $( event.target ).closest( ".ui-menu-item" );
|
|
var ui = { item: this.active };
|
|
if ( !this.active.has( ".ui-menu" ).length ) {
|
|
this.collapseAll( event, true );
|
|
}
|
|
this._trigger( "select", event, ui );
|
|
}
|
|
});
|
|
|
|
}));
|