Skip to content

Commit 65d6b80

Browse files
ra1028ra1028
committed
Update README and docs
1 parent bdf052f commit 65d6b80

40 files changed

+224
-88
lines changed

‎README.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,21 +195,31 @@ Since there are several style syntaxes for passing group of sections, please che
195195
```swift
196196
@IBOutlet var tableView: UITableView!
197197

198-
lazy var renderer = Renderer(
199-
target: tableView,
198+
let renderer = Renderer(
200199
adapter: UITableViewAdapter(),
201200
updater: UITableViewUpdater()
202201
)
202+
203+
override func viewDidAppear(_ animated: Bool) {
204+
super.viewDidAppear(animated)
205+
206+
renderer.target = tableView
207+
}
203208
```
204209

205210
```swift
206211
@IBOutlet var collectionView: UICollectionView!
207212

208-
lazy var renderer = Renderer(
209-
target: collectionView,
213+
let renderer = Renderer(
210214
adapter: UICollectionViewFlowLayoutAdapter(),
211215
updater: UICollectionViewUpdater()
212216
)
217+
218+
override func viewDidAppear(_ animated: Bool) {
219+
super.viewDidAppear(animated)
220+
221+
renderer.target = collectionView
222+
}
213223
```
214224

215225
```swift
@@ -397,6 +407,10 @@ Below are some of the default provided settings of `updater`.
397407
Indicating whether enables animation for diffing updates, setting `false` will perform it using `UIView.performWithoutAnimation`.
398408
Default is `true`.
399409

410+
- **isAnimationEnabledWhileScrolling**
411+
Indicating whether enables animation for diffing updates while target is scrolling, setting `false` will perform it using `UIView.performWithoutAnimation`.
412+
Default is `true`.
413+
400414
- **animatableChangeCount**
401415
The max number of changes to perform diffing updates. It falls back to `reloadData` if it exceeded.
402416
Default is `300`.

‎docs/Adapters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ <h4>Declaration</h4>
346346
</article>
347347
</div>
348348
<section class="footer">
349-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
349+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
350350
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
351351
</section>
352352
</body>

‎docs/Changesets.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ <h4>Declaration</h4>
263263
</article>
264264
</div>
265265
<section class="footer">
266-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
266+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
267267
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
268268
</section>
269269
</body>

‎docs/Classes/Renderer.html‎

Lines changed: 61 additions & 26 deletions
Large diffs are not rendered by default.

‎docs/Classes/UICollectionComponentReusableView.html‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,9 @@ <h1>UICollectionComponentReusableView</h1>
227227
<h4>Declaration</h4>
228228
<div class="language">
229229
<p class="aside-title">Swift</p>
230-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedContent</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span></code></pre>
230+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedContent</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span> <span class="p">{</span>
231+
<span class="k">get</span>
232+
<span class="p">}</span></code></pre>
231233

232234
</div>
233235
</div>
@@ -254,7 +256,9 @@ <h4>Declaration</h4>
254256
<h4>Declaration</h4>
255257
<div class="language">
256258
<p class="aside-title">Swift</p>
257-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedComponent</span><span class="p">:</span> <span class="kt"><a href="../Structs/AnyComponent.html">AnyComponent</a></span><span class="p">?</span></code></pre>
259+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedComponent</span><span class="p">:</span> <span class="kt"><a href="../Structs/AnyComponent.html">AnyComponent</a></span><span class="p">?</span> <span class="p">{</span>
260+
<span class="k">get</span>
261+
<span class="p">}</span></code></pre>
258262

259263
</div>
260264
</div>
@@ -377,7 +381,7 @@ <h4>Declaration</h4>
377381
</article>
378382
</div>
379383
<section class="footer">
380-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
384+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
381385
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
382386
</section>
383387
</body>

‎docs/Classes/UICollectionViewAdapter.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,7 @@ <h4>Declaration</h4>
676676
</article>
677677
</div>
678678
<section class="footer">
679-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
679+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
680680
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
681681
</section>
682682
</body>

‎docs/Classes/UICollectionViewAdapter/Config.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ <h4>Parameters</h4>
397397
</article>
398398
</div>
399399
<section class="footer">
400-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
400+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
401401
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
402402
</section>
403403
</body>

‎docs/Classes/UICollectionViewAdapter/SelectionContext.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ <h4>Declaration</h4>
296296
</article>
297297
</div>
298298
<section class="footer">
299-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
299+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
300300
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
301301
</section>
302302
</body>

‎docs/Classes/UICollectionViewComponentCell.html‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,9 @@ <h1>UICollectionViewComponentCell</h1>
227227
<h4>Declaration</h4>
228228
<div class="language">
229229
<p class="aside-title">Swift</p>
230-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedContent</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span></code></pre>
230+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedContent</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span> <span class="p">{</span>
231+
<span class="k">get</span>
232+
<span class="p">}</span></code></pre>
231233

232234
</div>
233235
</div>
@@ -254,7 +256,9 @@ <h4>Declaration</h4>
254256
<h4>Declaration</h4>
255257
<div class="language">
256258
<p class="aside-title">Swift</p>
257-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedComponent</span><span class="p">:</span> <span class="kt"><a href="../Structs/AnyComponent.html">AnyComponent</a></span><span class="p">?</span></code></pre>
259+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">renderedComponent</span><span class="p">:</span> <span class="kt"><a href="../Structs/AnyComponent.html">AnyComponent</a></span><span class="p">?</span> <span class="p">{</span>
260+
<span class="k">get</span>
261+
<span class="p">}</span></code></pre>
258262

259263
</div>
260264
</div>
@@ -431,7 +435,7 @@ <h4>Declaration</h4>
431435
</article>
432436
</div>
433437
<section class="footer">
434-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
438+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
435439
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
436440
</section>
437441
</body>

‎docs/Classes/UICollectionViewFlowLayoutAdapter.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ <h4>Declaration</h4>
296296
</article>
297297
</div>
298298
<section class="footer">
299-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-03-28)</p>
299+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-05-14)</p>
300300
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
301301
</section>
302302
</body>

0 commit comments

Comments
 (0)