@twobirds/microcomponents 0.0.4 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/MicroComponentProposal_draft.md +1 -1
  2. package/README.md +85 -36
  3. package/dist/microcomponents.d.ts +218 -2
  4. package/dist/microcomponents.d.ts.map +1 -1
  5. package/dist/microcomponents.js +237 -43
  6. package/dist/microcomponents.min.js +7 -6
  7. package/dist/microcomponents.ts +391 -201
  8. package/jsdoc.conf.json +19 -0
  9. package/microcomponents_functional_requirements.md +8 -0
  10. package/microcomponents_usage.md +56 -24
  11. package/package.json +13 -2
  12. package/public/docs/assets/highlight.css +14 -14
  13. package/public/docs/assets/search.js +1 -1
  14. package/public/docs/classes/microcomponents.MC.html +179 -41
  15. package/public/docs/classes/microcomponents_es3.MC.html +12 -12
  16. package/public/docs/functions/microcomponents_es3.__isEmpty.html +1 -1
  17. package/public/docs/index.html +18 -16
  18. package/public/docs/interfaces/microcomponents.HTMLElementMc.html +2 -2
  19. package/public/docs/modules/microcomponents.html +1 -1
  20. package/public/jsdoc/es3/files.html +216 -0
  21. package/public/jsdoc/es3/index.html +210 -0
  22. package/public/jsdoc/es3/symbols/_global_.html +368 -0
  23. package/public/jsdoc/es3/symbols/src/build_microcomponents.es3.js.html +104 -0
  24. package/public/jsdoc/es5+/files.html +218 -0
  25. package/public/jsdoc/es5+/index.html +218 -0
  26. package/public/jsdoc/es5+/symbols/MC.html +621 -0
  27. package/public/jsdoc/es5+/symbols/_global_.html +720 -0
  28. package/public/jsdoc/es5+/symbols/microcomponents.MC.html +323 -0
  29. package/public/jsdoc/es5+/symbols/src/build_microcomponents.js.html +375 -0
  30. package/src/microcomponents.ts +391 -201
