-
Notifications
You must be signed in to change notification settings - Fork 30
/
Copy pathStructs.html
282 lines (270 loc) · 14.8 KB
/
Structs.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structures 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/Structures" class="dashAnchor"></a>
<a title="Structures 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" />
Structures 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>Structures</h1>
<p>The following structures are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData11CellActionsV"></a>
<a name="//apple_ref/swift/Struct/CellActions" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData11CellActionsV">CellActions</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The actions property exposed on the CellConfigType represents possible events that will be executed based on the users interaction with that particular cell. Of note are the <code>selectionAction</code> and <code>previewingViewControllerAction</code>. The <code>selectionAction</code> is executed when the user taps on that particular cell. The main use case for this is present a new detail view controller or a modal (but is not constrained to these actions, these are just the common use cases). The <code>previewingViewControllerAction</code> is responsible for returning an instance of a UIViewController that will be shown when a user 3D-touches on a cell.</p>
<a href="Structs/CellActions.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">struct</span> <span class="kt">CellActions</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CellActions.swift#L13-L82">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData9CellStyleV"></a>
<a name="//apple_ref/swift/Struct/CellStyle" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData9CellStyleV">CellStyle</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Defines the presentation information of an item inside a <code><a href="Structs/TableSection.html">TableSection</a></code>.</p>
<p>Some properties are only supported by <code>UITableView</code>.</p>
<a href="Structs/CellStyle.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">struct</span> <span class="kt">CellStyle</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CellStyle.swift#L15-L196">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData8HostCellV"></a>
<a name="//apple_ref/swift/Struct/HostCell" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData8HostCellV">HostCell</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Defines the view, state and layout information of a row item inside a TableSection.
It relies on you to build UIView subclasses and use those instead of implementing UITableViewCell or UICollectionViewCell subclasses. This has the side effect of building better more reusable view components. This greatly simplifies composition by combining several host-cells into more complex layouts. It also makes equality simpler and more <q>Swifty</q> by requiring that anything provided as State only requires that the State object conform to the Equatable protocol. The View portion of the generic only requires it to be a UIView subclass.</p>
<a href="Structs/HostCell.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">struct</span> <span class="kt">HostCell</span><span class="o"><</span><span class="kt">View</span><span class="p">,</span> <span class="kt">State</span><span class="p">,</span> <span class="kt">Layout</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="Protocols/CellConfigType.html">CellConfigType</a></span> <span class="k">where</span> <span class="kt">View</span> <span class="p">:</span> <span class="kt">UIView</span><span class="p">,</span> <span class="kt">State</span> <span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Layout</span> <span class="p">:</span> <span class="kt">TableItemLayout</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/HostCell.swift#L13-L107">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableData0B7SectionV"></a>
<a name="//apple_ref/swift/Struct/TableSection" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableData0B7SectionV">TableSection</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Defines the style, and state information of a section.</p>
<p><code><a href="Classes/FunctionalTableData.html">FunctionalTableData</a></code> deals in arrays of <code>TableSection</code> instances. Each section, at a minimum, has a string value unique within the table itself, and an array of <code><a href="Protocols/CellConfigType.html">CellConfigType</a></code> instances that represent the rows of the section. Additionally there may be a header and footer for the section.</p>
<a href="Structs/TableSection.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">struct</span> <span class="kt">TableSection</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt"><a href="Protocols/TableSectionType.html">TableSectionType</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/TableSection.swift#L32-L115">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>