|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: node-menunav (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>node-menunav <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_node-menunav.html" title="node-menunav">node-menunav</a> |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
|
|
|
47 |
<h3>Module: node-menunav |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
</h3> |
|
|
52 |
<div class="description summary"> |
|
|
53 |
<p>The MenuNav Node Plugin makes it easy to transform existing list-based |
|
|
54 |
markup into traditional, drop down navigational menus that are both accessible |
|
|
55 |
and easy to customize, and only require a small set of dependencies.</p> |
|
|
56 |
<p>To use the MenuNav Node Plugin, simply pass a reference to the plugin to a |
|
|
57 |
Node instance's <code>plug</code> method.</p> |
|
|
58 |
<p> |
|
|
59 |
<code> |
|
|
60 |
<script type="text/javascript"> <br> |
|
|
61 |
<br> |
|
|
62 |
// Call the "use" method, passing in "node-menunav". This will <br> |
|
|
63 |
// load the script and CSS for the MenuNav Node Plugin and all of <br> |
|
|
64 |
// the required dependencies. <br> |
|
|
65 |
<br> |
|
|
66 |
YUI().use("node-menunav", function(Y) { <br> |
|
|
67 |
<br> |
|
|
68 |
// Use the "contentready" event to initialize the menu when <br> |
|
|
69 |
// the subtree of element representing the root menu <br> |
|
|
70 |
// (<div id="menu-1">) is ready to be scripted. <br> |
|
|
71 |
<br> |
|
|
72 |
Y.on("contentready", function () { <br> |
|
|
73 |
<br> |
|
|
74 |
// The scope of the callback will be a Node instance <br> |
|
|
75 |
// representing the root menu (<div id="menu-1">). <br> |
|
|
76 |
// Therefore, since "this" represents a Node instance, it <br> |
|
|
77 |
// is possible to just call "this.plug" passing in a <br> |
|
|
78 |
// reference to the MenuNav Node Plugin. <br> |
|
|
79 |
<br> |
|
|
80 |
this.plug(Y.Plugin.NodeMenuNav); <br> |
|
|
81 |
<br> |
|
|
82 |
}, "#menu-1"); <br> |
|
|
83 |
<br> |
|
|
84 |
}); <br> |
|
|
85 |
<br> |
|
|
86 |
</script> <br> |
|
|
87 |
</code> |
|
|
88 |
</p> |
|
|
89 |
<p>The MenuNav Node Plugin has several configuration properties that can be |
|
|
90 |
set via an object literal that is passed as a second argument to a Node |
|
|
91 |
instance's <code>plug</code> method. |
|
|
92 |
</p> |
|
|
93 |
<p> |
|
|
94 |
<code> |
|
|
95 |
<script type="text/javascript"> <br> |
|
|
96 |
<br> |
|
|
97 |
// Call the "use" method, passing in "node-menunav". This will <br> |
|
|
98 |
// load the script and CSS for the MenuNav Node Plugin and all of <br> |
|
|
99 |
// the required dependencies. <br> |
|
|
100 |
<br> |
|
|
101 |
YUI().use("node-menunav", function(Y) { <br> |
|
|
102 |
<br> |
|
|
103 |
// Use the "contentready" event to initialize the menu when <br> |
|
|
104 |
// the subtree of element representing the root menu <br> |
|
|
105 |
// (<div id="menu-1">) is ready to be scripted. <br> |
|
|
106 |
<br> |
|
|
107 |
Y.on("contentready", function () { <br> |
|
|
108 |
<br> |
|
|
109 |
// The scope of the callback will be a Node instance <br> |
|
|
110 |
// representing the root menu (<div id="menu-1">). <br> |
|
|
111 |
// Therefore, since "this" represents a Node instance, it <br> |
|
|
112 |
// is possible to just call "this.plug" passing in a <br> |
|
|
113 |
// reference to the MenuNav Node Plugin. <br> |
|
|
114 |
<br> |
|
|
115 |
this.plug(Y.Plugin.NodeMenuNav, { mouseOutHideDelay: 1000 }); |
|
|
116 |
<br><br> |
|
|
117 |
}, "#menu-1"); <br> |
|
|
118 |
<br> |
|
|
119 |
}); <br> |
|
|
120 |
<br> |
|
|
121 |
</script> <br> |
|
|
122 |
</code> |
|
|
123 |
</p> |
|
|
124 |
</div> |
|
|
125 |
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
<div class="yui-gc"> |
|
|
129 |
<div class="yui-u first"> |
|
|
130 |
|
|
|
131 |
<p>This module contains the following classes:</p> |
|
|
132 |
<script> |
|
|
133 |
//var YUI_CLASS_LIST = [{"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "The NodeMenuNav class is a plugin for a Node instance. The class is used via \nthe <a href=\"Node.html#method_plug\"><code>plug</code></a> method of Node and \nshould not be instantiated directly.", "guessedname": "plugin.NodeMenuNav", "name": "plugin.NodeMenuNav"}]; |
|
|
134 |
</script> |
|
|
135 |
<div id="splash_classList"> |
|
|
136 |
<ul> |
|
|
137 |
<li><a href="plugin.NodeMenuNav.html" title="plugin.NodeMenuNav" id="class_0">plugin.NodeMenuNav</a></li> |
|
|
138 |
</ul> |
|
|
139 |
</div> |
|
|
140 |
</div> |
|
|
141 |
<div class="yui-u"> |
|
|
142 |
|
|
|
143 |
</div> |
|
|
144 |
</div> |
|
|
145 |
|
|
|
146 |
</div> |
|
|
147 |
</div> |
|
|
148 |
<div class="yui-b"> |
|
|
149 |
<div class="nav"> |
|
|
150 |
|
|
|
151 |
<div id="moduleList" class="module"> |
|
|
152 |
<h4>Modules</h4> |
|
|
153 |
<ul class="content"> |
|
|
154 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
155 |
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
156 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
157 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
158 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
159 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
160 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
161 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
162 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
163 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
164 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
165 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
166 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
167 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
168 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
169 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
170 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
171 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
172 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
173 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
174 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
175 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
176 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
177 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
178 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
179 |
<li class="selected"><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
180 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
181 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
182 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
183 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
184 |
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
|
185 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
186 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
187 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
188 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
189 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
190 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
191 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
192 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
193 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
194 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
195 |
</ul> |
|
|
196 |
</div> |
|
|
197 |
|
|
|
198 |
<div id="classList" class="module"> |
|
|
199 |
<h4>Classes</h4> |
|
|
200 |
<ul class="content"> |
|
|
201 |
<li class=""><a href="plugin.NodeMenuNav.html" title="plugin.NodeMenuNav">plugin.NodeMenuNav</a></li> |
|
|
202 |
</ul> |
|
|
203 |
</div> |
|
|
204 |
|
|
|
205 |
<div id="fileList" class="module"> |
|
|
206 |
<h4>Files</h4> |
|
|
207 |
<ul class="content"> |
|
|
208 |
<li class=""><a href="node-menunav.js.html" title="node-menunav.js">node-menunav.js</a></li> |
|
|
209 |
</ul> |
|
|
210 |
</div> |
|
|
211 |
|
|
|
212 |
|
|
|
213 |
|
|
|
214 |
|
|
|
215 |
|
|
|
216 |
</div> |
|
|
217 |
</div> |
|
|
218 |
</div> |
|
|
219 |
<div id="ft"> |
|
|
220 |
<hr /> |
|
|
221 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
222 |
</div> |
|
|
223 |
</div> |
|
|
224 |
<script type="text/javascript"> |
|
|
225 |
ALL_YUI_PROPS = [{"access": "protected", "host": "plugin.NodeMenuNav", "name": "_activeItem", "url": "plugin.NodeMenuNav.html#property__activeItem", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_activeMenu", "url": "plugin.NodeMenuNav.html#property__activeMenu", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_afterActiveDescendantChange", "url": "plugin.NodeMenuNav.html#method__afterActiveDescendantChange", "type": "method"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "autoSubmenuDisplay", "url": "plugin.NodeMenuNav.html#config_autoSubmenuDisplay", "type": "config"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "autoSubmenuDisplayChange", "url": "plugin.NodeMenuNav.html#event_autoSubmenuDisplayChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_blockMouseEvent", "url": "plugin.NodeMenuNav.html#property__blockMouseEvent", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_cancelHideSubmenuTimer", "url": "plugin.NodeMenuNav.html#method__cancelHideSubmenuTimer", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_cancelShowSubmenuTimer", "url": "plugin.NodeMenuNav.html#method__cancelShowSubmenuTimer", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_clearActiveItem", "url": "plugin.NodeMenuNav.html#method__clearActiveItem", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_currentMouseX", "url": "plugin.NodeMenuNav.html#property__currentMouseX", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_firstItem", "url": "plugin.NodeMenuNav.html#property__firstItem", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_focusItem", "url": "plugin.NodeMenuNav.html#method__focusItem", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_getTopmostSubmenu", "url": "plugin.NodeMenuNav.html#method__getTopmostSubmenu", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hasFocus", "url": "plugin.NodeMenuNav.html#property__hasFocus", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hideAllSubmenus", "url": "plugin.NodeMenuNav.html#method__hideAllSubmenus", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hideAllSubmenusTimer", "url": "plugin.NodeMenuNav.html#property__hideAllSubmenusTimer", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hideAndFocusLabel", "url": "plugin.NodeMenuNav.html#method__hideAndFocusLabel", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hideMenu", "url": "plugin.NodeMenuNav.html#method__hideMenu", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_hideSubmenuTimer", "url": "plugin.NodeMenuNav.html#property__hideSubmenuTimer", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_initFocusManager", "url": "plugin.NodeMenuNav.html#method__initFocusManager", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_isRoot", "url": "plugin.NodeMenuNav.html#method__isRoot", "type": "method"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "mouseOutHideDelay", "url": "plugin.NodeMenuNav.html#config_mouseOutHideDelay", "type": "config"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "mouseOutHideDelayChange", "url": "plugin.NodeMenuNav.html#event_mouseOutHideDelayChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_movingToSubmenu", "url": "plugin.NodeMenuNav.html#property__movingToSubmenu", "type": "property"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "NodeMenuNav.SHIM_TEMPLATE", "url": "plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE", "type": "property"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "NodeMenuNav.SHIM_TEMPLATE_TITLE", "url": "plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE_TITLE", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onActiveDescendantChange", "url": "plugin.NodeMenuNav.html#method__onActiveDescendantChange", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onDocFocus", "url": "plugin.NodeMenuNav.html#method__onDocFocus", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onDocMouseDown", "url": "plugin.NodeMenuNav.html#method__onDocMouseDown", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onHorizontalMenuKeyDown", "url": "plugin.NodeMenuNav.html#method__onHorizontalMenuKeyDown", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onKeyDown", "url": "plugin.NodeMenuNav.html#method__onKeyDown", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onKeyPress", "url": "plugin.NodeMenuNav.html#method__onKeyPress", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuItemMouseOut", "url": "plugin.NodeMenuNav.html#method__onMenuItemMouseOut", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuItemMouseOver", "url": "plugin.NodeMenuNav.html#method__onMenuItemMouseOver", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuLabelMouseOut", "url": "plugin.NodeMenuNav.html#method__onMenuLabelMouseOut", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuLabelMouseOver", "url": "plugin.NodeMenuNav.html#method__onMenuLabelMouseOver", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuMouseOut", "url": "plugin.NodeMenuNav.html#method__onMenuMouseOut", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMenuMouseOver", "url": "plugin.NodeMenuNav.html#method__onMenuMouseOver", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMouseMove", "url": "plugin.NodeMenuNav.html#method__onMouseMove", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMouseOut", "url": "plugin.NodeMenuNav.html#method__onMouseOut", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onMouseOver", "url": "plugin.NodeMenuNav.html#method__onMouseOver", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_onVerticalMenuKeyDown", "url": "plugin.NodeMenuNav.html#method__onVerticalMenuKeyDown", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_rootMenu", "url": "plugin.NodeMenuNav.html#property__rootMenu", "type": "property"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_setActiveItem", "url": "plugin.NodeMenuNav.html#method__setActiveItem", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_showMenu", "url": "plugin.NodeMenuNav.html#method__showMenu", "type": "method"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_showSubmenuTimer", "url": "plugin.NodeMenuNav.html#property__showSubmenuTimer", "type": "property"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "submenuHideDelay", "url": "plugin.NodeMenuNav.html#config_submenuHideDelay", "type": "config"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "submenuHideDelayChange", "url": "plugin.NodeMenuNav.html#event_submenuHideDelayChange", "type": "event"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "submenuShowDelay", "url": "plugin.NodeMenuNav.html#config_submenuShowDelay", "type": "config"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "submenuShowDelayChange", "url": "plugin.NodeMenuNav.html#event_submenuShowDelayChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeMenuNav", "name": "_toggleSubmenuDisplay", "url": "plugin.NodeMenuNav.html#method__toggleSubmenuDisplay", "type": "method"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "useARIA", "url": "plugin.NodeMenuNav.html#config_useARIA", "type": "config"}, {"access": "", "host": "plugin.NodeMenuNav", "name": "useARIAChange", "url": "plugin.NodeMenuNav.html#event_useARIAChange", "type": "event"}]; |
|
|
226 |
</script> |
|
|
227 |
</body> |
|
|
228 |
</html> |