@@ -0,0 +1,323 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
+ <meta name="generator" content="JsDoc Toolkit" />
7
+
8
+ <title>JsDoc Reference - microcomponents.MC</title>
9
+
10
+ <style type="text/css">
11
+ /* default.css */
12
+ body
13
+ {
14
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15
+ width: 800px;
16
+ }
17
+
18
+ .header
19
+ {
20
+ clear: both;
21
+ background-color: #ccc;
22
+ padding: 8px;
23
+ }
24
+
25
+ h1
26
+ {
27
+ font-size: 150%;
28
+ font-weight: bold;
29
+ padding: 0;
30
+ margin: 1em 0 0 .3em;
31
+ }
32
+
33
+ hr
34
+ {
35
+ border: none 0;
36
+ border-top: 1px solid #7F8FB1;
37
+ height: 1px;
38
+ }
39
+
40
+ pre.code
41
+ {
42
+ display: block;
43
+ padding: 8px;
44
+ border: 1px dashed #ccc;
45
+ }
46
+
47
+ #index
48
+ {
49
+ margin-top: 24px;
50
+ float: left;
51
+ width: 160px;
52
+ position: absolute;
53
+ left: 8px;
54
+ background-color: #F3F3F3;
55
+ padding: 8px;
56
+ }
57
+
58
+ #content
59
+ {
60
+ margin-left: 190px;
61
+ width: 600px;
62
+ }
63
+
64
+ .classList
65
+ {
66
+ list-style-type: none;
67
+ padding: 0;
68
+ margin: 0 0 0 8px;
69
+ font-family: arial, sans-serif;
70
+ font-size: 1em;
71
+ overflow: auto;
72
+ }
73
+
74
+ .classList li
75
+ {
76
+ padding: 0;
77
+ margin: 0 0 8px 0;
78
+ }
79
+
80
+ .summaryTable { width: 100%; }
81
+
82
+ h1.classTitle
83
+ {
84
+ font-size:170%;
85
+ line-height:130%;
86
+ }
87
+
88
+ h2 { font-size: 110%; }
89
+ caption, div.sectionTitle
90
+ {
91
+ background-color: #7F8FB1;
92
+ color: #fff;
93
+ font-size:130%;
94
+ text-align: left;
95
+ padding: 2px 6px 2px 6px;
96
+ border: 1px #7F8FB1 solid;
97
+ }
98
+
99
+ div.sectionTitle { margin-bottom: 8px; }
100
+ .summaryTable thead { display: none; }
101
+
102
+ .summaryTable td
103
+ {
104
+ vertical-align: top;
105
+ padding: 4px;
106
+ border-bottom: 1px #7F8FB1 solid;
107
+ border-right: 1px #7F8FB1 solid;
108
+ }
109
+
110
+ /*col#summaryAttributes {}*/
111
+ .summaryTable td.attributes
112
+ {
113
+ border-left: 1px #7F8FB1 solid;
114
+ width: 140px;
115
+ text-align: right;
116
+ }
117
+
118
+ td.attributes, .fixedFont
119
+ {
120
+ line-height: 15px;
121
+ color: #002EBE;
122
+ font-family: "Courier New",Courier,monospace;
123
+ font-size: 13px;
124
+ }
125
+
126
+ .summaryTable td.nameDescription
127
+ {
128
+ text-align: left;
129
+ font-size: 13px;
130
+ line-height: 15px;
131
+ }
132
+
133
+ .summaryTable td.nameDescription, .description
134
+ {
135
+ line-height: 15px;
136
+ padding: 4px;
137
+ padding-left: 4px;
138
+ }
139
+
140
+ .summaryTable { margin-bottom: 8px; }
141
+
142
+ ul.inheritsList
143
+ {
144
+ list-style: square;
145
+ margin-left: 20px;
146
+ padding-left: 0;
147
+ }
148
+
149
+ .detailList {
150
+ margin-left: 20px;
151
+ line-height: 15px;
152
+ }
153
+ .detailList dt { margin-left: 20px; }
154
+
155
+ .detailList .heading
156
+ {
157
+ font-weight: bold;
158
+ padding-bottom: 6px;
159
+ margin-left: 0;
160
+ }
161
+
162
+ .light, td.attributes, .light a:link, .light a:visited
163
+ {
164
+ color: #777;
165
+ font-style: italic;
166
+ }
167
+
168
+ .fineprint
169
+ {
170
+ text-align: right;
171
+ font-size: 10px;
172
+ }
173
+ </style>
174
+ </head>
175
+
176
+ <body>
177
+ <!-- ============================== header ================================= -->
178
+ <!-- begin static/header.html -->
179
+ <div id="header">
180
+ </div>
181
+ <!-- end static/header.html -->
182
+
183
+ <!-- ============================== classes index ============================ -->
184
+ <div id="index">
185
+ <!-- begin publish.classesIndex -->
186
+ <div align="center"><a href="../index.html">Class Index</a>
187
+ | <a href="../files.html">File Index</a></div>
188
+ <hr />
189
+ <h2>Classes</h2>
190
+ <ul class="classList">
191
+
192
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
193
+
194
+ <li><a href="../symbols/microcomponents.MC.html">microcomponents.MC</a></li>
195
+
196
+ </ul>
197
+ <hr />
198
+ <!-- end publish.classesIndex -->
199
+ </div>
200
+
201
+ <div id="content">
202
+ <!-- ============================== class title ============================ -->
203
+ <h1 class="classTitle">
204
+
205
+ Class microcomponents.MC
206
+ </h1>
207
+
208
+ <!-- ============================== class summary ========================== -->
209
+ <p class="description">
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <br /><i>Defined in: </i> <a href="../symbols/src/build_microcomponents.js.html">microcomponents.js</a>.
217
+
218
+ </p>
219
+
220
+ <!-- ============================== constructor summary ==================== -->
221
+
222
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class microcomponents.MC.">
223
+ <caption>Class Summary</caption>
224
+ <thead>
225
+ <tr>
226
+ <th scope="col">Constructor Attributes</th>
227
+ <th scope="col">Constructor Name and Description</th>
228
+ </tr>
229
+ </thead>
230
+ <tbody>
231
+ <tr>
232
+ <td class="attributes">&nbsp;</td>
233
+ <td class="nameDescription" >
234
+ <div class="fixedFont">
235
+ <b><a href="../symbols/microcomponents.MC.html#constructor">microcomponents.MC</a></b>()
236
+ </div>
237
+ <div class="description">Manages microcomponents (MCs) attached to DOM elements, allowing for the
238
+ addition, removal, and traversal of microcomponents across siblings, parents,
239
+ children, and descendants.</div>
240
+ </td>
241
+ </tr>
242
+ </tbody>
243
+ </table>
244
+
245
+
246
+ <!-- ============================== properties summary ===================== -->
247
+
248
+
249
+ <!-- ============================== methods summary ======================== -->
250
+
251
+ <!-- ============================== events summary ======================== -->
252
+
253
+
254
+ <!-- ============================== constructor details ==================== -->
255
+
256
+ <div class="details"><a name="constructor"> </a>
257
+ <div class="sectionTitle">
258
+ Class Detail
259
+ </div>
260
+
261
+ <div class="fixedFont">
262
+ <b>microcomponents.MC</b>()
263
+ </div>
264
+
265
+ <div class="description">
266
+ Manages microcomponents (MCs) attached to DOM elements, allowing for the
267
+ addition, removal, and traversal of microcomponents across siblings, parents,
268
+ children, and descendants.
269
+
270
+ This class provides an API for interacting with microcomponents on DOM elements.
271
+ Public microcomponents are stored on the `_mc` attribute of the DOM element, while
272
+ private microcomponents are managed internally.
273
+
274
+ </div>
275
+
276
+
277
+
278
+ <pre class="code">```javascript
279
+ // Add a microcomponent to the target element
280
+ const myMc = MC.add(
281
+ document.getElementById('myElement'),
282
+ 'myComponent',
283
+ { name: 'My Microcomponent' }
284
+ );
285
+
286
+ // Retrieve siblings of the target element with a specific microcomponent
287
+ const siblings = MC.siblings(document.getElementById('myElement'), 'myComponent');
288
+ ```</pre>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ </div>
302
+
303
+
304
+ <!-- ============================== field details ========================== -->
305
+
306
+
307
+ <!-- ============================== method details ========================= -->
308
+
309
+
310
+ <!-- ============================== event details ========================= -->
311
+
312
+
313
+ <hr />
314
+ </div>
315
+
316
+
317
+ <!-- ============================== footer ================================= -->
318
+ <div class="fineprint" style="clear:both">
319
+
320
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Oct 30 2024 20:02:49 GMT+0100 (MEZ)
321
+ </div>
322
+ </body>
323
+ </html>