aberdeen 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/route.d.ts +8 -8
- package/dist/src/route.js +57 -64
- package/dist/src/route.js.map +3 -3
- package/dist/src/server.d.ts +2 -2
- package/dist/src/server.js.map +1 -1
- package/dist-docs/Tutorial/index.html +2 -2
- package/dist-docs/aberdeen/Aberdeen/index.html +31 -31
- package/dist-docs/aberdeen/InitOptions/index.html +3 -3
- package/dist-docs/aberdeen/KeyToString/index.html +2 -2
- package/dist-docs/aberdeen/PromiseProxy/index.html +5 -5
- package/dist-docs/aberdeen/SortKeyType/index.html +2 -2
- package/dist-docs/aberdeen/TargetType/index.html +2 -2
- package/dist-docs/aberdeen/ValueRef/index.html +2 -2
- package/dist-docs/aberdeen/WindowLike/index.html +3 -3
- package/dist-docs/aberdeen/createA/index.html +2 -2
- package/dist-docs/aberdeen/index.html +2 -2
- package/dist-docs/assets/aberdeen/route.d.ts +8 -8
- package/dist-docs/assets/aberdeen/route.js +57 -64
- package/dist-docs/assets/aberdeen/route.js.map +3 -3
- package/dist-docs/assets/aberdeen/server.d.ts +2 -2
- package/dist-docs/assets/aberdeen/server.js.map +1 -1
- package/dist-docs/assets/navigation.js +1 -1
- package/dist-docs/assets/search.js +1 -1
- package/dist-docs/dispatcher/Dispatcher/index.html +4 -4
- package/dist-docs/dispatcher/MATCH_FAILED/index.html +2 -2
- package/dist-docs/dispatcher/MATCH_REST/index.html +2 -2
- package/dist-docs/dispatcher/index.html +2 -2
- package/dist-docs/hierarchy.html +1 -1
- package/dist-docs/index-1/index.html +2 -2
- package/dist-docs/index.html +2 -2
- package/dist-docs/media/CHANGELOG.md +1 -1
- package/dist-docs/modules.html +1 -1
- package/dist-docs/prediction/applyCanon/index.html +2 -2
- package/dist-docs/prediction/applyPrediction/index.html +2 -2
- package/dist-docs/prediction/index.html +2 -2
- package/dist-docs/route/RouteApi/index.html +14 -14
- package/dist-docs/route/{Route → RouteState}/index.html +9 -9
- package/dist-docs/route/{init → createRoute}/index.html +2 -2
- package/dist-docs/route/index.html +4 -4
- package/dist-docs/server/RenderToStringOptions/index.html +4 -4
- package/dist-docs/server/RenderToStringResult/index.html +4 -4
- package/dist-docs/server/index.html +2 -2
- package/dist-docs/server/renderToString/index.html +2 -2
- package/dist-docs/sitemap.xml +36 -36
- package/dist-docs/transitions/grow/index.html +2 -2
- package/dist-docs/transitions/index.html +2 -2
- package/dist-docs/transitions/shrink/index.html +2 -2
- package/package.json +1 -1
- package/skill/aberdeen.md +45 -45
- package/skill/dispatcher.md +6 -6
- package/skill/prediction.md +3 -3
- package/skill/route.md +90 -90
- package/skill/transitions.md +3 -3
- package/src/route.ts +295 -319
- package/src/server.ts +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>grow | Aberdeen - v2.0.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>grow | Aberdeen - v2.0.1</title><link rel="icon" href="../../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Aberdeen"/><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 defer src="../../assets/custom.js"></script><script async src="../../assets/icons.js" id="tsd-icons-script"></script><script async src="../../assets/search.js" id="tsd-search-script"></script><script async src="../../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../../index.html" class="title">Aberdeen - v2.0.1</a><div id="tsd-toolbar-links"><a href="https://aberdeenjs.org/">What's this?</a><a href="https://aberdeenjs.org/Tutorial/">Tutorial</a><a href="https://github.com/vanviegen/aberdeen">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../">transitions</a></li><li><a href="" aria-current="page">grow</a></li></ul><h1>Function grow</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="grow"><span class="tsd-kind-call-signature">grow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">el</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</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">void</span><span class="tsd-signature-symbol">></span><a href="#grow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Do a grow transition for the given element. This is meant to be used as a
|
|
2
2
|
handler for the <code>create</code> property.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">el</span>: <span class="tsd-signature-type">HTMLElement</span></span><div class="tsd-comment tsd-typography"><p>The element to transition.</p>
|
|
4
4
|
<p>The transition doesn't look great for table elements, and may have problems
|
|
5
5
|
for other specific cases as well.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vanviegen/aberdeen/blob/
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/transitions.ts#L39">transitions.ts:39</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://aberdeenjs.org/" class="tsd-nav-link">What's this?</a><a href="https://aberdeenjs.org/Tutorial/" class="tsd-nav-link">Tutorial</a><a href="https://github.com/vanviegen/aberdeen" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../../modules.html">Aberdeen - v2.0.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>transitions | Aberdeen - v2.0.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>transitions | Aberdeen - v2.0.1</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Aberdeen"/><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 defer src="../assets/custom.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Aberdeen - v2.0.1</a><div id="tsd-toolbar-links"><a href="https://aberdeenjs.org/">What's this?</a><a href="https://aberdeenjs.org/Tutorial/">Tutorial</a><a href="https://github.com/vanviegen/aberdeen">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">transitions</a></li></ul><h1>Module transitions</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="grow"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><a href="grow/">grow</a><a href="#grow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"><div class="tsd-comment tsd-typography"><p>Do a grow transition for the given element. This is meant to be used as a
|
|
2
2
|
handler for the <code>create</code> property.</p>
|
|
3
3
|
</div></dd><dt class="tsd-member-summary" id="shrink"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><a href="shrink/">shrink</a><a href="#shrink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"><div class="tsd-comment tsd-typography"><p>Do a shrink transition for the given element, and remove it from the DOM
|
|
4
4
|
afterwards. This is meant to be used as a handler for the <code>destroy</code> property.</p>
|
|
5
|
-
</div></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#grow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>grow</span></a><a href="#shrink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>shrink</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://aberdeenjs.org/" class="tsd-nav-link">What's this?</a><a href="https://aberdeenjs.org/Tutorial/" class="tsd-nav-link">Tutorial</a><a href="https://github.com/vanviegen/aberdeen" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">Aberdeen - v2.0.
|
|
5
|
+
</div></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#grow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>grow</span></a><a href="#shrink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>shrink</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://aberdeenjs.org/" class="tsd-nav-link">What's this?</a><a href="https://aberdeenjs.org/Tutorial/" class="tsd-nav-link">Tutorial</a><a href="https://github.com/vanviegen/aberdeen" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">Aberdeen - v2.0.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>shrink | Aberdeen - v2.0.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>shrink | Aberdeen - v2.0.1</title><link rel="icon" href="../../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Aberdeen"/><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 defer src="../../assets/custom.js"></script><script async src="../../assets/icons.js" id="tsd-icons-script"></script><script async src="../../assets/search.js" id="tsd-search-script"></script><script async src="../../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../../index.html" class="title">Aberdeen - v2.0.1</a><div id="tsd-toolbar-links"><a href="https://aberdeenjs.org/">What's this?</a><a href="https://aberdeenjs.org/Tutorial/">Tutorial</a><a href="https://github.com/vanviegen/aberdeen">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../">transitions</a></li><li><a href="" aria-current="page">shrink</a></li></ul><h1>Function shrink</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="shrink"><span class="tsd-kind-call-signature">shrink</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">el</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</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">void</span><span class="tsd-signature-symbol">></span><a href="#shrink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Do a shrink transition for the given element, and remove it from the DOM
|
|
2
2
|
afterwards. This is meant to be used as a handler for the <code>destroy</code> property.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">el</span>: <span class="tsd-signature-type">HTMLElement</span></span><div class="tsd-comment tsd-typography"><p>The element to transition and remove.</p>
|
|
4
4
|
<p>The transition doesn't look great for table elements, and may have problems
|
|
5
5
|
for other specific cases as well.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vanviegen/aberdeen/blob/
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/transitions.ts#L62">transitions.ts:62</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://aberdeenjs.org/" class="tsd-nav-link">What's this?</a><a href="https://aberdeenjs.org/Tutorial/" class="tsd-nav-link">Tutorial</a><a href="https://github.com/vanviegen/aberdeen" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../../modules.html">Aberdeen - v2.0.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
package/package.json
CHANGED
package/skill/aberdeen.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**Aberdeen v2.0.
|
|
1
|
+
[**Aberdeen v2.0.1**](README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
|
|
11
11
|
### Aberdeen()
|
|
12
12
|
|
|
13
|
-
Defined in: [aberdeen.ts:51](https://github.com/vanviegen/aberdeen/blob/
|
|
13
|
+
Defined in: [aberdeen.ts:51](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L51)
|
|
14
14
|
|
|
15
15
|
The Aberdeen instance returned by [createA](#createa): a callable element-builder with every
|
|
16
16
|
Aberdeen function attached as a method. `import A from 'aberdeen'` gives you one of these.
|
|
17
17
|
|
|
18
18
|
> **Aberdeen**(...`args`): `undefined` \| `Element`
|
|
19
19
|
|
|
20
|
-
Defined in: [aberdeen.ts:53](https://github.com/vanviegen/aberdeen/blob/
|
|
20
|
+
Defined in: [aberdeen.ts:53](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L53)
|
|
21
21
|
|
|
22
22
|
Build reactive DOM: create elements, set attributes/properties/event listeners, add content. See the tutorial for the full mini-language.
|
|
23
23
|
|
|
@@ -37,7 +37,7 @@ Build reactive DOM: create elements, set attributes/properties/event listeners,
|
|
|
37
37
|
|
|
38
38
|
> **cssVars**: `Record`\<`string`, `string`\>
|
|
39
39
|
|
|
40
|
-
Defined in: [aberdeen.ts:192](https://github.com/vanviegen/aberdeen/blob/
|
|
40
|
+
Defined in: [aberdeen.ts:192](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L192)
|
|
41
41
|
|
|
42
42
|
A reactive object containing CSS variable definitions.
|
|
43
43
|
|
|
@@ -74,7 +74,7 @@ A('hr mt:$3'); // Sets margin-top to var(--m3)
|
|
|
74
74
|
|
|
75
75
|
> **CUSTOM\_DUMP**: `any`
|
|
76
76
|
|
|
77
|
-
Defined in: [aberdeen.ts:207](https://github.com/vanviegen/aberdeen/blob/
|
|
77
|
+
Defined in: [aberdeen.ts:207](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L207)
|
|
78
78
|
|
|
79
79
|
When set on an object or its prototype chain, [Aberdeen.dump](#dump) calls this as a render function
|
|
80
80
|
(with the object as `this`) instead of its default recursive rendering. If the value is not
|
|
@@ -93,7 +93,7 @@ class Color {
|
|
|
93
93
|
|
|
94
94
|
> **NO\_COPY**: `any`
|
|
95
95
|
|
|
96
|
-
Defined in: [aberdeen.ts:618](https://github.com/vanviegen/aberdeen/blob/
|
|
96
|
+
Defined in: [aberdeen.ts:618](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L618)
|
|
97
97
|
|
|
98
98
|
Use [Aberdeen.OPAQUE](#opaque) instead. This is an alias kept for backward compatibility.
|
|
99
99
|
|
|
@@ -103,7 +103,7 @@ Use [Aberdeen.OPAQUE](#opaque) instead. This is an alias kept for backward compa
|
|
|
103
103
|
|
|
104
104
|
> **OPAQUE**: `any`
|
|
105
105
|
|
|
106
|
-
Defined in: [aberdeen.ts:611](https://github.com/vanviegen/aberdeen/blob/
|
|
106
|
+
Defined in: [aberdeen.ts:611](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L611)
|
|
107
107
|
|
|
108
108
|
A symbol that controls how Aberdeen handles an object in copy operations and proxy wrapping.
|
|
109
109
|
|
|
@@ -123,7 +123,7 @@ The **value** of the symbol controls proxy wrapping when the object is read from
|
|
|
123
123
|
|
|
124
124
|
> **clean**(`cleaner`): `void`
|
|
125
125
|
|
|
126
|
-
Defined in: [aberdeen.ts:92](https://github.com/vanviegen/aberdeen/blob/
|
|
126
|
+
Defined in: [aberdeen.ts:92](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L92)
|
|
127
127
|
|
|
128
128
|
Registers a cleanup function to be executed just before the current reactive scope
|
|
129
129
|
is destroyed or redraws.
|
|
@@ -176,7 +176,7 @@ setInterval(() => $numbers[rnd()] = rnd(), 1000);
|
|
|
176
176
|
|
|
177
177
|
> **clone**\<`T`\>(`src`): `T`
|
|
178
178
|
|
|
179
|
-
Defined in: [aberdeen.ts:101](https://github.com/vanviegen/aberdeen/blob/
|
|
179
|
+
Defined in: [aberdeen.ts:101](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L101)
|
|
180
180
|
|
|
181
181
|
Clone an (optionally proxied) object or array.
|
|
182
182
|
|
|
@@ -206,7 +206,7 @@ A new unproxied array or object (of the same type as `src`), containing a deep c
|
|
|
206
206
|
|
|
207
207
|
> **copy**\<`T`\>(`dst`, `src`): `boolean`
|
|
208
208
|
|
|
209
|
-
Defined in: [aberdeen.ts:130](https://github.com/vanviegen/aberdeen/blob/
|
|
209
|
+
Defined in: [aberdeen.ts:130](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L130)
|
|
210
210
|
|
|
211
211
|
Recursively copies properties or array items from `src` to `dst`.
|
|
212
212
|
It's designed to work efficiently with reactive proxies created by [Aberdeen.proxy](#proxy).
|
|
@@ -265,7 +265,7 @@ console.log($dest); // proxy({ a: 1, b: { e: 4 } })
|
|
|
265
265
|
|
|
266
266
|
> **count**(`proxied`): [`ValueRef`](#valueref)\<`number`\>
|
|
267
267
|
|
|
268
|
-
Defined in: [aberdeen.ts:159](https://github.com/vanviegen/aberdeen/blob/
|
|
268
|
+
Defined in: [aberdeen.ts:159](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L159)
|
|
269
269
|
|
|
270
270
|
Reactively counts the number of properties in an object.
|
|
271
271
|
|
|
@@ -308,7 +308,7 @@ $items.z = 12;
|
|
|
308
308
|
|
|
309
309
|
> **darkMode**(): `boolean`
|
|
310
310
|
|
|
311
|
-
Defined in: [aberdeen.ts:232](https://github.com/vanviegen/aberdeen/blob/
|
|
311
|
+
Defined in: [aberdeen.ts:232](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L232)
|
|
312
312
|
|
|
313
313
|
Returns whether the user's browser prefers a dark color scheme.
|
|
314
314
|
|
|
@@ -341,7 +341,7 @@ A('div bg:$bg fg:$fg p:1rem #Colors change based on system dark mode preference'
|
|
|
341
341
|
|
|
342
342
|
> **derive**\<`T`\>(`func`): [`ValueRef`](#valueref)\<`T`\>
|
|
343
343
|
|
|
344
|
-
Defined in: [aberdeen.ts:282](https://github.com/vanviegen/aberdeen/blob/
|
|
344
|
+
Defined in: [aberdeen.ts:282](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L282)
|
|
345
345
|
|
|
346
346
|
Creates a reactive scope that automatically re-executes the provided function
|
|
347
347
|
whenever any proxied data (created by [Aberdeen.proxy](#proxy)) read during its last execution changes, storing
|
|
@@ -408,7 +408,7 @@ A('h3', () => {
|
|
|
408
408
|
|
|
409
409
|
> **dump**\<`T`\>(`data`): `T`
|
|
410
410
|
|
|
411
|
-
Defined in: [aberdeen.ts:311](https://github.com/vanviegen/aberdeen/blob/
|
|
411
|
+
Defined in: [aberdeen.ts:311](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L311)
|
|
412
412
|
|
|
413
413
|
Renders a live, recursive dump of a proxied data structure (or any value)
|
|
414
414
|
into the DOM at the current [A](#aberdeen) insertion point.
|
|
@@ -459,7 +459,7 @@ setTimeout(() => { $state.user.kids++; $state.items.push('c'); }, 2000);
|
|
|
459
459
|
|
|
460
460
|
> **insertCss**(`style`): `string`
|
|
461
461
|
|
|
462
|
-
Defined in: [aberdeen.ts:381](https://github.com/vanviegen/aberdeen/blob/
|
|
462
|
+
Defined in: [aberdeen.ts:381](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L381)
|
|
463
463
|
|
|
464
464
|
Inserts CSS rules into the document, scoping them with a unique class name.
|
|
465
465
|
|
|
@@ -542,7 +542,7 @@ A(badge + ' span#Product Name');
|
|
|
542
542
|
|
|
543
543
|
> **insertGlobalCss**(`style`): `void`
|
|
544
544
|
|
|
545
|
-
Defined in: [aberdeen.ts:441](https://github.com/vanviegen/aberdeen/blob/
|
|
545
|
+
Defined in: [aberdeen.ts:441](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L441)
|
|
546
546
|
|
|
547
547
|
Inserts CSS rules globally (unscoped).
|
|
548
548
|
|
|
@@ -614,7 +614,7 @@ A.insertGlobalCss({
|
|
|
614
614
|
|
|
615
615
|
> **invertString**(`input`): `string`
|
|
616
616
|
|
|
617
|
-
Defined in: [aberdeen.ts:470](https://github.com/vanviegen/aberdeen/blob/
|
|
617
|
+
Defined in: [aberdeen.ts:470](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L470)
|
|
618
618
|
|
|
619
619
|
Creates a new string that has the opposite sort order compared to the input string.
|
|
620
620
|
|
|
@@ -661,7 +661,7 @@ A.onEach($users, ($user) => {
|
|
|
661
661
|
|
|
662
662
|
> **isEmpty**(`proxied`): `boolean`
|
|
663
663
|
|
|
664
|
-
Defined in: [aberdeen.ts:504](https://github.com/vanviegen/aberdeen/blob/
|
|
664
|
+
Defined in: [aberdeen.ts:504](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L504)
|
|
665
665
|
|
|
666
666
|
Reactively checks if an observable array, object, Map, or Set is empty.
|
|
667
667
|
|
|
@@ -710,7 +710,7 @@ setInterval(() => {
|
|
|
710
710
|
|
|
711
711
|
> **map**\<`K`, `IN`, `OUT`\>(`source`, `func`): `Map`\<`K`, `OUT`\>
|
|
712
712
|
|
|
713
|
-
Defined in: [aberdeen.ts:507](https://github.com/vanviegen/aberdeen/blob/
|
|
713
|
+
Defined in: [aberdeen.ts:507](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L507)
|
|
714
714
|
|
|
715
715
|
When using a Map as `source`.
|
|
716
716
|
|
|
@@ -746,7 +746,7 @@ When using a Map as `source`.
|
|
|
746
746
|
|
|
747
747
|
> **merge**\<`T`\>(`dst`, `value`): `boolean`
|
|
748
748
|
|
|
749
|
-
Defined in: [aberdeen.ts:535](https://github.com/vanviegen/aberdeen/blob/
|
|
749
|
+
Defined in: [aberdeen.ts:535](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L535)
|
|
750
750
|
|
|
751
751
|
Like [Aberdeen.copy](#copy), but uses merge semantics. Properties in `dst` not present in `src` are kept.
|
|
752
752
|
`null`/`undefined` in `src` delete properties in `dst`.
|
|
@@ -786,7 +786,7 @@ console.log($dest); // proxy({ a: 1, b: { c: 99, x: 5, y: 6 }, c: { z: 7 } })
|
|
|
786
786
|
|
|
787
787
|
> **mount**(`parentElement`, `func`): `void`
|
|
788
788
|
|
|
789
|
-
Defined in: [aberdeen.ts:580](https://github.com/vanviegen/aberdeen/blob/
|
|
789
|
+
Defined in: [aberdeen.ts:580](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L580)
|
|
790
790
|
|
|
791
791
|
Attaches a reactive Aberdeen UI fragment to an existing DOM element. Without the use of
|
|
792
792
|
this function, [A](#aberdeen) will assume `document.body` as its root.
|
|
@@ -849,7 +849,7 @@ Note how the inner mount behaves reactively as well, automatically unmounting wh
|
|
|
849
849
|
|
|
850
850
|
> **multiMap**\<`IN`, `OUT`\>(`source`, `func`): `OUT`
|
|
851
851
|
|
|
852
|
-
Defined in: [aberdeen.ts:583](https://github.com/vanviegen/aberdeen/blob/
|
|
852
|
+
Defined in: [aberdeen.ts:583](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L583)
|
|
853
853
|
|
|
854
854
|
When using an array as `source`.
|
|
855
855
|
|
|
@@ -881,7 +881,7 @@ When using an array as `source`.
|
|
|
881
881
|
|
|
882
882
|
> **onEach**\<`K`, `T`\>(`target`, `render`, `makeKey?`): `void`
|
|
883
883
|
|
|
884
|
-
Defined in: [aberdeen.ts:688](https://github.com/vanviegen/aberdeen/blob/
|
|
884
|
+
Defined in: [aberdeen.ts:688](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L688)
|
|
885
885
|
|
|
886
886
|
Reactively iterates over the items of an observable array, object, Map, or Set, optionally rendering content for each item.
|
|
887
887
|
|
|
@@ -985,7 +985,7 @@ setTimeout(() => $tags.add('reactive'), 2000);
|
|
|
985
985
|
|
|
986
986
|
> **partition**\<`OUT_K`, `IN_V`\>(`source`, `func`): `Record`\<`OUT_K`, `Record`\<`number`, `IN_V`\>\>
|
|
987
987
|
|
|
988
|
-
Defined in: [aberdeen.ts:710](https://github.com/vanviegen/aberdeen/blob/
|
|
988
|
+
Defined in: [aberdeen.ts:710](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L710)
|
|
989
989
|
|
|
990
990
|
When using an object as `array`.
|
|
991
991
|
|
|
@@ -1017,7 +1017,7 @@ When using an object as `array`.
|
|
|
1017
1017
|
|
|
1018
1018
|
> **peek**\<`T`, `K`\>(`target`, `key`): `T`\[`K`\]
|
|
1019
1019
|
|
|
1020
|
-
Defined in: [aberdeen.ts:756](https://github.com/vanviegen/aberdeen/blob/
|
|
1020
|
+
Defined in: [aberdeen.ts:756](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L756)
|
|
1021
1021
|
|
|
1022
1022
|
Executes a function or retrieves a value *without* creating subscriptions in the current reactive scope, and returns its result.
|
|
1023
1023
|
|
|
@@ -1073,7 +1073,7 @@ $data.a = 2; // Triggers console.log (logs "A is 2, B was 3 when A changed.")
|
|
|
1073
1073
|
|
|
1074
1074
|
> **proxy**\<`T`\>(`target`): [`PromiseProxy`](#promiseproxy)\<`T`\>
|
|
1075
1075
|
|
|
1076
|
-
Defined in: [aberdeen.ts:826](https://github.com/vanviegen/aberdeen/blob/
|
|
1076
|
+
Defined in: [aberdeen.ts:826](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L826)
|
|
1077
1077
|
|
|
1078
1078
|
Creates a reactive proxy around the given data.
|
|
1079
1079
|
|
|
@@ -1158,7 +1158,7 @@ setTimeout(() => $graph.grow(), 4000);
|
|
|
1158
1158
|
|
|
1159
1159
|
> **ref**\<`T`, `K`\>(`target`, `index`): [`ValueRef`](#valueref)\<`T`\[`K`\]\>
|
|
1160
1160
|
|
|
1161
|
-
Defined in: [aberdeen.ts:859](https://github.com/vanviegen/aberdeen/blob/
|
|
1161
|
+
Defined in: [aberdeen.ts:859](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L859)
|
|
1162
1162
|
|
|
1163
1163
|
Creates a reactive reference (`{ value: T }`-like object) to a specific value
|
|
1164
1164
|
within a proxied object or array.
|
|
@@ -1218,7 +1218,7 @@ A(() => console.log($formData))
|
|
|
1218
1218
|
|
|
1219
1219
|
> **runQueue**(): `void`
|
|
1220
1220
|
|
|
1221
|
-
Defined in: [aberdeen.ts:895](https://github.com/vanviegen/aberdeen/blob/
|
|
1221
|
+
Defined in: [aberdeen.ts:895](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L895)
|
|
1222
1222
|
|
|
1223
1223
|
Forces the immediate and synchronous execution of all pending reactive updates.
|
|
1224
1224
|
|
|
@@ -1259,7 +1259,7 @@ console.log(2, document.body.innerHTML); // after
|
|
|
1259
1259
|
|
|
1260
1260
|
> **setErrorHandler**(`handler?`): `void`
|
|
1261
1261
|
|
|
1262
|
-
Defined in: [aberdeen.ts:939](https://github.com/vanviegen/aberdeen/blob/
|
|
1262
|
+
Defined in: [aberdeen.ts:939](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L939)
|
|
1263
1263
|
|
|
1264
1264
|
Sets a custom error handler function for errors that occur asynchronously
|
|
1265
1265
|
within reactive scopes (e.g., during updates triggered by proxy changes in
|
|
@@ -1317,7 +1317,7 @@ A('div.box', () => {
|
|
|
1317
1317
|
|
|
1318
1318
|
> **setSpacingCssVars**(`base?`, `unit?`): `void`
|
|
1319
1319
|
|
|
1320
|
-
Defined in: [aberdeen.ts:969](https://github.com/vanviegen/aberdeen/blob/
|
|
1320
|
+
Defined in: [aberdeen.ts:969](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L969)
|
|
1321
1321
|
|
|
1322
1322
|
Initializes `cssVars[0]` through `cssVars[12]` with an exponential spacing scale.
|
|
1323
1323
|
|
|
@@ -1364,7 +1364,7 @@ A.onEach(A.cssVars, (value, key) => {
|
|
|
1364
1364
|
|
|
1365
1365
|
> **unmountAll**(): `void`
|
|
1366
1366
|
|
|
1367
|
-
Defined in: [aberdeen.ts:978](https://github.com/vanviegen/aberdeen/blob/
|
|
1367
|
+
Defined in: [aberdeen.ts:978](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L978)
|
|
1368
1368
|
|
|
1369
1369
|
Removes all Aberdeen-managed DOM nodes and stops all active reactive scopes
|
|
1370
1370
|
(created by [Aberdeen.mount](#mount), [Aberdeen.derive](#derive), [A](#aberdeen) with functions, etc.).
|
|
@@ -1380,7 +1380,7 @@ automated tests, there should probably be little reason to call this function.
|
|
|
1380
1380
|
|
|
1381
1381
|
> **unproxy**\<`T`\>(`target`): `T`
|
|
1382
1382
|
|
|
1383
|
-
Defined in: [aberdeen.ts:1014](https://github.com/vanviegen/aberdeen/blob/
|
|
1383
|
+
Defined in: [aberdeen.ts:1014](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1014)
|
|
1384
1384
|
|
|
1385
1385
|
Returns the original, underlying data target from a reactive proxy created by [Aberdeen.proxy](#proxy).
|
|
1386
1386
|
If the input `target` is not a proxy, it is returned directly.
|
|
@@ -1438,7 +1438,7 @@ setTimeout(() => {
|
|
|
1438
1438
|
|
|
1439
1439
|
### InitOptions
|
|
1440
1440
|
|
|
1441
|
-
Defined in: [aberdeen.ts:22](https://github.com/vanviegen/aberdeen/blob/
|
|
1441
|
+
Defined in: [aberdeen.ts:22](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L22)
|
|
1442
1442
|
|
|
1443
1443
|
Options for [createA](#createa).
|
|
1444
1444
|
|
|
@@ -1448,7 +1448,7 @@ Options for [createA](#createa).
|
|
|
1448
1448
|
|
|
1449
1449
|
> `optional` **transitions**: `boolean`
|
|
1450
1450
|
|
|
1451
|
-
Defined in: [aberdeen.ts:24](https://github.com/vanviegen/aberdeen/blob/
|
|
1451
|
+
Defined in: [aberdeen.ts:24](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L24)
|
|
1452
1452
|
|
|
1453
1453
|
Set to `false` to disable `create`/`destroy` transitions for this instance (e.g. for SSR).
|
|
1454
1454
|
|
|
@@ -1456,7 +1456,7 @@ Set to `false` to disable `create`/`destroy` transitions for this instance (e.g.
|
|
|
1456
1456
|
|
|
1457
1457
|
### PromiseProxy
|
|
1458
1458
|
|
|
1459
|
-
Defined in: [aberdeen.ts:1054](https://github.com/vanviegen/aberdeen/blob/
|
|
1459
|
+
Defined in: [aberdeen.ts:1054](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1054)
|
|
1460
1460
|
|
|
1461
1461
|
When `proxy` is called with a Promise, the returned object has this shape.
|
|
1462
1462
|
|
|
@@ -1472,7 +1472,7 @@ When `proxy` is called with a Promise, the returned object has this shape.
|
|
|
1472
1472
|
|
|
1473
1473
|
> **busy**: `boolean`
|
|
1474
1474
|
|
|
1475
|
-
Defined in: [aberdeen.ts:1056](https://github.com/vanviegen/aberdeen/blob/
|
|
1475
|
+
Defined in: [aberdeen.ts:1056](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1056)
|
|
1476
1476
|
|
|
1477
1477
|
True while the promise is pending, false once it has resolved or rejected.
|
|
1478
1478
|
|
|
@@ -1480,7 +1480,7 @@ True while the promise is pending, false once it has resolved or rejected.
|
|
|
1480
1480
|
|
|
1481
1481
|
> `optional` **error**: `any`
|
|
1482
1482
|
|
|
1483
|
-
Defined in: [aberdeen.ts:1060](https://github.com/vanviegen/aberdeen/blob/
|
|
1483
|
+
Defined in: [aberdeen.ts:1060](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1060)
|
|
1484
1484
|
|
|
1485
1485
|
If the promise has rejected, the rejection error.
|
|
1486
1486
|
|
|
@@ -1488,7 +1488,7 @@ If the promise has rejected, the rejection error.
|
|
|
1488
1488
|
|
|
1489
1489
|
> `optional` **value**: `T`
|
|
1490
1490
|
|
|
1491
|
-
Defined in: [aberdeen.ts:1058](https://github.com/vanviegen/aberdeen/blob/
|
|
1491
|
+
Defined in: [aberdeen.ts:1058](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1058)
|
|
1492
1492
|
|
|
1493
1493
|
If the promise has resolved, the resolved value.
|
|
1494
1494
|
|
|
@@ -1496,7 +1496,7 @@ If the promise has resolved, the resolved value.
|
|
|
1496
1496
|
|
|
1497
1497
|
### ValueRef
|
|
1498
1498
|
|
|
1499
|
-
Defined in: [aberdeen.ts:1049](https://github.com/vanviegen/aberdeen/blob/
|
|
1499
|
+
Defined in: [aberdeen.ts:1049](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1049)
|
|
1500
1500
|
|
|
1501
1501
|
The shape returned by [Aberdeen.ref](#ref): an object whose single `value` property is reactive.
|
|
1502
1502
|
|
|
@@ -1510,7 +1510,7 @@ The shape returned by [Aberdeen.ref](#ref): an object whose single `value` prope
|
|
|
1510
1510
|
|
|
1511
1511
|
### WindowLike
|
|
1512
1512
|
|
|
1513
|
-
Defined in: [aberdeen.ts:7](https://github.com/vanviegen/aberdeen/blob/
|
|
1513
|
+
Defined in: [aberdeen.ts:7](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L7)
|
|
1514
1514
|
|
|
1515
1515
|
The minimal `window`-like object an Aberdeen instance renders against. A real browser
|
|
1516
1516
|
`window`, a jsdom window, and the server window from `aberdeen/server` all satisfy this.
|
|
@@ -1521,7 +1521,7 @@ The minimal `window`-like object an Aberdeen instance renders against. A real br
|
|
|
1521
1521
|
|
|
1522
1522
|
> `optional` **setTimeout**: (...`args`) => `any`
|
|
1523
1523
|
|
|
1524
|
-
Defined in: [aberdeen.ts:17](https://github.com/vanviegen/aberdeen/blob/
|
|
1524
|
+
Defined in: [aberdeen.ts:17](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L17)
|
|
1525
1525
|
|
|
1526
1526
|
Optional; falls back to the host's timers when absent (e.g. the lean server window).
|
|
1527
1527
|
|
|
@@ -1541,7 +1541,7 @@ Optional; falls back to the host's timers when absent (e.g. the lean server wind
|
|
|
1541
1541
|
|
|
1542
1542
|
> **KeyToString**\<`K`\> = `K` *extends* `number` ? `string` : `K` *extends* `string` \| `symbol` ? `K` : `K` *extends* `number` \| infer U ? `string` \| `U` : `K`
|
|
1543
1543
|
|
|
1544
|
-
Defined in: [aberdeen.ts:45](https://github.com/vanviegen/aberdeen/blob/
|
|
1544
|
+
Defined in: [aberdeen.ts:45](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L45)
|
|
1545
1545
|
|
|
1546
1546
|
Maps object key types to the string form Aberdeen passes to callbacks.
|
|
1547
1547
|
|
|
@@ -1557,7 +1557,7 @@ Maps object key types to the string form Aberdeen passes to callbacks.
|
|
|
1557
1557
|
|
|
1558
1558
|
> **SortKeyType** = `number` \| `string` \| (`number` \| `string`)[] \| `undefined` \| `void`
|
|
1559
1559
|
|
|
1560
|
-
Defined in: [aberdeen.ts:43](https://github.com/vanviegen/aberdeen/blob/
|
|
1560
|
+
Defined in: [aberdeen.ts:43](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L43)
|
|
1561
1561
|
|
|
1562
1562
|
A sort key returned by `onEach`/`map` ordering callbacks.
|
|
1563
1563
|
|
|
@@ -1567,7 +1567,7 @@ A sort key returned by `onEach`/`map` ordering callbacks.
|
|
|
1567
1567
|
|
|
1568
1568
|
> **TargetType** = `any`[] \| \{\[`key`: `string` \| `symbol`\]: `any`; \} \| `Map`\<`any`, `any`\> \| `Set`\<`any`\>
|
|
1569
1569
|
|
|
1570
|
-
Defined in: [aberdeen.ts:41](https://github.com/vanviegen/aberdeen/blob/
|
|
1570
|
+
Defined in: [aberdeen.ts:41](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L41)
|
|
1571
1571
|
|
|
1572
1572
|
Any value Aberdeen can proxy: array, plain object, Map or Set.
|
|
1573
1573
|
|
|
@@ -1577,7 +1577,7 @@ Any value Aberdeen can proxy: array, plain object, Map or Set.
|
|
|
1577
1577
|
|
|
1578
1578
|
> **createA**(`window?`, `options?`): [`Aberdeen`](#aberdeen)
|
|
1579
1579
|
|
|
1580
|
-
Defined in: [aberdeen.ts:1076](https://github.com/vanviegen/aberdeen/blob/
|
|
1580
|
+
Defined in: [aberdeen.ts:1076](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/aberdeen.ts#L1076)
|
|
1581
1581
|
|
|
1582
1582
|
Create an isolated Aberdeen instance bound to the given window. Returns the callable `A`
|
|
1583
1583
|
object (with all Aberdeen functions attached as properties).
|