-
Notifications
You must be signed in to change notification settings - Fork 30
/
Copy pathProtocols.html
319 lines (304 loc) · 15.8 KB
/
Protocols.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a></p>
<p class="header-right"><a href="https://github.com/shopify/FunctionalTableData"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Protocols Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/FunctionalCollectionData.html">FunctionalCollectionData</a>
</li>
<li class="nav-group-task">
<a href="Classes/FunctionalCollectionData/KeyPath.html">– KeyPath</a>
</li>
<li class="nav-group-task">
<a href="Classes/FunctionalTableData.html">FunctionalTableData</a>
</li>
<li class="nav-group-task">
<a href="Classes/FunctionalTableData.html#/s:19FunctionalTableDataAAC9ExceptionV">– Exception</a>
</li>
<li class="nav-group-task">
<a href="Classes/FunctionalTableData/KeyPath.html">– KeyPath</a>
</li>
<li class="nav-group-task">
<a href="Classes/FunctionalTableData.html#/s:19FunctionalTableDataAAC0B10AnimationsV">– TableAnimations</a>
</li>
<li class="nav-group-task">
<a href="Classes/Separator.html">Separator</a>
</li>
<li class="nav-group-task">
<a href="Classes/Separator.html#/s:19FunctionalTableData9SeparatorC5StyleO">– Style</a>
</li>
<li class="nav-group-task">
<a href="Classes/Separator.html#/s:19FunctionalTableData9SeparatorC3TagO">– Tag</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/UICollectionView.html">UICollectionView</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UITableView.html">UITableView</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UIView.html">UIView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/BackgroundViewProvider.html">BackgroundViewProvider</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CellConfigType.html">CellConfigType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/FunctionalTableDataExceptionHandler.html">FunctionalTableDataExceptionHandler</a>
</li>
<li class="nav-group-task">
<a href="Protocols/Reusable.html">Reusable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TableSectionType.html">TableSectionType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/CellActions.html">CellActions</a>
</li>
<li class="nav-group-task">
<a href="Structs/CellActions.html#/s:19FunctionalTableData11CellActionsV14SelectionStateO">– SelectionState</a>
</li>
<li class="nav-group-task">
<a href="Structs/CellStyle.html">CellStyle</a>
</li>
<li class="nav-group-task">
<a href="Structs/HostCell.html">HostCell</a>
</li>
<li class="nav-group-task">
<a href="Structs/TableSection.html">TableSection</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData22BackgroundViewProviderP"></a>
<a name="//apple_ref/swift/Protocol/BackgroundViewProvider" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData22BackgroundViewProviderP">BackgroundViewProvider</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Provide a background view to be displayed behind the other contents of a cell.
An implementation should maintain some internal state about the contents of the view.</p>
<a href="Protocols/BackgroundViewProvider.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">BackgroundViewProvider</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/BackgroundViewProvider.swift#L13-L20">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData14CellConfigTypeP"></a>
<a name="//apple_ref/swift/Protocol/CellConfigType" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData14CellConfigTypeP">CellConfigType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type that provides the information required by <code><a href="Classes/FunctionalTableData.html">FunctionalTableData</a></code> to generate cells.</p>
<p>The <code>key</code> property should be a unique String for the section that the item is contained in. It should also be representative of the item and not just a random value or UUID. This is because on an update pass the <code>key</code> is used to determine if an item has been added, moved, or removed from the data set. Using a stable value means that this can correctly be determined.</p>
<p>The <code>isEqual</code> function is used to determine if two CellConfigType’s have matching keys and they represent the same data. This allows the system to update the views state directly when something has changed instead of forcing a reload of the entire cell all the time.</p>
<p>When two items have matching <code>key</code> values but the <code>isEqual</code> call between old and new returns false the <code>update</code> function is called. It is the responsibility of this function to update the cell, and any subviews of the cell, to reflect the state.</p>
<a href="Protocols/CellConfigType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">CellConfigType</span> <span class="p">:</span> <span class="kt">CollectionItemConfigType</span><span class="p">,</span> <span class="kt">TableItemConfigType</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CellConfigType.swift#L18-L48">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData8ReusableP"></a>
<a name="//apple_ref/swift/Protocol/Reusable" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData8ReusableP">Reusable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type that identifies a dequeueable object. Used by <code><a href="Classes/FunctionalTableData.html">FunctionalTableData</a></code> to increase performance by reusing objects when it needs to, just like <code>UITableView</code> and <code>UICollectionView</code>.</p>
<a href="Protocols/Reusable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Reusable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/Reusable.swift#L12-L15">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData0B11SectionTypeP"></a>
<a name="//apple_ref/swift/Protocol/TableSectionType" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData0B11SectionTypeP">TableSectionType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type that provides the information about a section.</p>
<a href="Protocols/TableSectionType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">TableSectionType</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/TableSection.swift#L12-L27">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData0abC16ExceptionHandlerP"></a>
<a name="//apple_ref/swift/Protocol/FunctionalTableDataExceptionHandler" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData0abC16ExceptionHandlerP">FunctionalTableDataExceptionHandler</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type that provides the debugging information when an exception occurs.</p>
<a href="Protocols/FunctionalTableDataExceptionHandler.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">FunctionalTableDataExceptionHandler</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/TableView/FunctionalTableData.swift#L13-L19">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-12-12)</p>
<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>
</section>
</article>
</div>
</body>
</div>
</html>