Skip to content

Commit 75d042a

Browse files
jessesquiresjessesquires
committed
[Docs] Gen docs for 0.1.1
1 parent da6b934 commit 75d042a

File tree

63 files changed

+1569
-759
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1569
-759
lines changed

‎docs/Classes.html

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
</head>
1212
<body>
13+
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
1314
<a title="Classes Reference"></a>
1415
<header>
1516
<div class="content-wrapper">
@@ -75,6 +76,9 @@
7576
<li class="nav-group-task">
7677
<a href="Protocols/DiffableViewModel.html">DiffableViewModel</a>
7778
</li>
79+
<li class="nav-group-task">
80+
<a href="Protocols/ReusableCellProtocol.html">ReusableCellProtocol</a>
81+
</li>
7882
<li class="nav-group-task">
7983
<a href="Protocols/ReusableCellViewModelProtocol.html">ReusableCellViewModelProtocol</a>
8084
</li>
@@ -138,26 +142,27 @@ <h1>Classes</h1>
138142
<li class="item">
139143
<div>
140144
<code>
141-
<a name="/c:@M@ReactiveLists@objc(cs)TableViewDriver"></a>
142-
<a name="//apple_ref/swift/Class/TableViewDriver" class="dashAnchor"></a>
143-
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)TableViewDriver">TableViewDriver</a>
145+
<a name="/c:@M@ReactiveLists@objc(cs)CollectionViewDriver"></a>
146+
<a name="//apple_ref/swift/Class/CollectionViewDriver" class="dashAnchor"></a>
147+
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)CollectionViewDriver">CollectionViewDriver</a>
144148
</code>
145149
</div>
146150
<div class="height-container">
147151
<div class="pointer-container"></div>
148152
<section class="section">
149153
<div class="pointer"></div>
150154
<div class="abstract">
151-
<p>A data source that drives the table views appereance and behavior based on an underlying
152-
<code><a href="Structs/TableViewModel.html">TableViewModel</a></code>.</p>
155+
<p>A data source that drives the collection views appereance and behavior based on an underlying
156+
<code><a href="Structs/CollectionViewModel.html">CollectionViewModel</a></code>.</p>
153157

154-
<a href="Classes/TableViewDriver.html" class="slightly-smaller">See more</a>
158+
<a href="Classes/CollectionViewDriver.html" class="slightly-smaller">See more</a>
155159
</div>
156160
<div class="declaration">
157161
<h4>Declaration</h4>
158162
<div class="language">
159163
<p class="aside-title">Swift</p>
160-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">TableViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
164+
<pre class="highlight swift"><code><span class="kd">@objc</span>
165+
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
161166

162167
</div>
163168
</div>
@@ -171,26 +176,27 @@ <h4>Declaration</h4>
171176
<li class="item">
172177
<div>
173178
<code>
174-
<a name="/c:@M@ReactiveLists@objc(cs)CollectionViewDriver"></a>
175-
<a name="//apple_ref/swift/Class/CollectionViewDriver" class="dashAnchor"></a>
176-
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)CollectionViewDriver">CollectionViewDriver</a>
179+
<a name="/c:@M@ReactiveLists@objc(cs)TableViewDriver"></a>
180+
<a name="//apple_ref/swift/Class/TableViewDriver" class="dashAnchor"></a>
181+
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)TableViewDriver">TableViewDriver</a>
177182
</code>
178183
</div>
179184
<div class="height-container">
180185
<div class="pointer-container"></div>
181186
<section class="section">
182187
<div class="pointer"></div>
183188
<div class="abstract">
184-
<p>A data source that drives the collection views appereance and behavior based on an underlying
185-
<code><a href="Structs/CollectionViewModel.html">CollectionViewModel</a></code>.</p>
189+
<p>A data source that drives the table views appereance and behavior based on an underlying
190+
<code><a href="Structs/TableViewModel.html">TableViewModel</a></code>.</p>
186191

187-
<a href="Classes/CollectionViewDriver.html" class="slightly-smaller">See more</a>
192+
<a href="Classes/TableViewDriver.html" class="slightly-smaller">See more</a>
188193
</div>
189194
<div class="declaration">
190195
<h4>Declaration</h4>
191196
<div class="language">
192197
<p class="aside-title">Swift</p>
193-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
198+
<pre class="highlight swift"><code><span class="kd">@objc</span>
199+
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">TableViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
194200

195201
</div>
196202
</div>
@@ -202,8 +208,8 @@ <h4>Declaration</h4>
202208
</section>
203209
</section>
204210
<section id="footer">
205-
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-02-07)</p>
206-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
211+
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-07-06)</p>
212+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
207213
</section>
208214
</article>
209215
</div>

