jsdk-offical
Version:
JSDK is the most comprehensive TypeScript framework, like JDK.
411 lines • 18.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ToastConfig | JSDK 2.7.0 API</title>
<meta name="description" content="Documentation for JSDK 2.7.0 API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">JSDK 2.7.0 API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/js.html">JS</a>
</li>
<li>
<a href="../modules/js.fx.html">fx</a>
</li>
<li>
<a href="js.fx.toastconfig.html">ToastConfig</a>
</li>
</ul>
<h1>Class ToastConfig</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ToastConfig</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#closebutton" class="tsd-kind-icon">close<wbr>Button</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#cls" class="tsd-kind-icon">cls</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#htmlable" class="tsd-kind-icon">htmlable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#listeners" class="tsd-kind-icon">listeners</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#newestontop" class="tsd-kind-icon">newest<wbr>OnTop</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#place" class="tsd-kind-icon">place</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#progressbar" class="tsd-kind-icon">progress<wbr>Bar</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#rtl" class="tsd-kind-icon">rtl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#timeout" class="tsd-kind-icon">timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.toastconfig.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="closebutton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr>Button</h3>
<div class="tsd-signature tsd-kind-icon">close<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should a close button be shown?</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="cls" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cls</h3>
<div class="tsd-signature tsd-kind-icon">cls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS class the toast element will be given.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="htmlable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> htmlable</h3>
<div class="tsd-signature tsd-kind-icon">htmlable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should the title and message text be escaped?</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="listeners" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> listeners</h3>
<div class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">:</span> <a href="../interfaces/js.fx.toastlisteners.html" class="tsd-signature-type">ToastListeners</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="newestontop" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> newest<wbr>OnTop</h3>
<div class="tsd-signature tsd-kind-icon">newest<wbr>OnTop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set newest toast to appear on top.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="place" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> place</h3>
<div class="tsd-signature tsd-kind-icon">place<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"lt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lb"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ct"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cb"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rb"</span><span class="tsd-signature-symbol"> = "ct"</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Where toast should be displayed.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>'ct'</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="progressbar" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> progress<wbr>Bar</h3>
<div class="tsd-signature tsd-kind-icon">progress<wbr>Bar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Visually indicates how long before a toast expires.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="rtl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> rtl</h3>
<div class="tsd-signature tsd-kind-icon">rtl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Flip the toastr to be displayed properly for right-to-left languages.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time in milliseconds that the toast should be displayed.
Set timeOut to 0 to make it will persist until selected.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>5000</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="title" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/js.fx.html#toasttype" class="tsd-signature-type">ToastType</a><span class="tsd-signature-symbol"> = "info"</span></div>
<aside class="tsd-sources">
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/js.html">JS</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.an.html">an</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.app.html">app</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.core.html">core</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.d2.html">d2</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ds.html">ds</a>
</li>
<li class="current tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.fx.html">fx</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.input.html">input</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ioc.html">ioc</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.lang.html">lang</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.math.html">math</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.media.html">media</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.model.html">model</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.net.html">net</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.store.html">store</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.sugar.html">sugar</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ui.html">ui</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.unit.html">unit</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.util.html">util</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.view.html">view</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="js.fx.toastconfig.html" class="tsd-kind-icon">Toast<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#closebutton" class="tsd-kind-icon">close<wbr>Button</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#cls" class="tsd-kind-icon">cls</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#htmlable" class="tsd-kind-icon">htmlable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#listeners" class="tsd-kind-icon">listeners</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#newestontop" class="tsd-kind-icon">newest<wbr>OnTop</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#place" class="tsd-kind-icon">place</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#progressbar" class="tsd-kind-icon">progress<wbr>Bar</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#rtl" class="tsd-kind-icon">rtl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#timeout" class="tsd-kind-icon">timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#title" class="tsd-kind-icon">title</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="js.fx.toastconfig.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>