readme/doc

Author: farfromrefug

docs/assets/search.js

@@ -29,7 +29,7 @@ <h4>Implemented by</h4>
 <ul class="tsd-hierarchy">
 <li><a href="collectionview.CollectionViewBase.html" class="tsd-signature-type" data-tsd-kind="Class">CollectionViewBase</a></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:8</li>
+<li>Defined in packages/collectionview/index.d.ts:12</li>
 <li>Defined in packages/swipemenu/index.d.ts:7</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
@@ -413,7 +413,7 @@ <h3 class="tsd-anchor-link"><span>scroll<wbr/>Offset</span><a href="#scrollOffse
 <div class="tsd-signature">scroll<wbr/>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.scrollOffset</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:9</li></ul></aside></section>
+<li>Defined in packages/collectionview/index.d.ts:13</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="spanSize" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>span<wbr/>Size</span><a href="#spanSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">span<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div>
@@ -869,7 +869,7 @@ <h5>index: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">View</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.getViewForItemAtIndex</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:15</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:19</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getViewForViewType" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>View<wbr/>For<wbr/>View<wbr/>Type</span><a href="#getViewForViewType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
@@ -908,7 +908,7 @@ <h5>index: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.isItemAtIndexVisible</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:12</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:16</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="notifyForItemAtIndex" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>notify<wbr/>For<wbr/>Item<wbr/>At<wbr/>Index</span><a href="#notifyForItemAtIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
@@ -1155,7 +1155,7 @@ <h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="P
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.refresh</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:10</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:14</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="refreshVisibleItems" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>refresh<wbr/>Visible<wbr/>Items</span><a href="#refreshVisibleItems" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -1164,7 +1164,7 @@ <h3 class="tsd-anchor-link"><span>refresh<wbr/>Visible<wbr/>Items</span><a href=
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.refreshVisibleItems</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:11</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:15</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="removeTemplate" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>remove<wbr/>Template</span><a href="#removeTemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
@@ -1210,19 +1210,21 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="scrollToIndex" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>scroll<wbr/>To<wbr/>Index</span><a href="#scrollToIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-<li class="tsd-signature tsd-anchor-link" id="scrollToIndex.scrollToIndex-1">scroll<wbr/>To<wbr/>Index<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, animated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#scrollToIndex.scrollToIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
+<li class="tsd-signature tsd-anchor-link" id="scrollToIndex.scrollToIndex-1">scroll<wbr/>To<wbr/>Index<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, animated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, snap<span class="tsd-signature-symbol">??: </span><a href="../enums/collectionview.SnapPosition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SnapPosition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#scrollToIndex.scrollToIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></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>
 <h5>index: <span class="tsd-signature-type">number</span></h5></li>
 <li>
-<h5>animated: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
+<h5>animated: <span class="tsd-signature-type">boolean</span></h5></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> snap: <a href="../enums/collectionview.SnapPosition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SnapPosition</a><span class="tsd-signature-symbol"> = SnapPosition.START</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.scrollToIndex</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:13</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:17</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="scrollToOffset" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>scroll<wbr/>To<wbr/>Offset</span><a href="#scrollToOffset" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -1238,7 +1240,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> animation: <span class
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.scrollToOffset</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:14</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:18</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="shouldMoveItemAtIndex" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>should<wbr/>Move<wbr/>Item<wbr/>At<wbr/>Index</span><a href="#shouldMoveItemAtIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
@@ -1268,7 +1270,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> pointer: <span class="
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides CollectionViewBase.startDragging</p>
 <ul>
-<li>Defined in packages/collectionview/index.d.ts:19</li></ul></aside></li></ul></section>
+<li>Defined in packages/collectionview/index.d.ts:23</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="suspendUpdates" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>suspend<wbr/>Updates</span><a href="#suspendUpdates" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">