‎docs/Classes/CollectionViewDriver.html

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,9 @@
7676
<li class="nav-group-task">
7777
<a href="../Protocols/DiffableViewModel.html">DiffableViewModel</a>
7878
</li>
79+
<li class="nav-group-task">
80+
<a href="../Protocols/ReusableCellProtocol.html">ReusableCellProtocol</a>
81+
</li>
7982
<li class="nav-group-task">
8083
<a href="../Protocols/ReusableCellViewModelProtocol.html">ReusableCellViewModelProtocol</a>
8184
</li>
@@ -132,7 +135,8 @@
132135
<h1>CollectionViewDriver</h1>
133136
<div class="declaration">
134137
<div class="language">
135-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
138+
<pre class="highlight swift"><code><span class="kd">@objc</span>
139+
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
136140

137141
</div>
138142
</div>
@@ -153,9 +157,9 @@ <h3 class="section-name">Properties</h3>
153157
<li class="item">
154158
<div>
155159
<code>
156-
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cv"></a>
160+
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cvp"></a>
157161
<a name="//apple_ref/swift/Property/collectionView" class="dashAnchor"></a>
158-
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cv">collectionView</a>
162+
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cvp">collectionView</a>
159163
</code>
160164
</div>
161165
<div class="height-container">
@@ -180,9 +184,9 @@ <h4>Declaration</h4>
180184
<li class="item">
181185
<div>
182186
<code>
183-
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv"></a>
187+
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp"></a>
184188
<a name="//apple_ref/swift/Property/collectionViewModel" class="dashAnchor"></a>
185-
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a>
189+
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a>
186190
</code>
187191
</div>
188192
<div class="height-container">
@@ -195,12 +199,12 @@ <h4>Declaration</h4>
195199
<p>When this property is set, the UI of the related <code>UICollectionView</code> will be updated.
196200
If not only the content of individual cells/sections has changed, but instead
197201
cells/sections were moved/inserted/deleted, the behavior of this setter depends on the
198-
value of the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> property.</p>
202+
value of the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> property.</p>
199203

200-
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> is set to <code>true</code>, and cells/sections have been moved/inserted/deleted,
204+
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> is set to <code>true</code>, and cells/sections have been moved/inserted/deleted,
201205
updating this property will result in the UI of the collection view being updated automatically.</p>
202206

203-
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> is set to <code>false</code>, and cells/sections have been moved/inserted/deleted,
207+
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> is set to <code>false</code>, and cells/sections have been moved/inserted/deleted,
204208
the caller must update the <code>UICollectionView</code> state manually, to bring it back in sync with
205209
the new model, e.g. by calling <code>reloadData()</code> on the collection view.</p>
206210

@@ -209,7 +213,7 @@ <h4>Declaration</h4>
209213
<h4>Declaration</h4>
210214
<div class="language">
211215
<p class="aside-title">Swift</p>
212-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collectionViewModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/CollectionViewModel.html">CollectionViewModel</a></span><span class="p">?</span></code></pre>
216+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collectionViewModel</span><span class="p">:</span> <span class="nf">CollectionViewModel</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
213217

214218
</div>
215219
</div>
@@ -219,21 +223,21 @@ <h4>Declaration</h4>
219223
<li class="item">
220224
<div>
221225
<code>
222-
<a name="/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv"></a>
226+
<a name="/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp"></a>
223227
<a name="//apple_ref/swift/Property/automaticDiffingEnabled" class="dashAnchor"></a>
224-
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a>
228+
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a>
225229
</code>
226230
</div>
227231
<div class="height-container">
228232
<div class="pointer-container"></div>
229233
<section class="section">
230234
<div class="pointer"></div>
231235
<div class="abstract">
232-
<p>If this property is set to <code>true</code>, updating the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a></code> will always
236+
<p>If this property is set to <code>true</code>, updating the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a></code> will always
233237
automatically lead to updating the UI state of the <code>UICollectionView</code>, even if cells/sections
234238
were moved/inserted/deleted.</p>
235239

236-
<p>For details, see the documentation for <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">CollectionViewDriver.collectionViewModel</a></code>.</p>
240+
<p>For details, see the documentation for <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">CollectionViewDriver.collectionViewModel</a></code>.</p>
237241

238242
</div>
239243
<div class="declaration">
@@ -374,7 +378,7 @@ <h3 class="section-name">Change and UI Update Handling</h3>
374378
<div class="abstract">
375379
<p>Updates all currently visible cells and sections, such that they reflect the latest
376380
state decribed in their respective view models. Typically this method should not be
377-
called directly, as it is called automatically whenever the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a></code> property
381+
called directly, as it is called automatically whenever the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a></code> property
378382
is updated.</p>
379383

380384
</div>
@@ -394,8 +398,8 @@ <h4>Declaration</h4>
394398
</section>
395399
</section>
396400
<section id="footer">
397-
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-02-07)</p>
398-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
401+
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-07-06)</p>
402+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
399403
</section>
400404
</article>
401405
</div>

0 commit comments

Comments
 (0)