-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
342 lines (320 loc) · 16.8 KB
/
index.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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!DOCTYPE html>
<html lang="en">
<head>
<title>MessageKit 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 title="MessageKit Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">MessageKit Docs</a> (54% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">MessageKit Reference</a>
<img id="carat" src="img/carat.png" />
MessageKit 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/AvatarView.html">AvatarView</a>
</li>
<li class="nav-group-task">
<a href="Classes/CellSizeCalculator.html">CellSizeCalculator</a>
</li>
<li class="nav-group-task">
<a href="Classes/InputBarButtonItem.html">InputBarButtonItem</a>
</li>
<li class="nav-group-task">
<a href="Classes/InputBarButtonItem/Spacing.html">– Spacing</a>
</li>
<li class="nav-group-task">
<a href="Classes/InputStackView.html">InputStackView</a>
</li>
<li class="nav-group-task">
<a href="Classes/InputStackView/Position.html">– Position</a>
</li>
<li class="nav-group-task">
<a href="Classes/InputTextView.html">InputTextView</a>
</li>
<li class="nav-group-task">
<a href="Classes/InsetLabel.html">InsetLabel</a>
</li>
<li class="nav-group-task">
<a href="Classes/LocationMessageCell.html">LocationMessageCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/LocationMessageSizeCalculator.html">LocationMessageSizeCalculator</a>
</li>
<li class="nav-group-task">
<a href="Classes/MediaMessageCell.html">MediaMessageCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/MediaMessageSizeCalculator.html">MediaMessageSizeCalculator</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageCollectionViewCell.html">MessageCollectionViewCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageContainerView.html">MessageContainerView</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageContentCell.html">MessageContentCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageInputBar.html">MessageInputBar</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageKitDateFormatter.html">MessageKitDateFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageLabel.html">MessageLabel</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageReusableView.html">MessageReusableView</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessageSizeCalculator.html">MessageSizeCalculator</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessagesCollectionView.html">MessagesCollectionView</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessagesCollectionViewFlowLayout.html">MessagesCollectionViewFlowLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessagesCollectionViewLayoutAttributes.html">MessagesCollectionViewLayoutAttributes</a>
</li>
<li class="nav-group-task">
<a href="Classes/MessagesViewController.html">MessagesViewController</a>
</li>
<li class="nav-group-task">
<a href="Classes/PlayButtonView.html">PlayButtonView</a>
</li>
<li class="nav-group-task">
<a href="Classes/SeparatorLine.html">SeparatorLine</a>
</li>
<li class="nav-group-task">
<a href="Classes/TextMessageCell.html">TextMessageCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/TextMessageSizeCalculator.html">TextMessageSizeCalculator</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/DetectorType.html">DetectorType</a>
</li>
<li class="nav-group-task">
<a href="Enums/MessageKind.html">MessageKind</a>
</li>
<li class="nav-group-task">
<a href="Enums/MessageStyle.html">MessageStyle</a>
</li>
<li class="nav-group-task">
<a href="Enums/MessageStyle/TailCorner.html">– TailCorner</a>
</li>
<li class="nav-group-task">
<a href="Enums/MessageStyle/TailStyle.html">– TailStyle</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/LocationItem.html">LocationItem</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MediaItem.html">MediaItem</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessageCellDelegate.html">MessageCellDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessageInputBarDelegate.html">MessageInputBarDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessageLabelDelegate.html">MessageLabelDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessageType.html">MessageType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessagesDataSource.html">MessagesDataSource</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessagesDisplayDelegate.html">MessagesDisplayDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MessagesLayoutDelegate.html">MessagesLayoutDelegate</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/Avatar.html">Avatar</a>
</li>
<li class="nav-group-task">
<a href="Structs/AvatarPosition.html">AvatarPosition</a>
</li>
<li class="nav-group-task">
<a href="Structs/AvatarPosition/Horizontal.html">– Horizontal</a>
</li>
<li class="nav-group-task">
<a href="Structs/AvatarPosition/Vertical.html">– Vertical</a>
</li>
<li class="nav-group-task">
<a href="Structs/LabelAlignment.html">LabelAlignment</a>
</li>
<li class="nav-group-task">
<a href="Structs/LocationMessageSnapshotOptions.html">LocationMessageSnapshotOptions</a>
</li>
<li class="nav-group-task">
<a href="Structs/Sender.html">Sender</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<p>
<img src="https://raw.githubusercontent.com/MessageKit/MessageKit/master/Assets/mklogo.png" title="MessageKit logo">
</p>
<p><a href="https://circleci.com/gh/MessageKit/MessageKit"><img src="https://circleci.com/gh/MessageKit/MessageKit.svg?style=svg" alt="CircleCI"></a>
<a href="https://codecov.io/gh/MessageKit/MessageKit"><img src="https://codecov.io/gh/MessageKit/MessageKit/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a>
<a href="https://swift.org">
<img src="https://img.shields.io/badge/Swift-4-orange.svg"
alt="Swift" />
</a>
<a href="https://cocoapods.org/">
<img src="https://cocoapod-badges.herokuapp.com/v/MessageKit/badge.png"
alt="CocoaPods">
</a>
<a href="https://developer.apple.com/xcode">
<img src="https://img.shields.io/badge/Xcode-9-blue.svg"
alt="Xcode">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-red.svg"
alt="MIT">
</a>
<a href="https://github.com/MessageKit/MessageKit/issues">
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
alt="Contributions Welcome">
</a></p>
<h2 id='table-of-contents' class='heading'>Table of Contents</h2>
<ul>
<li><a href="#goals"><strong>Goal</strong></a>📈</li>
<li><a href="#contributing"><strong>Contributing</strong></a></li>
<li><a href="#requirements"><strong>Requirements</strong></a></li>
<li><a href="https://github.com/MessageKit/MessageKit/blob/master/Code_of_Conduct.md"><strong>Code of Conduct</strong></a></li>
<li><a href="#whats-next"><strong>What’s Next</strong></a></li>
<li><a href="#contact"><strong>Contact</strong></a></li>
<li><a href="#apps-using-this-library"><strong>Apps using this library</strong></a></li>
<li><a href="#license"><strong>License</strong></a></li>
</ul>
<h2 id='goals' class='heading'>Goals</h2>
<ul>
<li>Provide a :rotating_light:safe:rotating_light: environment for others to learn and grow through Open Source.</li>
<li>Make adding Chat:speech_balloon: to a project easy.</li>
<li>Enable beautiful and customizable Chat UI’s.</li>
<li>Provide an awesome Open Source project for the iOS open source community.</li>
<li>Help others learn.</li>
</ul>
<h2 id='vision' class='heading'>Vision</h2>
<p>See <a href="https://github.com/MessageKit/MessageKit/blob/master/VISION.md">VISION.md</a> for Goals, Scope, & Technical Considerations.</p>
<h2 id='installation' class='heading'>Installation</h2>
<h3 id='a-href-https-cocoapods-org-cocoapods-a-strong-recommended-strong' class='heading'><a href="https://cocoapods.org/">CocoaPods</a> <strong>Recommended</strong></h3>
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'MessageKit'</span>
</code></pre>
<p>If your project is still using Swift 3, you can add the following code to your Podfile:</p>
<pre class="highlight ruby"><code><span class="n">target</span> <span class="s1">'TARGET_NAME'</span> <span class="k">do</span>
<span class="n">pod</span> <span class="s1">'MessageKit'</span>
<span class="p">.</span><span class="nf">.</span><span class="p">.</span>
<span class="nf">post_install</span> <span class="k">do</span> <span class="o">|</span><span class="n">installer</span><span class="o">|</span>
<span class="n">installer</span><span class="p">.</span><span class="nf">pods_project</span><span class="p">.</span><span class="nf">targets</span><span class="p">.</span><span class="nf">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">target</span><span class="o">|</span>
<span class="k">if</span> <span class="n">target</span><span class="p">.</span><span class="nf">name</span> <span class="o">==</span> <span class="s1">'MessageKit'</span>
<span class="n">target</span><span class="p">.</span><span class="nf">build_configurations</span><span class="p">.</span><span class="nf">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">config</span><span class="o">|</span>
<span class="n">config</span><span class="p">.</span><span class="nf">build_settings</span><span class="p">[</span><span class="s1">'SWIFT_VERSION'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'4.0'</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre>
<h3 id='a-href-https-github-com-carthage-carthage-carthage-a' class='heading'><a href="https://github.com/Carthage/Carthage">Carthage</a></h3>
<p>To integrate MessageKit using Carthage, add the following to your <code>Cartfile</code>:</p>
<pre class="highlight plaintext"><code>github "MessageKit/MessageKit"
</code></pre>
<h2 id='requirements' class='heading'>Requirements</h2>
<ul>
<li><strong>iOS9</strong> or later</li>
</ul>
<h2 id='contributing' class='heading'>Contributing</h2>
<p>Great! Look over these things first.</p>
<ul>
<li>Please read our <a href="https://github.com/MessageKit/MessageKit/blob/master/Code_of_Conduct.md">Code of Conduct</a></li>
<li>Check the <a href="https://github.com/MessageKit/MessageKit/blob/master/CONTRIBUTING.md">Contributing Guide Lines</a>.</li>
<li>Come join us on <a href="https://join.slack.com/t/messagekit/shared_invite/MjI4NzIzNzMyMzU0LTE1MDMwODIzMDUtYzllYzIyNTU4MA">Slack</a> and 🗣 don’t be a stranger.</li>
<li>Check out the <a href="https://github.com/MessageKit/MessageKit/issues">current issues</a> and see if you can tackle any of those.</li>
<li>Download the project and check out the current code base. Suggest any improvements by opening a new issue.</li>
<li>Check out the <a href="#whats-next">What’s Next</a> section :point_down: to see where we are headed.</li>
<li>Check <a href="https://stackoverflow.com/questions/tagged/messagekit">StackOverflow</a></li>
<li>Install <a href="https://github.com/realm/SwiftLint">SwiftLint</a> too keep yourself in :neckbeard: style.</li>
<li>Be kind and helpful.<br></li>
</ul>
<h2 id='what-39-s-next' class='heading'>What’s Next?</h2>
<p>Check out the <a href="https://github.com/MessageKit/MessageKit/releases">Releases</a> to see what we are working on next.</p>
<h2 id='contact' class='heading'>Contact</h2>
<p>Have a question or an issue about MessageKit? Create an <a href="https://github.com/MessageKit/MessageKit/issues/new">issue</a>!</p>
<p>Interested in contributing to MessageKit? Click here to join our <a href="https://join.slack.com/t/messagekit/shared_invite/MjI4NzIzNzMyMzU0LTE1MDMwODIzMDUtYzllYzIyNTU4MA">Slack</a>.</p>
<h3 id='apps-using-this-library' class='heading'>Apps using this library</h3>
<p>Add your app to the list of apps using this library and make a pull request.</p>
<ul>
<li><a href="https://www.mediquo.com">MediQuo</a></li>
</ul>
<p><em>Please provide attribution, it is greatly appreciated.</em></p>
<h2 id='core-team' class='heading'>Core Team</h2>
<ul>
<li><a href="https://github.com/sd10">@SD10</a>, Steven Deutsch</li>
<li><a href="https://github.com/nathantannar4">@nathantannar4</a>, Nathan Tannar</li>
<li><a href="https://github.com/zhongwuzw">@zhongwuzw</a>, Wu Zhong</li>
</ul>
<h2 id='thanks' class='heading'>Thanks</h2>
<p>Many thanks to <a href="https://github.com/MessageKit/MessageKit/graphs/contributors"><strong>the contributors</strong></a> of this project.</p>
<h2 id='license' class='heading'>License</h2>
<p>MessageKit is released under the <a href="https://github.com/MessageKit/MessageKit/blob/master/LICENSE.md">MIT License</a>.</p>
<h2 id='inspiration' class='heading'>Inspiration</h2>
<p>Inspired by <a href="https://github.com/jessesquires/JSQMessagesViewController">JSQMessagesViewController</a> :point_left: :100:</p>
</section>
</section>
<section id="footer">
<p>© 2018 <a class="link" href="https://github.com/MessageKit/MessageKit" target="_blank" rel="external">Steven Deutsch</a>. All rights reserved. (Last updated: 2018-06-13)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>