shopperman
Version:
shopping cart ui for shopify stores
697 lines • 40.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>shopperman api docs</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">shopperman api docs</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-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>
</ul>
<h1> shopperman api docs</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/cart.html" class="tsd-kind-icon">Cart</a></li>
<li class="tsd-kind-class"><a href="classes/cartbutton.html" class="tsd-kind-icon">Cart<wbr>Button</a></li>
<li class="tsd-kind-class"><a href="classes/cartcalculatedresults.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Results</a></li>
<li class="tsd-kind-class"><a href="classes/cartcheckout.html" class="tsd-kind-icon">Cart<wbr>Checkout</a></li>
<li class="tsd-kind-class"><a href="classes/cartitem.html" class="tsd-kind-icon">Cart<wbr>Item</a></li>
<li class="tsd-kind-class"><a href="classes/cartitemdisplay.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Display</a></li>
<li class="tsd-kind-class"><a href="classes/cartmanipulator.html" class="tsd-kind-icon">Cart<wbr>Manipulator</a></li>
<li class="tsd-kind-class"><a href="classes/cartpanel.html" class="tsd-kind-icon">Cart<wbr>Panel</a></li>
<li class="tsd-kind-class"><a href="classes/cartsystem.html" class="tsd-kind-icon">Cart<wbr>System</a></li>
<li class="tsd-kind-class"><a href="classes/checkoutmachinebase.html" class="tsd-kind-icon">Checkout<wbr>Machine<wbr>Base</a></li>
<li class="tsd-kind-class"><a href="classes/currencycontrol.html" class="tsd-kind-icon">Currency<wbr>Control</a></li>
<li class="tsd-kind-class"><a href="classes/product.html" class="tsd-kind-icon">Product</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/productdisplay.html" class="tsd-kind-icon">Product<wbr>Display</a></li>
<li class="tsd-kind-class"><a href="classes/scrolltracker.html" class="tsd-kind-icon">Scroll<wbr>Tracker</a></li>
<li class="tsd-kind-class"><a href="classes/shopifyadapter.html" class="tsd-kind-icon">Shopify<wbr>Adapter</a></li>
<li class="tsd-kind-class"><a href="classes/shopifycheckoutmachine.html" class="tsd-kind-icon">Shopify<wbr>Checkout<wbr>Machine</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/cartbuttonprops.html" class="tsd-kind-icon">Cart<wbr>Button<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartbuttontext.html" class="tsd-kind-icon">Cart<wbr>Button<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartcalculatedresultsprops.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Results<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartcalculatedtext.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartcheckoutprops.html" class="tsd-kind-icon">Cart<wbr>Checkout<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartcheckouttext.html" class="tsd-kind-icon">Cart<wbr>Checkout<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartitemdisplayprops.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Display<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartitemoptions.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartitemtext.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartmanipulatorprops.html" class="tsd-kind-icon">Cart<wbr>Manipulator<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartoptions.html" class="tsd-kind-icon">Cart<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartpanelprops.html" class="tsd-kind-icon">Cart<wbr>Panel<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartpaneltext.html" class="tsd-kind-icon">Cart<wbr>Panel<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartstoragedata.html" class="tsd-kind-icon">Cart<wbr>Storage<wbr>Data</a></li>
<li class="tsd-kind-interface"><a href="interfaces/cartsystemprops.html" class="tsd-kind-icon">Cart<wbr>System<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/carttext.html" class="tsd-kind-icon">Cart<wbr>Text</a></li>
<li class="tsd-kind-interface"><a href="interfaces/currencycontroloptions.html" class="tsd-kind-icon">Currency<wbr>Control<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ecommerceshopifystoreoptions.html" class="tsd-kind-icon">Ecommerce<wbr>Shopify<wbr>Store<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/elementattributes.html" class="tsd-kind-icon">Element<wbr>Attributes</a></li>
<li class="tsd-kind-interface"><a href="interfaces/productdisplayprops.html" class="tsd-kind-icon">Product<wbr>Display<wbr>Props</a></li>
<li class="tsd-kind-interface"><a href="interfaces/productevaluation.html" class="tsd-kind-icon">Product<wbr>Evaluation</a></li>
<li class="tsd-kind-interface"><a href="interfaces/productoptions.html" class="tsd-kind-icon">Product<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/shopifyadapteroptions.html" class="tsd-kind-icon">Shopify<wbr>Adapter<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/shopifysettings.html" class="tsd-kind-icon">Shopify<wbr>Settings</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="globals.html#performcheckout" class="tsd-kind-icon">Perform<wbr>Checkout</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#productevaluator" class="tsd-kind-icon">Product<wbr>Evaluator</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#shopifyclient" class="tsd-kind-icon">Shopify<wbr>Client</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#scrollevents" class="tsd-kind-icon">scroll<wbr>Events</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="globals.html#convertnewlinestoreactbreaks" class="tsd-kind-icon">convert<wbr>Newlines<wbr>ToReact<wbr>Breaks</a></li>
<li class="tsd-kind-function"><a href="globals.html#ecommerceshopifystore" class="tsd-kind-icon">ecommerce<wbr>Shopify<wbr>Store</a></li>
<li class="tsd-kind-function"><a href="globals.html#getscrolltop" class="tsd-kind-icon">get<wbr>Scroll<wbr>Top</a></li>
<li class="tsd-kind-function"><a href="globals.html#isdescendant" class="tsd-kind-icon">is<wbr>Descendant</a></li>
<li class="tsd-kind-function"><a href="globals.html#makedefaultcarttext" class="tsd-kind-icon">make<wbr>Default<wbr>Cart<wbr>Text</a></li>
<li class="tsd-kind-function"><a href="globals.html#makedefaultscrolltracker" class="tsd-kind-icon">make<wbr>Default<wbr>Scroll<wbr>Tracker</a></li>
<li class="tsd-kind-function"><a href="globals.html#setscrolltop" class="tsd-kind-icon">set<wbr>Scroll<wbr>Top</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal"><a href="globals.html#defaultcartoptions" class="tsd-kind-icon">default<wbr>Cart<wbr>Options</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="performcheckout" class="tsd-anchor"></a>
<h3>Perform<wbr>Checkout</h3>
<div class="tsd-signature tsd-kind-icon">Perform<wbr>Checkout<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/chase-moskal/shopperman/blob/983feb3/source/components/cart/panel/panel-interfaces.ts#L38">components/cart/panel/panel-interfaces.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Perform checkout function signature</p>
<ul>
<li>function to call when the checkout is triggered</li>
</ul>
</div>
</div>
<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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="productevaluator" class="tsd-anchor"></a>
<h3>Product<wbr>Evaluator</h3>
<div class="tsd-signature tsd-kind-icon">Product<wbr>Evaluator<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/chase-moskal/shopperman/blob/983feb3/source/ecommerce/ecommerce-interfaces.ts#L20">ecommerce/ecommerce-interfaces.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function to evaluate non-shopify product details</p>
</div>
</div>
<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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>product<span class="tsd-signature-symbol">: </span><a href="classes/product.html" class="tsd-signature-type">Product</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/productevaluation.html" class="tsd-signature-type">ProductEvaluation</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>product: <a href="classes/product.html" class="tsd-signature-type">Product</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfaces/productevaluation.html" class="tsd-signature-type">ProductEvaluation</a></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="shopifyclient" class="tsd-anchor"></a>
<h3>Shopify<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">Shopify<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/shopify/shopify-interfaces.ts#L7">shopify/shopify-interfaces.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Shopify api client</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="scrollevents" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> scroll<wbr>Events</h3>
<div class="tsd-signature tsd-kind-icon">scroll<wbr>Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ["scroll", "resize"]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/scroll-tracker.ts#L5">stores/scroll-tracker.ts:5</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="convertnewlinestoreactbreaks" class="tsd-anchor"></a>
<h3>convert<wbr>Newlines<wbr>ToReact<wbr>Breaks</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">convert<wbr>Newlines<wbr>ToReact<wbr>Breaks<span class="tsd-signature-symbol">(</span>text<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">Element</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/toolbox/convert-newlines-to-react-breaks.tsx#L4">toolbox/convert-newlines-to-react-breaks.tsx:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>text: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="ecommerceshopifystore" class="tsd-anchor"></a>
<h3>ecommerce<wbr>Shopify<wbr>Store</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">ecommerce<wbr>Shopify<wbr>Store<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/ecommerceshopifystoreoptions.html" class="tsd-signature-type">EcommerceShopifyStoreOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/ecommerce/shopify-store.tsx#L17">ecommerce/shopify-store.tsx:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Ecommerce shopify collection options</p>
<ul>
<li>load products from shopify</li>
<li>install a fully featured cart system and ecommerce experience</li>
<li>place products into specific dom elements</li>
</ul>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="interfaces/ecommerceshopifystoreoptions.html" class="tsd-signature-type">EcommerceShopifyStoreOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getscrolltop" class="tsd-anchor"></a>
<h3>get<wbr>Scroll<wbr>Top</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Scroll<wbr>Top<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/toolbox/get-scroll-top.ts#L2">toolbox/get-scroll-top.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> doc: <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"> = window.document</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="isdescendant" class="tsd-anchor"></a>
<h3>is<wbr>Descendant</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Descendant<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/toolbox/is-descendant.ts#L2">toolbox/is-descendant.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>child: <span class="tsd-signature-type">Element</span></h5>
</li>
<li>
<h5>parent: <span class="tsd-signature-type">Element</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="makedefaultcarttext" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Default<wbr>Cart<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">make<wbr>Default<wbr>Cart<wbr>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/carttext.html" class="tsd-signature-type">CartText</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/components/cart/make-default-cart-text.ts#L4">components/cart/make-default-cart-text.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="interfaces/carttext.html" class="tsd-signature-type">CartText</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="makedefaultscrolltracker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Default<wbr>Scroll<wbr>Tracker</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">make<wbr>Default<wbr>Scroll<wbr>Tracker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/scrolltracker.html" class="tsd-signature-type">ScrollTracker</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/components/cart/make-default-scroll-tracker.ts#L4">components/cart/make-default-scroll-tracker.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="classes/scrolltracker.html" class="tsd-signature-type">ScrollTracker</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="setscrolltop" class="tsd-anchor"></a>
<h3>set<wbr>Scroll<wbr>Top</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">set<wbr>Scroll<wbr>Top<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, doc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/toolbox/set-scroll-top.ts#L2">toolbox/set-scroll-top.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> doc: <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"> = window.document</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal">
<a name="defaultcartoptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Cart<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Cart<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L13">stores/cart.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default cart options</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultcartoptions.omnistorage" class="tsd-anchor"></a>
<h3>omni<wbr>Storage</h3>
<div class="tsd-signature tsd-kind-icon">omni<wbr>Storage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = new LocalClient({storage: window.localStorage})</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L15">stores/cart.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultcartoptions.storagekey" class="tsd-anchor"></a>
<h3>storage<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">storage<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "shopperman"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L14">stores/cart.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/cart.html" class="tsd-kind-icon">Cart</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartbutton.html" class="tsd-kind-icon">Cart<wbr>Button</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartcalculatedresults.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Results</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartcheckout.html" class="tsd-kind-icon">Cart<wbr>Checkout</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartitem.html" class="tsd-kind-icon">Cart<wbr>Item</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartitemdisplay.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Display</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartmanipulator.html" class="tsd-kind-icon">Cart<wbr>Manipulator</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartpanel.html" class="tsd-kind-icon">Cart<wbr>Panel</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/cartsystem.html" class="tsd-kind-icon">Cart<wbr>System</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/checkoutmachinebase.html" class="tsd-kind-icon">Checkout<wbr>Machine<wbr>Base</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/currencycontrol.html" class="tsd-kind-icon">Currency<wbr>Control</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/product.html" class="tsd-kind-icon">Product</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/productdisplay.html" class="tsd-kind-icon">Product<wbr>Display</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/scrolltracker.html" class="tsd-kind-icon">Scroll<wbr>Tracker</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/shopifyadapter.html" class="tsd-kind-icon">Shopify<wbr>Adapter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/shopifycheckoutmachine.html" class="tsd-kind-icon">Shopify<wbr>Checkout<wbr>Machine</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartbuttonprops.html" class="tsd-kind-icon">Cart<wbr>Button<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartbuttontext.html" class="tsd-kind-icon">Cart<wbr>Button<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartcalculatedresultsprops.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Results<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartcalculatedtext.html" class="tsd-kind-icon">Cart<wbr>Calculated<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartcheckoutprops.html" class="tsd-kind-icon">Cart<wbr>Checkout<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartcheckouttext.html" class="tsd-kind-icon">Cart<wbr>Checkout<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartitemdisplayprops.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Display<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartitemoptions.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartitemtext.html" class="tsd-kind-icon">Cart<wbr>Item<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartmanipulatorprops.html" class="tsd-kind-icon">Cart<wbr>Manipulator<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartoptions.html" class="tsd-kind-icon">Cart<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartpanelprops.html" class="tsd-kind-icon">Cart<wbr>Panel<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartpaneltext.html" class="tsd-kind-icon">Cart<wbr>Panel<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartstoragedata.html" class="tsd-kind-icon">Cart<wbr>Storage<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/cartsystemprops.html" class="tsd-kind-icon">Cart<wbr>System<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/carttext.html" class="tsd-kind-icon">Cart<wbr>Text</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/currencycontroloptions.html" class="tsd-kind-icon">Currency<wbr>Control<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ecommerceshopifystoreoptions.html" class="tsd-kind-icon">Ecommerce<wbr>Shopify<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/elementattributes.html" class="tsd-kind-icon">Element<wbr>Attributes</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/productdisplayprops.html" class="tsd-kind-icon">Product<wbr>Display<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/productevaluation.html" class="tsd-kind-icon">Product<wbr>Evaluation</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/productoptions.html" class="tsd-kind-icon">Product<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/shopifyadapteroptions.html" class="tsd-kind-icon">Shopify<wbr>Adapter<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/shopifysettings.html" class="tsd-kind-icon">Shopify<wbr>Settings</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#performcheckout" class="tsd-kind-icon">Perform<wbr>Checkout</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#productevaluator" class="tsd-kind-icon">Product<wbr>Evaluator</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#shopifyclient" class="tsd-kind-icon">Shopify<wbr>Client</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#scrollevents" class="tsd-kind-icon">scroll<wbr>Events</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#convertnewlinestoreactbreaks" class="tsd-kind-icon">convert<wbr>Newlines<wbr>ToReact<wbr>Breaks</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#ecommerceshopifystore" class="tsd-kind-icon">ecommerce<wbr>Shopify<wbr>Store</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getscrolltop" class="tsd-kind-icon">get<wbr>Scroll<wbr>Top</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#isdescendant" class="tsd-kind-icon">is<wbr>Descendant</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#makedefaultcarttext" class="tsd-kind-icon">make<wbr>Default<wbr>Cart<wbr>Text</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#makedefaultscrolltracker" class="tsd-kind-icon">make<wbr>Default<wbr>Scroll<wbr>Tracker</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#setscrolltop" class="tsd-kind-icon">set<wbr>Scroll<wbr>Top</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#defaultcartoptions" class="tsd-kind-icon">default<wbr>Cart<wbr>Options</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>
</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="http://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>