@web-atoms/core-docs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>StyleBuilder | @web-atoms/core</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">@web-atoms/core</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> </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/_web_styles_stylebuilder_.html">"web/styles/StyleBuilder"</a> </li> <li> <a href="_web_styles_stylebuilder_.stylebuilder.html">StyleBuilder</a> </li> </ul> <h1>Class StyleBuilder</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">StyleBuilder</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>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_web_styles_stylebuilder_.stylebuilder.html#newstyle" class="tsd-kind-icon">new<wbr>Style</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"><a href="_web_styles_stylebuilder_.stylebuilder.html#absolute" class="tsd-kind-icon">absolute</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_styles_stylebuilder_.stylebuilder.html#border" class="tsd-kind-icon">border</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_styles_stylebuilder_.stylebuilder.html#center" class="tsd-kind-icon">center</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_styles_stylebuilder_.stylebuilder.html#roundborder" class="tsd-kind-icon">round<wbr>Border</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_styles_stylebuilder_.stylebuilder.html#size" class="tsd-kind-icon">size</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_styles_stylebuilder_.stylebuilder.html#tostyle" class="tsd-kind-icon">to<wbr>Style</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"> <a name="newstyle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> new<wbr>Style</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> newStyle<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L20">src/web/styles/StyleBuilder.ts:20</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </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"> <a name="absolute" class="tsd-anchor"></a> <h3>absolute</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">absolute<span class="tsd-signature-symbol">(</span>left<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, top<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, right<span class="tsd-signature-symbol">?: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, bottom<span class="tsd-signature-symbol">?: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L79">src/web/styles/StyleBuilder.ts:79</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>left: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5>top: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> right: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> bottom: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="border" class="tsd-anchor"></a> <h3>border</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">border<span class="tsd-signature-symbol">(</span>borderWidth<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, borderColor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Color</span>, borderStyle<span class="tsd-signature-symbol">?: </span><a href="../modules/_web_styles_istyledeclaration_.html#borderstyletype" class="tsd-signature-type">BorderStyleType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L52">src/web/styles/StyleBuilder.ts:52</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>borderWidth: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5>borderColor: <span class="tsd-signature-type">Color</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> borderStyle: <a href="../modules/_web_styles_istyledeclaration_.html#borderstyletype" class="tsd-signature-type">BorderStyleType</a><span class="tsd-signature-symbol"> = "solid"</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="center" class="tsd-anchor"></a> <h3>center</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, height<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L64">src/web/styles/StyleBuilder.ts:64</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>width: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5>height: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="roundborder" class="tsd-anchor"></a> <h3>round<wbr>Border</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">round<wbr>Border<span class="tsd-signature-symbol">(</span>radius<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L44">src/web/styles/StyleBuilder.ts:44</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>radius: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="size" class="tsd-anchor"></a> <h3>size</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a>, height<span class="tsd-signature-symbol">: </span><a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L32">src/web/styles/StyleBuilder.ts:32</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>width: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> <li> <h5>height: <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-signature-type">CssNumber</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-signature-type">StyleBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostyle" class="tsd-anchor"></a> <h3>to<wbr>Style</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>Style<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_web_styles_istyledeclaration_.istyledeclaration.html" class="tsd-signature-type">IStyleDeclaration</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/styles/StyleBuilder.ts#L28">src/web/styles/StyleBuilder.ts:28</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_web_styles_istyledeclaration_.istyledeclaration.html" class="tsd-signature-type">IStyleDeclaration</a></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/_web_styles_stylebuilder_.html">"web/styles/<wbr>Style<wbr>Builder"</a> </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-external-module"> <a href="_web_styles_stylebuilder_.stylebuilder.html" class="tsd-kind-icon">Style<wbr>Builder</a> <ul> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"> <a href="_web_styles_stylebuilder_.stylebuilder.html#newstyle" class="tsd-kind-icon">new<wbr>Style</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#absolute" class="tsd-kind-icon">absolute</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#border" class="tsd-kind-icon">border</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#center" class="tsd-kind-icon">center</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#roundborder" class="tsd-kind-icon">round<wbr>Border</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#size" class="tsd-kind-icon">size</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_web_styles_stylebuilder_.stylebuilder.html#tostyle" class="tsd-kind-icon">to<wbr>Style</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_web_styles_stylebuilder_.html#cssnumber" class="tsd-kind-icon">Css<wbr>Number</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_web_styles_stylebuilder_.html#cssnumbertostring" class="tsd-kind-icon">css<wbr>Number<wbr>ToString</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>