Skip to content

Commit 56ede49

Browse files
committed
readme/doc
1 parent 311bd84 commit 56ede49

7 files changed

+46
-15
lines changed

docs/assets/navigation.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/collectionview.CollectionView.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ <h3 class="tsd-index-heading">Methods</h3>
113113
<a href="collectionview.CollectionView.html#_reorderItemInSource" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_reorder<wbr/>Item<wbr/>In<wbr/>Source</span></a>
114114
<a href="collectionview.CollectionView.html#addTemplate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Template</span></a>
115115
<a href="collectionview.CollectionView.html#computeSpanCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compute<wbr/>Span<wbr/>Count</span></a>
116+
<a href="collectionview.CollectionView.html#eachChildAsync" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>each<wbr/>Child<wbr/>Async</span></a>
116117
<a href="collectionview.CollectionView.html#getItemArrayAtIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Array<wbr/>At<wbr/>Index</span></a>
117118
<a href="collectionview.CollectionView.html#getItemAtIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>At<wbr/>Index</span></a>
118119
<a href="collectionview.CollectionView.html#getItemSourceAtIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Source<wbr/>At<wbr/>Index</span></a>
@@ -777,6 +778,19 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
777778
<p>Inherited from CollectionViewBase.computeSpanCount</p>
778779
<ul>
779780
<li>Defined in packages/collectionview/index-common.d.ts:103</li></ul></aside></li></ul></section>
781+
<section class="tsd-panel tsd-member"><a id="eachChildAsync" class="tsd-anchor"></a>
782+
<h3 class="tsd-anchor-link"><span>each<wbr/>Child<wbr/>Async</span><a href="#eachChildAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
783+
<ul class="tsd-signatures">
784+
<li class="tsd-signature tsd-anchor-link" id="eachChildAsync.eachChildAsync-1"><span class="tsd-kind-call-signature">each<wbr/>Child<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#eachChildAsync.eachChildAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
785+
<li class="tsd-description">
786+
<div class="tsd-parameters">
787+
<h4 class="tsd-parameters-title">Parameters</h4>
788+
<ul class="tsd-parameter-list">
789+
<li>
790+
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
791+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
792+
<ul>
793+
<li>Defined in packages/collectionview/index.d.ts:24</li></ul></aside></li></ul></section>
780794
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getItemArrayAtIndex" class="tsd-anchor"></a>
781795
<h3 class="tsd-anchor-link"><span>get<wbr/>Item<wbr/>Array<wbr/>At<wbr/>Index</span><a href="#getItemArrayAtIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
782796
<ul class="tsd-signatures tsd-is-inherited">
@@ -1364,6 +1378,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
13641378
<li><a href="#_reorderItemInSource" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_reorder<wbr/>Item<wbr/>In<wbr/>Source</span></a></li>
13651379
<li><a href="#addTemplate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Template</span></a></li>
13661380
<li><a href="#computeSpanCount" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compute<wbr/>Span<wbr/>Count</span></a></li>
1381+
<li><a href="#eachChildAsync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>each<wbr/>Child<wbr/>Async</span></a></li>
13671382
<li><a href="#getItemArrayAtIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Array<wbr/>At<wbr/>Index</span></a></li>
13681383
<li><a href="#getItemAtIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>At<wbr/>Index</span></a></li>
13691384
<li><a href="#getItemSourceAtIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Source<wbr/>At<wbr/>Index</span></a></li>

docs/classes/swipemenu.CollectionViewWithSwipeMenu.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ <h3 class="tsd-index-heading">Methods</h3>
111111
<a href="swipemenu.CollectionViewWithSwipeMenu.html#addTemplate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Template</span></a>
112112
<a href="swipemenu.CollectionViewWithSwipeMenu.html#closeCurrentMenu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close<wbr/>Current<wbr/>Menu</span></a>
113113
<a href="swipemenu.CollectionViewWithSwipeMenu.html#computeSpanCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compute<wbr/>Span<wbr/>Count</span></a>
114+
<a href="swipemenu.CollectionViewWithSwipeMenu.html#eachChildAsync" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>each<wbr/>Child<wbr/>Async</span></a>
114115
<a href="swipemenu.CollectionViewWithSwipeMenu.html#getCellView" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Cell<wbr/>View</span></a>
115116
<a href="swipemenu.CollectionViewWithSwipeMenu.html#getItemArrayAtIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Array<wbr/>At<wbr/>Index</span></a>
116117
<a href="swipemenu.CollectionViewWithSwipeMenu.html#getItemAtIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>At<wbr/>Index</span></a>
@@ -808,6 +809,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
808809
<p>Inherited from CollectionView.computeSpanCount</p>
809810
<ul>
810811
<li>Defined in packages/collectionview/index-common.d.ts:103</li></ul></aside></li></ul></section>
812+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="eachChildAsync" class="tsd-anchor"></a>
813+
<h3 class="tsd-anchor-link"><span>each<wbr/>Child<wbr/>Async</span><a href="#eachChildAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
814+
<ul class="tsd-signatures tsd-is-inherited">
815+
<li class="tsd-signature tsd-anchor-link" id="eachChildAsync.eachChildAsync-1"><span class="tsd-kind-call-signature">each<wbr/>Child<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#eachChildAsync.eachChildAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
816+
<li class="tsd-description">
817+
<div class="tsd-parameters">
818+
<h4 class="tsd-parameters-title">Parameters</h4>
819+
<ul class="tsd-parameter-list">
820+
<li>
821+
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
822+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
823+
<p>Inherited from CollectionView.eachChildAsync</p>
824+
<ul>
825+
<li>Defined in packages/collectionview/index.d.ts:24</li></ul></aside></li></ul></section>
811826
<section class="tsd-panel tsd-member"><a id="getCellView" class="tsd-anchor"></a>
812827
<h3 class="tsd-anchor-link"><span>get<wbr/>Cell<wbr/>View</span><a href="#getCellView" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
813828
<ul class="tsd-signatures">
@@ -1467,6 +1482,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
14671482
<li><a href="#addTemplate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Template</span></a></li>
14681483
<li><a href="#closeCurrentMenu" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close<wbr/>Current<wbr/>Menu</span></a></li>
14691484
<li><a href="#computeSpanCount" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compute<wbr/>Span<wbr/>Count</span></a></li>
1485+
<li><a href="#eachChildAsync" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>each<wbr/>Child<wbr/>Async</span></a></li>
14701486
<li><a href="#getCellView" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Cell<wbr/>View</span></a></li>
14711487
<li><a href="#getItemArrayAtIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>Array<wbr/>At<wbr/>Index</span></a></li>
14721488
<li><a href="#getItemAtIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Item<wbr/>At<wbr/>Index</span></a></li>

docs/enums/collectionview.ListViewViewTypes.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1>Enumeration ListViewViewTypes</h1></div>
2121
</div>
2222
<div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in packages/collectionview/index.d.ts:44</li></ul></aside>
24+
<li>Defined in packages/collectionview/index.d.ts:45</li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -40,7 +40,7 @@ <h3 class="tsd-anchor-link"><span>Item<wbr/>View</span><a href="#ItemView" aria-
4040
</div>
4141
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4242
<ul>
43-
<li>Defined in packages/collectionview/index.d.ts:48</li></ul></aside></section></section></div>
43+
<li>Defined in packages/collectionview/index.d.ts:49</li></ul></aside></section></section></div>
4444
<div class="col-sidebar">
4545
<div class="page-menu">
4646
<div class="tsd-navigation settings">

docs/interfaces/collectionview.CollectionViewItemDisplayEventData.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
2323
<ul class="tsd-hierarchy">
2424
<li><span class="target">CollectionViewItemDisplayEventData</span></li></ul></li></ul></section><aside class="tsd-sources">
2525
<ul>
26-
<li>Defined in packages/collectionview/index.d.ts:35</li></ul></aside>
26+
<li>Defined in packages/collectionview/index.d.ts:36</li></ul></aside>
2727
<section class="tsd-panel-group tsd-index-group">
2828
<section class="tsd-panel tsd-index-panel">
2929
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -42,18 +42,18 @@ <h3 class="tsd-anchor-link"><span>event<wbr/>Name</span><a href="#eventName" ari
4242
<div class="tsd-signature"><span class="tsd-kind-property">event<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
4343
<p>Overrides EventData.eventName</p>
4444
<ul>
45-
<li>Defined in packages/collectionview/index.d.ts:36</li></ul></aside></section>
45+
<li>Defined in packages/collectionview/index.d.ts:37</li></ul></aside></section>
4646
<section class="tsd-panel tsd-member"><a id="index" class="tsd-anchor"></a>
4747
<h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4848
<div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
4949
<ul>
50-
<li>Defined in packages/collectionview/index.d.ts:38</li></ul></aside></section>
50+
<li>Defined in packages/collectionview/index.d.ts:39</li></ul></aside></section>
5151
<section class="tsd-panel tsd-member"><a id="object" class="tsd-anchor"></a>
5252
<h3 class="tsd-anchor-link"><span>object</span><a href="#object" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5353
<div class="tsd-signature"><span class="tsd-kind-property">object</span><span class="tsd-signature-symbol">:</span> <a href="../classes/collectionview.CollectionView.html" class="tsd-signature-type tsd-kind-class">CollectionView</a></div><aside class="tsd-sources">
5454
<p>Overrides EventData.object</p>
5555
<ul>
56-
<li>Defined in packages/collectionview/index.d.ts:37</li></ul></aside></section></section></div>
56+
<li>Defined in packages/collectionview/index.d.ts:38</li></ul></aside></section></section></div>
5757
<div class="col-sidebar">
5858
<div class="page-menu">
5959
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)