Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
typhonrt committed May 7, 2024
1 parent a80e42d commit d276d2d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">position</span>: <a href="../types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html" class="tsd-signature-type tsd-kind-type-alias">TJSPositionDataRelative</a></span><div class="tsd-comment tsd-typography"><p>TJSPosition data to set.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html" class="tsd-signature-type tsd-kind-type-alias">OptionsSet</a></span><div class="tsd-comment tsd-typography"><p>Additional options.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_runtime_svelte_store_position.TJSPosition.html" class="tsd-signature-type tsd-kind-class">TJSPosition</a></h4><p>This TJSPosition instance.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html">TJSPositionWritable</a>.<a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html#set">set</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subscribe.subscribe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/svelte_store.Unsubscriber.html" class="tsd-signature-type tsd-kind-type-alias">Unsubscriber</a><a href="#subscribe.subscribe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/svelte_store.Subscriber.html" class="tsd-signature-type tsd-kind-type-alias">Subscriber</a><span class="tsd-signature-symbol">&lt;</span><a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/types/Readonly.html" class="tsd-signature-type external" target="_blank">Readonly</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html" class="tsd-signature-type tsd-kind-interface">TJSPositionData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Callback function that is invoked on update / changes. Receives a copy of the TJSPositionData.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html">TJSPositionWritable</a>.<a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html#set">set</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subscribe.subscribe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/svelte_store.Unsubscriber.html" class="tsd-signature-type tsd-kind-type-alias">Unsubscriber</a><a href="#subscribe.subscribe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/svelte_store.Subscriber.html" class="tsd-signature-type tsd-kind-type-alias">Subscriber</a><span class="tsd-signature-symbol">&lt;</span><a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/types/Readonly.html" class="tsd-signature-type external" target="_blank">Readonly</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html" class="tsd-signature-type tsd-kind-interface">TJSPositionData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Callback function that is invoked on update / changes. Receives a readonly copy of the TJSPositionData.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/svelte_store.Unsubscriber.html" class="tsd-signature-type tsd-kind-type-alias">Unsubscriber</a></h4><p>Unsubscribe function.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html">TJSPositionWritable</a>.<a href="../interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html#subscribe">subscribe</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html" class="tsd-signature-type tsd-kind-interface">TJSPositionData</a><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html" class="tsd-signature-type tsd-kind-interface">TJSPositionData</a></h4><p>Current position data.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="update.update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">updater</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#update.update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provides the <a href="../interfaces/svelte_store.Writable-1.html" class="tsd-kind-interface">Writable</a> store <code>update</code> method. Receive and return a TJSPositionData instance to
Expand Down
6 changes: 5 additions & 1 deletion docs/modules/_runtime_svelte_store_position.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!DOCTYPE html><html class="default" lang="en"><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>#runtime/svelte/store/position | TyphonJS Runtime Library (FVTT) 0.2.0-next.1</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0-next.1"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"><script defer="" src="../assets/main.js"></script><script async="" src="../assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">TyphonJS Runtime Library (FVTT) 0.2.0-next.1</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Package #runtime/svelte/store/position</h1></div></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion">
<!DOCTYPE html><html class="default" lang="en"><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>#runtime/svelte/store/position | TyphonJS Runtime Library (FVTT) 0.2.0-next.1</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0-next.1"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"><script defer="" src="../assets/main.js"></script><script async="" src="../assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">TyphonJS Runtime Library (FVTT) 0.2.0-next.1</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Package #runtime/svelte/store/position</h1></div></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Provides a reactive compound store and related actions for advanced and optimized positioning of elements including
essential animation / tweening and validation of positional changes. <a href="../classes/_runtime_svelte_store_position.TJSPosition.html" class="tsd-kind-class">TJSPosition</a> is the main reactive store
along with the <a href="../functions/_runtime_svelte_store_position.applyPosition.html" class="tsd-kind-function">applyPosition</a> and <a href="../functions/_runtime_svelte_store_position.draggable.html" class="tsd-kind-function">draggable</a> actions to respectively attach a <code>TJSPosition</code> instance
to an element in a Svelte template and make it draggable.</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion">
<summary class="tsd-accordion-summary tsd-index-summary" data-key="module-index">
<h3 class="tsd-index-heading uppercase">
<svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index
Expand Down

0 comments on commit d276d2d

Please sign in to comment.