docs/classes/_styleprovider_.styleprovider.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StyleProvider | style-provider - v0.1.2</title>
<meta name="description" content="">
<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.js" 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">style-provider - v0.1.2</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/_styleprovider_.html">"StyleProvider"</a>
</li>
<li>
<a href="_styleprovider_.styleprovider.html">StyleProvider</a>
</li>
</ul>
<h1>Class StyleProvider<T, R></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct your own style provider with a custom fallback style object</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span></h4>
</li>
<li>
<h4>R</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">StyleProvider</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_styleprovider_.styleprovider.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#converter" class="tsd-kind-icon">converter</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#fallback" class="tsd-kind-icon">fallback</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#mount" class="tsd-kind-icon">mount</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#renderall" class="tsd-kind-icon">render<wbr>All</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#rendered" class="tsd-kind-icon">rendered</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#renderedall" class="tsd-kind-icon">rendered<wbr>All</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#renderedfallback" class="tsd-kind-icon">rendered<wbr>Fallback</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#dashcase" class="tsd-kind-icon">dash<wbr>Case</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#fields" class="tsd-kind-icon">fields</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#generate" class="tsd-kind-icon">generate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="_styleprovider_.styleprovider.html#parser" class="tsd-kind-icon">parser</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_styleprovider_.styleprovider.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_styleprovider_.styleprovider.html#rootstyleprovider" class="tsd-kind-icon">root<wbr>Style<wbr>Provider</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_styleprovider_.styleprovider.html#styleprovider" class="tsd-kind-icon">style<wbr>Provider</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Style<wbr>Provider<span class="tsd-signature-symbol">(</span>fallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, converter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_styleprovider_.styleprovideroptions.html" class="tsd-signature-type">StyleProviderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_styleprovider_.styleprovider.html" class="tsd-signature-type">StyleProvider</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L40">StyleProvider.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fallback: <span class="tsd-signature-type">T</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> converter: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/_styleprovider_.styleprovideroptions.html" class="tsd-signature-type">StyleProviderOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_styleprovider_.styleprovider.html" class="tsd-signature-type">StyleProvider</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="converter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> converter</h3>
<div class="tsd-signature tsd-kind-icon">converter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L31">StyleProvider.ts:31</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>css<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>css: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="fallback" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> fallback</h3>
<div class="tsd-signature tsd-kind-icon">fallback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L33">StyleProvider.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="mount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> mount</h3>
<div class="tsd-signature tsd-kind-icon">mount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L36">StyleProvider.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="renderall" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> render<wbr>All</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>All<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L37">StyleProvider.ts:37</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="rendered" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> rendered</h3>
<div class="tsd-signature tsd-kind-icon">rendered<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L39">StyleProvider.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="renderedall" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> rendered<wbr>All</h3>
<div class="tsd-signature tsd-kind-icon">rendered<wbr>All<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L40">StyleProvider.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="renderedfallback" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> rendered<wbr>Fallback</h3>
<div class="tsd-signature tsd-kind-icon">rendered<wbr>Fallback<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_styleprovider_.renderresult.html" class="tsd-signature-type">RenderResult</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L34">StyleProvider.ts:34</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="dashcase" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> dash<wbr>Case</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">dash<wbr>Case<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L142">StyleProvider.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert PascalCase / camelCase to dash-case</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="fields" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> fields</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">(</span>fallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, custom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L93">StyleProvider.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert two arrays of fields to a final field resolver CSS string</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fallback: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>custom: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="generate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> generate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">: </span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, renderAll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L72">StyleProvider.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate a CSS string from a styles object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>styles: <a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>renderAll: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
<a name="parser" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> parser</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">parser<S><span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/_styleprovider_.styleobjecttype.html" class="tsd-signature-type">StyleObjectType</a>, prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_styleprovider_.parserresult.html" class="tsd-signature-type">ParserResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L114">StyleProvider.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return an array of CSS vars and a list of created vars from a styles object</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>S<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>styles: <span class="tsd-signature-type">S</span></h5>
</li>
<li>
<h5>type: <a href="../enums/_styleprovider_.styleobjecttype.html" class="tsd-signature-type">StyleObjectType</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_styleprovider_.parserresult.html" class="tsd-signature-type">ParserResult</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="render" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">: </span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/_styleprovider_.styleobjecttype.html" class="tsd-signature-type">StyleObjectType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_styleprovider_.renderresult.html" class="tsd-signature-type">RenderResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L102">StyleProvider.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a string of CSS vars and a list of created vars from a styles object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>styles: <a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>type: <a href="../enums/_styleprovider_.styleobjecttype.html" class="tsd-signature-type">StyleObjectType</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_styleprovider_.renderresult.html" class="tsd-signature-type">RenderResult</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rootstyleprovider" class="tsd-anchor"></a>
<h3>root<wbr>Style<wbr>Provider</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">root<wbr>Style<wbr>Provider<span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">?: </span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L52">StyleProvider.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate the root CSS string from a styles object if no cached version is found</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> styles: <a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="styleprovider" class="tsd-anchor"></a>
<h3>style<wbr>Provider</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">style<wbr>Provider<span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">?: </span><a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, renderAll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/style-provider/blob/ac8e7c6/lib/StyleProvider.ts#L59">StyleProvider.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate a CSS string from a styles object if no cached version is found</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> styles: <a href="../modules/_styleprovider_.html#deeppartial" class="tsd-signature-type">DeepPartial</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = emptyStyles</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> renderAll: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = this.renderAll</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R</span></h4>
</li>
</ul>
</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-external-module">
<a href="../modules/_styleprovider_.html">"<wbr>Style<wbr>Provider"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_defaultstyleprovider_.html">"default<wbr>Style<wbr>Provider"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_defaultstyles_.html">"default<wbr>Styles"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_materialdesign_.html">"material<wbr>Design"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../enums/_styleprovider_.styleobjecttype.html" class="tsd-kind-icon">Style<wbr>Object<wbr>Type</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_styleprovider_.styleprovider.html" class="tsd-kind-icon">Style<wbr>Provider</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_styleprovider_.styleprovider.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#converter" class="tsd-kind-icon">converter</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#fallback" class="tsd-kind-icon">fallback</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#mount" class="tsd-kind-icon">mount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#renderall" class="tsd-kind-icon">render<wbr>All</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#rendered" class="tsd-kind-icon">rendered</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#renderedall" class="tsd-kind-icon">rendered<wbr>All</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#renderedfallback" class="tsd-kind-icon">rendered<wbr>Fallback</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#dashcase" class="tsd-kind-icon">dash<wbr>Case</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#fields" class="tsd-kind-icon">fields</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#generate" class="tsd-kind-icon">generate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
<a href="_styleprovider_.styleprovider.html#parser" class="tsd-kind-icon">parser</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_styleprovider_.styleprovider.html#render" class="tsd-kind-icon">render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_styleprovider_.styleprovider.html#rootstyleprovider" class="tsd-kind-icon">root<wbr>Style<wbr>Provider</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_styleprovider_.styleprovider.html#styleprovider" class="tsd-kind-icon">style<wbr>Provider</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_styleprovider_.parserresult.html" class="tsd-kind-icon">Parser<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_styleprovider_.renderresult.html" class="tsd-kind-icon">Render<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_styleprovider_.styleprovideroptions.html" class="tsd-kind-icon">Style<wbr>Provider<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/_styleprovider_.html#deeppartial" class="tsd-kind-icon">Deep<wbr>Partial</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_styleprovider_.html#emptystyles" class="tsd-kind-icon">empty<wbr>Styles</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<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>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<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>