yy-menu
Version:
A traditional menu system for web apps inspired by Electron
293 lines (226 loc) • 8.2 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#Menu">
<span class="title ">
<a href="Menu_Menu.html">Menu#Menu</a>
</span>
<ul class="members itemMembers">
</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="MenuItem#MenuItem">
<span class="title ">
<a href="MenuItem_MenuItem.html">MenuItem#MenuItem</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</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">Source: config.js</h1>
<section>
<header>
<div class="header content-size">
<h2>config.js</h2>
</div>
</header>
<article>
<pre id="source-code" class="prettyprint source "><code>export const config = {
/**
* application menu container styles
* @type {object}
*/
ApplicationContainerStyle: {
'z-index': 999999,
'position': 'absolute',
'top': 0,
'left': 0,
'user-select': 'none',
'font-size': '0.85em'
},
/**
* application menu-bar styles
* @type {object}
*/
ApplicationMenuStyle: {
'display': 'flex',
'position': 'relative',
'flex-direction': 'row',
'color': 'black',
'backgroundColor': 'rgb(230,230,230)',
'width': '100vw',
'border': 'none',
'box-shadow': 'unset',
'outline': 'none'
},
/**
* application menu entry styles
* @type {object}
*/
ApplicationMenuRowStyle: {
'padding': '0.25em 0.5em',
'margin': 0,
'line-height': '1em'
},
/**
* lower-level menu window styles
* @type {object}
*/
MenuStyle: {
'flex-direction': 'column',
'position': 'absolute',
'user-select': 'none',
'color': 'black',
'z-index': 999999,
'backgroundColor': 'white',
'border': '1px solid rgba(0,0,0,0.5)',
'boxShadow': '1px 3px 3px rgba(0,0,0,0.25)'
},
/**
* lower-level menu row styles
* @type {object}
*/
RowStyle: {
'display': 'flex',
'padding': '0.25em 1.5em 0.25em',
'line-height': '1.5em'
},
/**
* lower-level menu accelerator styles
* @type {object}
*/
AcceleratorStyle: {
'opacity': 0.5
},
/**
* lower-level menu separator styles
* @type {object}
*/
SeparatorStyle: {
'border-bottom': '1px solid rgba(0,0,0,0.1)',
'margin': '0.5em 0'
},
/**
* accelerator key styles
* NOTE: accelerator keys must use text-decoration as its used as a toggle in the code
* @type {object}
*/
AcceleratorKeyStyle: {
'text-decoration': 'underline',
'text-decoration-color': 'rgba(0,0,0,0.5)'
},
/**
* minimum column width in pixels for checked and arrow in the lower-level menus
* @type {number}
*/
MinimumColumnWidth: 20,
/**
* CSS background style for selected MenuItems
* NOTE: unselected have 'transparent' style
* @type {string}
*/
SelectedBackgroundStyle: 'rgba(0,0,0,0.1)',
/**
* number of pixels to overlap child menus
* @type {number}
*/
Overlap: 5,
/**
* time in milliseconds to wait for submenu to open when mouse hovers
* @param {number}
*/
SubmenuOpenDelay: 500
}</code></pre>
</article>
</section>
<footer class="content-size">
<div class="footer">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Wed Dec 23 2020 11:20:22 GMT+0800 (Taipei Standard Time)
</div>
</footer>
</div>
</div>
<script>prettyPrint();</script>
<script src="scripts/main.js"></script>
</body>
</html>