API Docs for: 3.18.1

plugin.NodeMenuNav Class

Defined in: node-menunav/js/node-menunav.js:348
Module: node-menunav

The NodeMenuNav class is a plugin for a Node instance. The class is used via the plug method of Node and should not be instantiated directly.

Methods

Properties

SHIM_TEMPLATE

String

Defined in node-menunav/js/node-menunav.js:376

String representing the HTML used to create the <iframe> shim used to prevent <select> elements from poking through menus in IE 6.

Default: &#34;&#60;iframe frameborder=&#34;0&#34; tabindex=&#34;-1&#34; class=&#34;yui-shim&#34; title=&#34;Menu Stacking Shim&#34; src=&#34;javascript:false;&#34;&#62;&#60;/iframe&#62;&#34;

SHIM_TEMPLATE_TITLE

String

Defined in node-menunav/js/node-menunav.js:365

String representing the value for the title attribute for the shim used to prevent <select> elements from poking through menus in IE 6.

Default: "Menu Stacking Shim"

Attributes

autoSubmenuDisplay

Boolean readonly

Defined in node-menunav/js/node-menunav.js:487

Boolean indicating if submenus are automatically made visible when the user mouses over the menu's items.

Default: true

Fires event autoSubmenuDisplayChange

Fires when the value for the configuration attribute autoSubmenuDisplay is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

mouseOutHideDelay

Number readonly

Defined in node-menunav/js/node-menunav.js:542

Number indicating the time (in milliseconds) that should expire before a submenu is hidden when the user mouses out of it.

Default: 750

Fires event mouseOutHideDelayChange

Fires when the value for the configuration attribute mouseOutHideDelay is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

submenuHideDelay

Number readonly

Defined in node-menunav/js/node-menunav.js:523

Number indicating the time (in milliseconds) that should expire before a submenu is hidden when the user mouses out of a menu label heading in the direction of a submenu.

Default: 250

Fires event submenuHideDelayChange

Fires when the value for the configuration attribute submenuHideDelay is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

submenuShowDelay

Number readonly

Defined in node-menunav/js/node-menunav.js:505

Number indicating the time (in milliseconds) that should expire before a submenu is made visible when the user mouses over the menu's label.

Default: 250

Fires event submenuShowDelayChange

Fires when the value for the configuration attribute submenuShowDelay is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

useARIA

Boolean readonly

Defined in node-menunav/js/node-menunav.js:410

Boolean indicating if use of the WAI-ARIA Roles and States should be enabled for the menu.

Default: true

Fires event useARIAChange

Fires when the value for the configuration attribute useARIA is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.