12
12
<dt ><a href =" #dom " >dom(selector)</a > ⇒ <code ><a href =" #Dom " >Dom</a ></code ></dt >
13
13
<dd ><p >Return a new instance of _dom (the jquery clone) so the code could</p >
14
14
</dd >
15
- <dt ><a href =" #clear_userlist " >clear_userlist ()</a ></dt >
15
+ <dt ><a href =" #clearUserlist " >clearUserlist ()</a ></dt >
16
16
<dd ><p >Remove all users from the users on the
17
17
side of the screen.</p >
18
18
</dd >
19
- <dt ><a href =" #dialog_output " >dialog_output (pkg)</a ></dt >
19
+ <dt ><a href =" #dialogOutput " >dialogOutput (pkg)</a ></dt >
20
20
<dd ><p >Put a package (message) on the screen
21
21
for you or others to read.</p >
22
22
</dd >
23
- <dt ><a href =" #users_output " >users_output (users)</a ></dt >
23
+ <dt ><a href =" #usersOutput " >usersOutput (users)</a ></dt >
24
24
<dd ><p >Update the user list in the UI</p >
25
25
</dd >
26
- <dt ><a href =" #register_client " >register_client ()</a ></dt >
26
+ <dt ><a href =" #registerClient " >registerClient ()</a ></dt >
27
27
<dd ><p >We need to register this browser window (client)
28
28
to the server. We do this so we can sent private
29
29
messages to other users.</p >
30
30
</dd >
31
- <dt ><a href =" #request_userlist " >request_userlist ()</a ></dt >
31
+ <dt ><a href =" #requestUserlist " >requestUserlist ()</a ></dt >
32
32
<dd ><p >Request a list of current active
33
33
chat users. We do this every x seconds
34
34
so we can update the ui.</p >
35
35
</dd >
36
- <dt ><a href =" #send_message " >send_message ()</a ></dt >
36
+ <dt ><a href =" #sendMessage " >sendMessage ()</a ></dt >
37
37
<dd ><p >Send a chat message to the server</p >
38
38
</dd >
39
39
</dl >
@@ -47,7 +47,6 @@ This file provides a replacement for jquery.
47
47
48
48
* [ Dom] ( #Dom )
49
49
* [ new Dom(selector)] ( #new_Dom_new )
50
- * [ .on] ( #Dom+on )
51
50
* [ .hide()] ( #Dom+hide )
52
51
* [ .show()] ( #Dom+show )
53
52
* [.get()](#Dom+get) ⇒ <code>HTMLElement</code> \| <code>HTMLSelectElement</code> \| <code>HTMLLegendElement</code> \| <code>HTMLTableCaptionElement</code> \| <code>HTMLTextAreaElement</code> \| <code>HTMLModElement</code> \| <code>HTMLHRElement</code> \| <code>HTMLOutputElement</code> \| <code>HTMLPreElement</code> \| <code>HTMLEmbedElement</code> \| <code>HTMLCanvasElement</code> \| <code>HTMLFrameSetElement</code> \| <code>HTMLMarqueeElement</code> \| <code>HTMLScriptElement</code> \| <code>HTMLInputElement</code> \| <code>HTMLUnknownElement</code> \| <code>HTMLMetaElement</code> \| <code>HTMLStyleElement</code> \| <code>HTMLObjectElement</code> \| <code>HTMLTemplateElement</code> \| <code>HTMLBRElement</code> \| <code>HTMLAudioElement</code> \| <code>HTMLIFrameElement</code> \| <code>HTMLMapElement</code> \| <code>HTMLTableElement</code> \| <code>HTMLAnchorElement</code> \| <code>HTMLMenuElement</code> \| <code>HTMLPictureElement</code> \| <code>HTMLParagraphElement</code> \| <code>HTMLTableDataCellElement</code> \| <code>HTMLTableSectionElement</code> \| <code>HTMLQuoteElement</code> \| <code>HTMLTableHeaderCellElement</code> \| <code>HTMLProgressElement</code> \| <code>HTMLLIElement</code> \| <code>HTMLTableRowElement</code> \| <code>HTMLFontElement</code> \| <code>HTMLSpanElement</code> \| <code>HTMLTableColElement</code> \| <code>HTMLOptGroupElement</code> \| <code>HTMLDataElement</code> \| <code>HTMLDListElement</code> \| <code>HTMLFieldSetElement</code> \| <code>HTMLSourceElement</code> \| <code>HTMLBodyElement</code> \| <code>HTMLDirectoryElement</code> \| <code>HTMLDivElement</code> \| <code>HTMLUListElement</code> \| <code>HTMLHtmlElement</code> \| <code>HTMLAreaElement</code> \| <code>HTMLMeterElement</code> \| <code>HTMLAppletElement</code> \| <code>HTMLFrameElement</code> \| <code>HTMLOptionElement</code> \| <code>HTMLImageElement</code> \| <code>HTMLLinkElement</code> \| <code>HTMLHeadingElement</code> \| <code>HTMLSlotElement</code> \| <code>HTMLVideoElement</code> \| <code>HTMLBaseFontElement</code> \| <code>HTMLTitleElement</code> \| <code>HTMLButtonElement</code> \| <code>HTMLHeadElement</code> \| <code>HTMLParamElement</code> \| <code>HTMLTrackElement</code> \| <code>HTMLOListElement</code> \| <code>HTMLDataListElement</code> \| <code>HTMLLabelElement</code> \| <code>HTMLFormElement</code> \| <code>HTMLTimeElement</code> \| <code>HTMLBaseElement</code> \| <code>null</code> \| <code>\*</code>
@@ -58,6 +57,7 @@ This file provides a replacement for jquery.
58
57
* [ .text([ value] )] ( #Dom+text ) ⇒ <code >string</code > \| <code >number</code >
59
58
* [ .addClass(className)] ( #Dom+addClass )
60
59
* [ .removeClass(className)] ( #Dom+removeClass )
60
+ * [ .on(event, callback)] ( #Dom+on )
61
61
62
62
<a name =" new_Dom_new " ></a >
63
63
@@ -69,18 +69,6 @@ Construct with a selector that's all to it.
69
69
| --- | --- | --- |
70
70
| selector | <code >string</code > | The selector for the element to query. |
71
71
72
- <a name =" Dom+on " ></a >
73
-
74
- ### dom.on
75
- Ad a EventListener for the dom element
76
-
77
- ** Kind** : instance property of [ <code >Dom</code >] ( #Dom )
78
-
79
- | Param | Type | Description |
80
- | --- | --- | --- |
81
- | event | <code >Event</code > | The event name. |
82
- | callback | | |
83
-
84
72
<a name =" Dom+hide " ></a >
85
73
86
74
### dom.hide()
@@ -109,7 +97,7 @@ Get or set a property on a dom element. Don't passthe value parameter if you wa
109
97
| Param | Type | Default | Description |
110
98
| --- | --- | --- | --- |
111
99
| attribute | <code >string</code > | | The attribute name |
112
- | [ value] | <code >string</code > | <code >null </code > | Value to set (optional) |
100
+ | [ value] | <code >string</code > | <code >& quot ; &#x 27 ;&#x 27 ; & quot ; </code > | Value to set (optional) |
113
101
114
102
<a name =" Dom+removeAttr " ></a >
115
103
@@ -177,6 +165,18 @@ Remove a class from the given element
177
165
| --- | --- | --- |
178
166
| className | <code >string</code > | Classname to remove. |
179
167
168
+ <a name =" Dom+on " ></a >
169
+
170
+ ### dom.on(event, callback)
171
+ Ad a EventListener for the dom element
172
+
173
+ ** Kind** : instance method of [ <code >Dom</code >] ( #Dom )
174
+
175
+ | Param | Type | Description |
176
+ | --- | --- | --- |
177
+ | event | <code >string</code > | The event name. |
178
+ | callback | | |
179
+
180
180
<a name =" dom " ></a >
181
181
182
182
## dom(selector) ⇒ [ <code >Dom</code >] ( #Dom )
@@ -188,15 +188,15 @@ Return a new instance of _dom (the jquery clone) so the code could
188
188
| --- | --- | --- |
189
189
| selector | <code >string</code > | The selector for the dom element. |
190
190
191
- <a name =" clear_userlist " ></a >
191
+ <a name =" clearUserlist " ></a >
192
192
193
- ## clear_userlist ()
193
+ ## clearUserlist ()
194
194
Remove all users from the users on the side of the screen.
195
195
196
196
** Kind** : global function
197
- <a name =" dialog_output " ></a >
197
+ <a name =" dialogOutput " ></a >
198
198
199
- ## dialog_output (pkg)
199
+ ## dialogOutput (pkg)
200
200
Put a package (message) on the screen for you or others to read.
201
201
202
202
** Kind** : global function
@@ -205,9 +205,9 @@ Put a package (message) on the screenfor you or others to read.
205
205
| --- | --- | --- |
206
206
| pkg | <code >object</code > | The package object to display. |
207
207
208
- <a name =" users_output " ></a >
208
+ <a name =" usersOutput " ></a >
209
209
210
- ## users_output (users)
210
+ ## usersOutput (users)
211
211
Update the user list in the UI
212
212
213
213
** Kind** : global function
@@ -216,64 +216,64 @@ Update the user list in the UI
216
216
| --- | --- | --- |
217
217
| users | <code >array</code > | Array of uses to display in the chatroom. |
218
218
219
- <a name =" users_output..selected_user " ></a >
219
+ <a name =" usersOutput..selectedUser " ></a >
220
220
221
- ### users_output ~ selected_user
221
+ ### usersOutput ~ selectedUser
222
222
First get the current select value on the list. This is so we can restore the selected list item after requesting fow new users.
223
223
224
- ** Kind** : inner property of [ <code >users_output </code >] ( #users_output )
225
- <a name =" register_client " ></a >
224
+ ** Kind** : inner constant of [ <code >usersOutput </code >] ( #usersOutput )
225
+ <a name =" registerClient " ></a >
226
226
227
- ## register_client ()
227
+ ## registerClient ()
228
228
We need to register this browser window (client) to the server. We do this so we can sent private messages to other users.
229
229
230
230
** Kind** : global function
231
- <a name =" register_client ..pkg" ></a >
231
+ <a name =" registerClient ..pkg" ></a >
232
232
233
- ### register_client ~ pkg
233
+ ### registerClient ~ pkg
234
234
Create a registration package to send to the server.
235
235
236
- ** Kind** : inner property of [ <code >register_client </code >] ( #register_client )
237
- <a name =" request_userlist " ></a >
236
+ ** Kind** : inner property of [ <code >registerClient </code >] ( #registerClient )
237
+ <a name =" requestUserlist " ></a >
238
238
239
- ## request_userlist ()
239
+ ## requestUserlist ()
240
240
Request a list of current active chat users. We do this every x seconds so we can update the ui.
241
241
242
242
** Kind** : global function
243
- <a name =" send_message " ></a >
243
+ <a name =" sendMessage " ></a >
244
244
245
- ## send_message ()
245
+ ## sendMessage ()
246
246
Send a chat message to the server
247
247
248
248
** Kind** : global function
249
249
250
- * [ send_message ()] ( #send_message )
251
- * [ ~ chat_message ] ( #send_message..chat_message ) : <code >string </code >
252
- * [ ~ to_user ] ( #send_message..to_user ) : < code >string</ code >
253
- * [ ~ pkg ] ( #send_message..pkg )
254
- * [ ~ pkg_object ] ( #send_message..pkg_object ) : <code >Object</code >
250
+ * [ sendMessage ()] ( #sendMessage )
251
+ * [ ~ toUser ] ( #sendMessage..toUser ) : <code >Object </code >
252
+ * [ ~ pkg ] ( #sendMessage..pkg )
253
+ * [ ~ chatMessage ] ( #sendMessage..chatMessage ) : < code >string</ code >
254
+ * [ ~ pkgObject ] ( #sendMessage..pkgObject ) : <code >Object</code >
255
255
256
- <a name =" send_message..chat_message " ></a >
256
+ <a name =" sendMessage..toUser " ></a >
257
257
258
- ### send_message~ chat_message : <code >string</code >
259
- Catch the chat text
260
-
261
- ** Kind** : inner property of [ <code >send_message</code >] ( #send_message )
262
- <a name =" send_message..to_user " ></a >
263
-
264
- ### send_message~ to_user : <code >string</code >
258
+ ### sendMessage~ toUser : <code >Object</code >
265
259
When to_user is empty the message will be sent to all users in the chat room.
266
260
267
- ** Kind** : inner property of [ <code >send_message </code >] ( #send_message )
268
- <a name =" send_message ..pkg" ></a >
261
+ ** Kind** : inner property of [ <code >sendMessage </code >] ( #sendMessage )
262
+ <a name =" sendMessage ..pkg" ></a >
269
263
270
- ### send_message ~ pkg
264
+ ### sendMessage ~ pkg
271
265
Create a package to send to the server.
272
266
273
- ** Kind** : inner property of [ <code >send_message</code >] ( #send_message )
274
- <a name =" send_message..pkg_object " ></a >
267
+ ** Kind** : inner property of [ <code >sendMessage</code >] ( #sendMessage )
268
+ <a name =" sendMessage..chatMessage " ></a >
269
+
270
+ ### sendMessage~ chatMessage : <code >string</code >
271
+ Catch the chat text
272
+
273
+ ** Kind** : inner constant of [ <code >sendMessage</code >] ( #sendMessage )
274
+ <a name =" sendMessage..pkgObject " ></a >
275
275
276
- ### send_message ~ pkg_object : <code >Object</code >
276
+ ### sendMessage ~ pkgObject : <code >Object</code >
277
277
We need a object copy of package to send to dialog_output() but we also want to turn the original package into a string so we can send it over the socket to the server.
278
278
279
- ** Kind** : inner property of [ <code >send_message </code >] ( #send_message )
279
+ ** Kind** : inner constant of [ <code >sendMessage </code >] ( #sendMessage )
0 commit comments