blessed-tab-container
Version:
A CLI Multi-Tab Container Utilizing Labels For Blessed
104 lines (71 loc) • 3.34 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>types/blessed_tab_container_args.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<input type="text" id="nav-search" placeholder="Search" />
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#BlessedTabContainer">BlessedTabContainer</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">types/blessed_tab_container_args.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict'
require('../types/blessed_tab_container_tab_config')
/**
* Verifies arguments for BlesssedTabContainer
*
* @typedef BlessedTabContainerArgs
* @property {object} screen - blessed screen instance
* @property {string} [defaultVisible] - label visible by default, must exist
* as a tab label. Uniqueness not enforced.
* @property {string} [tabSeperator] - seperater rendered between tab labels
* @property {number} [tabPadding] - number of chars to pad with on either
* side of the seperator. Default 1
* @property {string} [tabPaddingChar] - character used to pad labels, not
* colored. Defaults to a single space, and appears on either side of each
* seperator.
* @property {string[]} [autoDirtyUpdateFunctions] - array of function names
* that should be wrapped to automatically set the dirty flag on a tab. i.e.
* ['pushLine', 'setContent', ...]
* @property {Function} [inactiveColorFunc] - color function for inactive tab
* @property {Function} [activeColorFunc] - color function for active tab
* @property {Function} [dirtyColorFunc] - color function for dirty tab,
* applied to active/inactive color function output
* @property {Function} [cleanColorFunc] - color function for clean tab,
* applied to active/inactive color function output
* @property {BlessedTabContainerTabState[]} [tabs] - array of tab objects
* @property {object} [elementOptions] - configuration object passed to tabFunc
* if needed; if provided, should be valid for the desired blessed element.
*/
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Mar 31 2020 19:20:06 GMT+0700 (Indochina Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/search.js" defer></script>
</body>
</html>