Yahoo! Developer Network Home - Help

Site Search (YDN & YUIBlog):

# YUI Library Examples: Menu Family: Listening For Menu Events

# Menu Family: Listening For Menu Events

This example demonstrates how to listen for DOM-related events. Interaction with the Menu will result in event information being output to the console. Please note: Disabled MenuItem instances do not fire DOM events. This is demonstrated with the MenuItem named "MenuItem 2."

Note: By default clicking outside of a Menu instance will hide it. Additionally, MenuItem instances without a submenu or a URL to navigate to will hide their parent Menu instance when clicked. Click the "Show Menu" button below to make the Menu instance visible if it is hidden.

View example in new window.

## Adding DOM-based event handlers to Menu and MenuItem instances.

All of the events for Menu and MenuItem (including DOM-based events such as "mouseover" or "click") are implemented as instances of Custom Event (`YAHOO.util.CustomEvent`). Please note: To listen for DOM-based events always use the provided Custom Event-based interface rather than attaching handlers directly to a Menu's DOM elements.

Add event listeners through the `subscribe` method. The following example demonstrates how to subscribe to the "show" and "hide" events:

/* Generic event handler used to log info about the DOM events for the Menu instance. */ function onMenuEvent(p_sType, p_aArgs) { var oDOMEvent = p_aArgs[0]; YAHOO.log(("Id: " + this.id + ", " + "Custom Event Type: " + p_sType + ", " + "DOM Event Type: " + oDOMEvent.type), "info", "example10"); } /* Generic event handler used to log info about the DOM events for each MenuItem instance. */ function onMenuItemEvent(p_sType, p_aArgs) { var oDOMEvent = p_aArgs[0]; YAHOO.log(("Index: " + this.index + ", " + "Group Index: " + this.groupIndex + ", " + "Custom Event Type: " + p_sType + ", " + "DOM Event Type: " + oDOMEvent.type ), "info", "example10"); } /* Instantiate a Menu: The first argument passed to the constructor is the id of the element in the page representing the Menu; the second is an object literal of configuration properties. */ var oMenu = new YAHOO.widget.Menu("basicmenu", { fixedcenter: true }); // Subscribe to the Menu instance's "itemAdded" event oMenu.subscribe("itemAdded", function (p_sType, p_aArgs) { var oMenuItem = p_aArgs[0]; /* Subscribe to each MenuItem instance's DOM events as they are added to the Menu instance. */ oMenuItem.subscribe("mouseover", onMenuItemEvent); oMenuItem.subscribe("mouseout", onMenuItemEvent); oMenuItem.subscribe("mousedown", onMenuItemEvent); oMenuItem.subscribe("mouseup", onMenuItemEvent); oMenuItem.subscribe("click", onMenuItemEvent); oMenuItem.subscribe("keydown", onMenuItemEvent); oMenuItem.subscribe("keyup", onMenuItemEvent); oMenuItem.subscribe("keypress", onMenuItemEvent); }); // Subscribe to every DOM event for the Menu instance. oMenu.subscribe("mouseover", onMenuEvent); oMenu.subscribe("mouseout", onMenuEvent); oMenu.subscribe("mousedown", onMenuEvent); oMenu.subscribe("mouseup", onMenuEvent); oMenu.subscribe("click", onMenuEvent); oMenu.subscribe("keydown", onMenuEvent); oMenu.subscribe("keyup", onMenuEvent); oMenu.subscribe("keypress", onMenuEvent); /* Add items to the Menu instance by passing an array of object literals (each of which represents a set of YAHOO.widget.MenuItem configuration properties) to the "addItems" method. */ oMenu.addItems([ "MenuItem 0", "MenuItem 1", /* Add a disabled menu item to demonstrate that disabled items do not respond to DOM events. */ { text: "MenuItem 2", disabled: true }, "MenuItem 3", "MenuItem 4" ]); /* Since this Menu instance is built completely from script, call the "render" method passing in the DOM element that it should be appended to. */ oMenu.render("rendertarget");

### YUI Logger Output:

### Menu Family Examples:

- Basic Menu From Markup
- Basic Menu From JavaScript
- Grouped Menu Items Using Markup
- Grouped Menu Items Using JavaScript
- Grouped Menu Items With Titles From Markup
- Grouped Menu Items With Titles From JavaScript
- Multi-tiered Menu From Markup
- Multi-tiered Menu From JavaScript
- Handling Menu Click Events
- Listening For Menu Events
- MenuItem Configuration Properties
- Setting Menu Configuration Properties At Runtime
- Website Left Nav With Submenus Built From Markup
- Website Left Nav With Submenus From JavaScript
- Website Top Nav With Submenus Built From Markup
- Website Top Nav With Submenus From JavaScript
- Website Left Nav Using Animation With Submenus Built From Markup
- Website Left Nav Using Animation With Submenus From JavaScript
- Website Top Nav Using Animation With Submenus Built From Markup
- Website Top Nav Using Animation With Submenus From JavaScript
- Context Menu
- Adding A Context Menu To A Table
- Adding A Context Menu To A TreeView
- OS-Style Programs Menu
- Application Menubar
- Implementing ARIA Roles and States with Menu
- Context Menu Integration (included with examples for DataTable Control (beta))
- Menu Buttons (included with examples for Button Control)
- Split Buttons (included with examples for Button Control)
- Color Picker Button (included with examples for Button Control)
- Fixed Width Menu Button (included with examples for Button Control)
- Slider Button (included with examples for Button Control)
- Using the ProfilerViewer API while Profiling the YUI Menu Control (included with examples for ProfilerViewer Control (beta))

### More Menu Family Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2008 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings