Skip to content
This repository was archived by the owner on Apr 14, 2020. It is now read-only.

Commit 067e545

Browse files
committed
chore: update readme
1 parent 627d89d commit 067e545

33 files changed

Lines changed: 709 additions & 422 deletions

README.md

Lines changed: 276 additions & 101 deletions
Large diffs are not rendered by default.

docs/typedoc/classes/baba.html

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1231,7 +1231,7 @@ <h3>TIME_<wbr>TO_<wbr>WAIT_<wbr>FOR_<wbr>NEXT_<wbr>BABA</h3>
12311231
<div class="tsd-signature tsd-kind-icon">TIME_<wbr>TO_<wbr>WAIT_<wbr>FOR_<wbr>NEXT_<wbr>BABA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;50</span></div>
12321232
<aside class="tsd-sources">
12331233
<ul>
1234-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L119">Baba/index.tsx:119</a></li>
1234+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L119">Baba/index.tsx:119</a></li>
12351235
</ul>
12361236
</aside>
12371237
</section>
@@ -1241,7 +1241,7 @@ <h3>animating</h3>
12411241
<div class="tsd-signature tsd-kind-icon">animating<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
12421242
<aside class="tsd-sources">
12431243
<ul>
1244-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L120">Baba/index.tsx:120</a></li>
1244+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L120">Baba/index.tsx:120</a></li>
12451245
</ul>
12461246
</aside>
12471247
</section>
@@ -1251,7 +1251,7 @@ <h3>container<wbr>Element</h3>
12511251
<div class="tsd-signature tsd-kind-icon">container<wbr>Element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
12521252
<aside class="tsd-sources">
12531253
<ul>
1254-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L122">Baba/index.tsx:122</a></li>
1254+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L122">Baba/index.tsx:122</a></li>
12551255
</ul>
12561256
</aside>
12571257
</section>
@@ -1261,7 +1261,7 @@ <h3>data</h3>
12611261
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../globals.html#collectordata" class="tsd-signature-type">CollectorData</a><span class="tsd-signature-symbol">[]</span></div>
12621262
<aside class="tsd-sources">
12631263
<ul>
1264-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L125">Baba/index.tsx:125</a></li>
1264+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L125">Baba/index.tsx:125</a></li>
12651265
</ul>
12661266
</aside>
12671267
</section>
@@ -1271,7 +1271,7 @@ <h3>render<wbr>Children</h3>
12711271
<div class="tsd-signature tsd-kind-icon">render<wbr>Children<span class="tsd-signature-symbol">:</span> <a href="../globals.html#collectorchildrenasfunction" class="tsd-signature-type">CollectorChildrenAsFunction</a></div>
12721272
<aside class="tsd-sources">
12731273
<ul>
1274-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L124">Baba/index.tsx:124</a></li>
1274+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L124">Baba/index.tsx:124</a></li>
12751275
</ul>
12761276
</aside>
12771277
</section>
@@ -1281,7 +1281,7 @@ <h3>target<wbr>Element</h3>
12811281
<div class="tsd-signature tsd-kind-icon">target<wbr>Element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
12821282
<aside class="tsd-sources">
12831283
<ul>
1284-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L123">Baba/index.tsx:123</a></li>
1284+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L123">Baba/index.tsx:123</a></li>
12851285
</ul>
12861286
</aside>
12871287
</section>
@@ -1291,7 +1291,7 @@ <h3>unmounting</h3>
12911291
<div class="tsd-signature tsd-kind-icon">unmounting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
12921292
<aside class="tsd-sources">
12931293
<ul>
1294-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L121">Baba/index.tsx:121</a></li>
1294+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L121">Baba/index.tsx:121</a></li>
12951295
</ul>
12961296
</aside>
12971297
</section>
@@ -1301,7 +1301,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> display<wbr>Name</h3>
13011301
<div class="tsd-signature tsd-kind-icon">display<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;Baba&quot;</span></div>
13021302
<aside class="tsd-sources">
13031303
<ul>
1304-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L112">Baba/index.tsx:112</a></li>
1304+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L112">Baba/index.tsx:112</a></li>
13051305
</ul>
13061306
</aside>
13071307
</section>
@@ -1455,7 +1455,7 @@ <h3>abort<wbr>Animations</h3>
14551455
<li class="tsd-description">
14561456
<aside class="tsd-sources">
14571457
<ul>
1458-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L126">Baba/index.tsx:126</a></li>
1458+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L126">Baba/index.tsx:126</a></li>
14591459
</ul>
14601460
</aside>
14611461
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span></h4>
@@ -1506,7 +1506,7 @@ <h3>component<wbr>Did<wbr>Mount</h3>
15061506
<aside class="tsd-sources">
15071507
<p>Overrides ComponentLifecycle.componentDidMount</p>
15081508
<ul>
1509-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L128">Baba/index.tsx:128</a></li>
1509+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L128">Baba/index.tsx:128</a></li>
15101510
</ul>
15111511
</aside>
15121512
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1524,7 +1524,7 @@ <h3>component<wbr>Did<wbr>Update</h3>
15241524
<aside class="tsd-sources">
15251525
<p>Overrides NewLifecycle.componentDidUpdate</p>
15261526
<ul>
1527-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L161">Baba/index.tsx:161</a></li>
1527+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L161">Baba/index.tsx:161</a></li>
15281528
</ul>
15291529
</aside>
15301530
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1633,7 +1633,7 @@ <h3>component<wbr>Will<wbr>Unmount</h3>
16331633
<aside class="tsd-sources">
16341634
<p>Overrides ComponentLifecycle.componentWillUnmount</p>
16351635
<ul>
1636-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L144">Baba/index.tsx:144</a></li>
1636+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L144">Baba/index.tsx:144</a></li>
16371637
</ul>
16381638
</aside>
16391639
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1651,7 +1651,7 @@ <h3>component<wbr>Will<wbr>Update</h3>
16511651
<aside class="tsd-sources">
16521652
<p>Overrides DeprecatedLifecycle.componentWillUpdate</p>
16531653
<ul>
1654-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L151">Baba/index.tsx:151</a></li>
1654+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L151">Baba/index.tsx:151</a></li>
16551655
</ul>
16561656
</aside>
16571657
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1674,7 +1674,7 @@ <h3>delayed<wbr>ClearDOMData</h3>
16741674
<li class="tsd-description">
16751675
<aside class="tsd-sources">
16761676
<ul>
1677-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L198">Baba/index.tsx:198</a></li>
1677+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L198">Baba/index.tsx:198</a></li>
16781678
</ul>
16791679
</aside>
16801680
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1691,7 +1691,7 @@ <h3>execute<wbr>Animations</h3>
16911691
<li class="tsd-description">
16921692
<aside class="tsd-sources">
16931693
<ul>
1694-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L237">Baba/index.tsx:237</a></li>
1694+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L237">Baba/index.tsx:237</a></li>
16951695
</ul>
16961696
</aside>
16971697
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1747,7 +1747,7 @@ <h3>render</h3>
17471747
<li class="tsd-description">
17481748
<aside class="tsd-sources">
17491749
<ul>
1750-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L477">Baba/index.tsx:477</a></li>
1750+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L477">Baba/index.tsx:477</a></li>
17511751
</ul>
17521752
</aside>
17531753
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
@@ -1764,7 +1764,7 @@ <h3>set<wbr>Data</h3>
17641764
<li class="tsd-description">
17651765
<aside class="tsd-sources">
17661766
<ul>
1767-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L473">Baba/index.tsx:473</a></li>
1767+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L473">Baba/index.tsx:473</a></li>
17681768
</ul>
17691769
</aside>
17701770
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1787,7 +1787,7 @@ <h3>set<wbr>React<wbr>Node</h3>
17871787
<li class="tsd-description">
17881788
<aside class="tsd-sources">
17891789
<ul>
1790-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L469">Baba/index.tsx:469</a></li>
1790+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L469">Baba/index.tsx:469</a></li>
17911791
</ul>
17921792
</aside>
17931793
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1839,7 +1839,7 @@ <h3>set<wbr>Ref</h3>
18391839
<li class="tsd-description">
18401840
<aside class="tsd-sources">
18411841
<ul>
1842-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L461">Baba/index.tsx:461</a></li>
1842+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L461">Baba/index.tsx:461</a></li>
18431843
</ul>
18441844
</aside>
18451845
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1862,7 +1862,7 @@ <h3>set<wbr>Target<wbr>Ref</h3>
18621862
<li class="tsd-description">
18631863
<aside class="tsd-sources">
18641864
<ul>
1865-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L465">Baba/index.tsx:465</a></li>
1865+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L465">Baba/index.tsx:465</a></li>
18661866
</ul>
18671867
</aside>
18681868
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1925,7 +1925,7 @@ <h3>show<wbr>Self<wbr>And<wbr>Notify<wbr>Manager</h3>
19251925
<li class="tsd-description">
19261926
<aside class="tsd-sources">
19271927
<ul>
1928-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L186">Baba/index.tsx:186</a></li>
1928+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L186">Baba/index.tsx:186</a></li>
19291929
</ul>
19301930
</aside>
19311931
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1942,7 +1942,7 @@ <h3>storeDOMData</h3>
19421942
<li class="tsd-description">
19431943
<aside class="tsd-sources">
19441944
<ul>
1945-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L204">Baba/index.tsx:204</a></li>
1945+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L204">Baba/index.tsx:204</a></li>
19461946
</ul>
19471947
</aside>
19481948
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -1958,7 +1958,7 @@ <h3>state</h3>
19581958
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
19591959
<aside class="tsd-sources">
19601960
<ul>
1961-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L114">Baba/index.tsx:114</a></li>
1961+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L114">Baba/index.tsx:114</a></li>
19621962
</ul>
19631963
</aside>
19641964
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
@@ -1967,7 +1967,7 @@ <h3>child<wbr>Props</h3>
19671967
<div class="tsd-signature tsd-kind-icon">child<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
19681968
<aside class="tsd-sources">
19691969
<ul>
1970-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L116">Baba/index.tsx:116</a></li>
1970+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L116">Baba/index.tsx:116</a></li>
19711971
</ul>
19721972
</aside>
19731973
<div class="tsd-type-declaration">
@@ -1982,7 +1982,7 @@ <h3>shown</h3>
19821982
<div class="tsd-signature tsd-kind-icon">shown<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
19831983
<aside class="tsd-sources">
19841984
<ul>
1985-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/Baba/index.tsx#L115">Baba/index.tsx:115</a></li>
1985+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/Baba/index.tsx#L115">Baba/index.tsx:115</a></li>
19861986
</ul>
19871987
</aside>
19881988
</section>

docs/typedoc/classes/babamanager.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1754,7 +1754,7 @@ <h3>on<wbr>Finish</h3>
17541754
<li class="tsd-description">
17551755
<aside class="tsd-sources">
17561756
<ul>
1757-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/BabaManager/index.tsx#L85">BabaManager/index.tsx:85</a></li>
1757+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/BabaManager/index.tsx#L85">BabaManager/index.tsx:85</a></li>
17581758
</ul>
17591759
</aside>
17601760
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1783,7 +1783,7 @@ <h3>render</h3>
17831783
<aside class="tsd-sources">
17841784
<p>Overrides Component.render</p>
17851785
<ul>
1786-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/BabaManager/index.tsx#L101">BabaManager/index.tsx:101</a></li>
1786+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/BabaManager/index.tsx#L101">BabaManager/index.tsx:101</a></li>
17871787
</ul>
17881788
</aside>
17891789
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
@@ -1873,7 +1873,7 @@ <h3>state</h3>
18731873
<aside class="tsd-sources">
18741874
<p>Overrides Component.state</p>
18751875
<ul>
1876-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/BabaManager/index.tsx#L79">BabaManager/index.tsx:79</a></li>
1876+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/BabaManager/index.tsx#L79">BabaManager/index.tsx:79</a></li>
18771877
</ul>
18781878
</aside>
18791879
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal tsd-is-external">
@@ -1882,7 +1882,7 @@ <h3>style</h3>
18821882
<div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
18831883
<aside class="tsd-sources">
18841884
<ul>
1885-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/BabaManager/index.tsx#L80">BabaManager/index.tsx:80</a></li>
1885+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/BabaManager/index.tsx#L80">BabaManager/index.tsx:80</a></li>
18861886
</ul>
18871887
</aside>
18881888
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
@@ -1891,7 +1891,7 @@ <h3>visibility</h3>
18911891
<div class="tsd-signature tsd-kind-icon">visibility<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;hidden&quot;</span></div>
18921892
<aside class="tsd-sources">
18931893
<ul>
1894-
<li>Defined in <a href="https://github.com/madou/yubaba/blob/22bfe7b/packages/yubaba/src/BabaManager/index.tsx#L81">BabaManager/index.tsx:81</a></li>
1894+
<li>Defined in <a href="https://github.com/madou/yubaba/blob/627d89d/packages/yubaba/src/BabaManager/index.tsx#L81">BabaManager/index.tsx:81</a></li>
18951895
</ul>
18961896
</aside>
18971897
</section>

0 commit comments

Comments
 (0)