yy-menu
Version:
A traditional menu system for web apps inspired by Electron
669 lines (279 loc) • 13.5 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>yy-menu API Documentation</title>
<meta name="description" content="Documentation for yy-menu library" />
<meta name="keywords" content="menu,system,UI,accelerators,Electron,file menu,web app" />
<meta name="keyword" content="menu,system,UI,accelerators,Electron,file menu,web app" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<script src="scripts/jquery.min.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=Libre+Franklin:400,700" rel="stylesheet">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/main.css">
<script>
var config = {"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles":true},"applicationName":"yy-menu","footer":"by YOPEY YOPEY LLC (yopeyopey.com)","copyright":"Copyright © 2018 YOPEY YOPEY LLC.","meta":{"title":"yy-menu API Documentation","description":"Documentation for yy-menu library","keyword":["menu","system","UI","accelerators","Electron","file menu","web app"]},"matomo":{"url":"https://analytics.yopeyopey.com/piwik/","id":18}};
</script>
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.yopeyopey.com/piwik/";
_paq.push(['setTrackerUrl', u+'piwik.php']);
_paq.push(['setSiteId', '18']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
})();
</script>
</head>
<body>
<div id="wrap" class="clearfix">
<div class="navigation">
<h3 class="applicationName"><a href="index.html">yy-menu</a></h3>
<button id="menuToggle" class="btn btn-link btn-lg menu-toggle">
<span class="glyphicon glyphicon-menu-hamburger"></span>
</button>
<div class="search">
<input id="search" type="text" class="form-control input-md" placeholder="Search...">
</div>
<ul class="list">
<li class="item" data-name="global">
<span class="title namespace ">
<span class="namespaceTag">
<span class="glyphicon glyphicon-globe"></span>
</span>
<a href="global.html">Global</a>
</span>
<ul class="members itemMembers">
<span class="subtitle">Members</span>
<li class="parent " data-name="LocalAccelerator"><a href="global.html#LocalAccelerator">LocalAccelerator</a></li>
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Menu">
<span class="title ">
<a href="Menu.html">Menu</a>
</span>
<ul class="members itemMembers">
<span class="subtitle">Members</span>
<li class="parent " data-name="Menu.Config"><a href="Menu.html#.Config">Config</a></li>
<li class="parent " data-name="Menu.LocalAccelerator"><a href="Menu.html#.LocalAccelerator">LocalAccelerator</a></li>
<li class="parent " data-name="Menu.MenuItem"><a href="Menu.html#.MenuItem">MenuItem</a></li>
<li class="parent " data-name="Menu#items"><a href="Menu.html#items">items</a></li>
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li class="parent " data-name="Menu.setApplicationMenu"><a href="Menu.html#.setApplicationMenu">setApplicationMenu</a></li>
<li class="parent " data-name="Menu#append"><a href="Menu.html#append">append</a></li>
<li class="parent " data-name="Menu#insert"><a href="Menu.html#insert">insert</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="MenuItem">
<span class="title ">
<a href="MenuItem.html">MenuItem</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
<span class="subtitle">Typedefs</span>
<li class="parent" data-name="MenuItem~ClickCallback"><a href="MenuItem.html#~ClickCallback">ClickCallback</a></li>
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
</ul>
</div>
<div class="main">
<h1 class="page-title" data-filename="Viewport">Class: MenuItem</h1>
<section>
<header>
<div class="header content-size">
<h2>MenuItem
</h2>
</div>
</header>
<article class="content-size">
<div class="container-overview">
<dt>
<div class="nameContainer">
<h4 class="name" id="MenuItem">
<a class="share-icon" href="#MenuItem"><span class="glyphicon glyphicon-link"></span></a>
<span class="">
new MenuItem
</span>
<span class="signature">(options)</span>
</h4>
<div class="tag-source">
<a href="menuItem.js.html#line16">menuItem.js:16</a>
</div>
</div>
</dt>
<dd>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>label</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>label for menu entry may include accelerator by placing & before letter)</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>separator, checkbox, or undefined</p></td>
</tr>
<tr>
<td class="name"><code>styles</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>additional CSS styles to apply to this MenuItem</p></td>
</tr>
<tr>
<td class="name"><code>accelerator</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>see Accelerator for inputs (e.g., ctrl+shift+A)</p></td>
</tr>
<tr>
<td class="name"><code>submenu</code></td>
<td class="type">
<span class="param-type"><a href="MenuItem.html">MenuItem</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>attaches a submenu (and changes type to submenu)</p></td>
</tr>
<tr>
<td class="name"><code>checked</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">
<span class="optional">optional</span>
<p>check the checkbox</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<dl class="list-definitions">
<dt>
<div class="nameContainer">
<h4 class="name" id="~ClickCallback">
<a class="share-icon" href="#~ClickCallback"><span class="glyphicon glyphicon-link"></span></a>
<span class="">
ClickCallback
</span>
<span class="signature">(e)</span>
</h4>
<div class="tag-source">
<a href="menuItem.js.html#line49">menuItem.js:49</a>
</div>
</div>
</dt>
<dd>
<div class="description">
<p>The click callback</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">InputEvent</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
<footer class="content-size">
<div class="footer">
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 19 2018 11:19:02 GMT+0800 (DST)
</div>
</footer>
</div>
</div>
<script>prettyPrint();</script>
<script src="scripts/main.js"></script>
</body>
</html>