wijmenu jQuery Widget

Create multi-level menus with animation effects, images and check box items, interactive item scrolling, and even create a pop-up menu for context help within your application.

Syntax

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.menu.wijmenu.options
     
    $(".selector").wijmenu(options);
});

function wijmenu() : any;

Options

	Name	Description
	animation	Type: wijmo.menu.wijmenu_animation The animation option determines the menu animation if the showAnimation and hideAnimation properties are not individually specified. For a description of the animation effects and the easing effects, please see the Animation page.
	backLink	Default value: true This option determines whether the iPod-style menu shows a back link or a breadcrumb header in the menu.
	backLinkText	Default value: 'Back' This option sets the text of the back link.
	checkable	Default value: false When you set the checkable option to true and click on a menu item, the clicked item's state will be selected. A "ui-state-active" class will be added to the item so that the item behavior and the item appearance are different.
	crumbDefaultText	Default value: 'Choose an option' A value that sets the top breadcrumb's default text.
	direction	Default value: 'ltr' A value that indicates menu's direction.
	ensureSubmenuOnBody	Default value: false A value indicating the submenu element will be append to the body or menu container.
	hideAnimation	Type: wijmo.menu.wijmenu_animation Determines the animation used to hide submenus.
	hideDelay	Default value: 400 This option determines how many milliseconds to delay before hiding the submenu in a fly-out menu.
	items	Default value: null The options of child items
	maxHeight	Default value: 200 This option determines the iPod-style menu's maximum height.
	mode	Default value: 'flyout' The mode option defines the behavior of the menu, whether it is a pop-up menu or an iPod-style navigation list.
	orientation	Default value: 'horizontal' This option controls the root menu's orientation. All submenus are vertical regardless of the orientation of the root menu.
	position	The position option specifies the location and orientation of the menu relative to the button or link used to open it.
	showAnimation	This option determines the animation effect, the duration, and the easing effect used to hide the submenus. You can also use this option to set any animation-specific options, such as direction.
	showDelay	Default value: 400 This option determines how many milliseconds to delay before showing the submenu in a fly-out menu.
	slidingAnimation	Type: wijmo.menu.wijmenu_slidingAnimation This option defines the animation used to slide a submenu when in sliding mode.
	submenuTriggerEvent	Default value: 'default' The submenuTriggerEvent option specifies the mouse event used to show the submenu. If submenuTriggerEvent is 'default', it will get value from triggerEvent option.
	superPanelOptions	Default value: null This option specifies a hash value that sets to superpanel options when a superpanel is created. It is used to set appearances and behaviors when a scrollbar is shown in sliding mode.
	topLinkText	Default value: 'All' A value that sets the text of the top link.
	trigger	Default value: "" The trigger option handles the open event for the menu or submenu. This option must be used with the triggerEvent option.
	triggerEvent	Default value: 'click' The triggerEvent option specifies the mouse event used to show the menu or submenu. triggerEvent must be used with the trigger option.

Top

Methods

	Name	Description
	activate	This method activates a menu item by deactivating the current item, scrolling the new item into view, and, if necessary,making it the active item, and triggering a focus event.
	add	Adds a child menuItem to the menuItem.
	deactivate	The deactivate method clears the current selection. This method is useful when reopening a menu which you previously selected an item. If you don't call this method then an item which you selected before allowing the menu to close will remain highlighted when the menu is reopened.
	destroy	The destroy method removes the wijmenu functionality completely and returns the element to its pre-init state.
	first	The first method defines the first menu item as the active item.
	getItems	Gets the collection of child items.
	hideAllMenus	The hideAllMenus method hides all menu items currently showing.
	last	The last method defines the last menu item as the active item.
	next	The next method gets the next selectable item. The first item is selected if no item is active or the last one is active. It returns null if none is selectable.
	nextPage	This method is similar to the "next" method, but it jumps a whole page to the next page instead of to the next selectable item. You can call this method when you are using an iPod-style menu.
	previous	Get the previous selectable item. It selects the last item if no item is active or if the first item is active. It returns null if no previous item is selectable.
	previousPage	This method is similar to the "previous" method, but it jumps a whole page to the previous page. You can call this method when you're using an iPod-style menu.
	refresh	The method is used to refresh the menu when DOM operations add or replace a menu item. For example, if you add a new menu item through "menu.append," then you can use the refresh method to make sure that the new menu item appears in the menu.
	remove	Remove an item from the menu.
	select	This method selects the active item which triggers the select event for that item. This event is useful for custom keyboard handling.
	setItemDisabled	The setItemDisabled method allows the user to disable a specific menu item.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	blur	The blur event is triggered when a menu item loses focus. You can use this event to track which item has lost focus. An item can lose focus through keyboard commands, such as when the Tab key is pressed, or when a user clicks elsewhere on the page.
	focus	The focus event is triggered either on mouse hover or when the keyboard cursor keys are used for navigation. In general, an item or element that has focus is highlighted in some way. When an item or element has focus it is the first to receive keyboard-related events.
	hidden	The hidden event is triggered after the menu or submenu is hidden.
	hidding	The hidding event is triggered before hidding the menu or submenu. This event can be cancelled with "return false";
	select	The select event is triggered when a menu item is selected. This event can be triggered by theselect method to allow for custom keyboard handling.
	showing	The showing event is triggered before the submenu is shown. showing is a useful event if you want to perform a function before the submenu is shown or if you want to block the submenu from showing by returning false.
	shown	The shown event is triggered after the menu or submenu is shown.

Top

Widgets

Reference

wijmenu jQuery Widget