This repository was archived by the owner on Jun 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
519 lines (460 loc) · 31.6 KB
/
index.html
File metadata and controls
519 lines (460 loc) · 31.6 KB
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>go~mus-components Documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="https://giantmonkey.github.io/gomus-components-doc/images/favicon.ico">
<link rel="stylesheet" href="https://giantmonkey.github.io/gomus-components-doc/styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="./" class="navbar-brand">go~mus-components Documentation</a>
<button type="button" class="btn btn-default btn-menu fa fa-bars" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search">
</div>
<nav>
<ul class="list">
<li class="copyright logo">
<a href="https://giantmonkey.github.io/gomus-components-doc/">
<img src="http://gomus.de/wp-content/uploads/2016/06/gomus_label_300x300.png" width="100" height="100" alt="" class="img-responsive">
</a>
</li>
<li class="divider"></li>
<form>
<div class="form-group">
<select class="form-control version-select" id="version">
</select>
</div>
</form>
<li class="chapter">
<a data-type="chapter-link" href="./index.html"><span class="fa fa-home"></span>Getting started</a>
<ul class="links">
<li class="link">
<a href="./index.html" class="active" ><span class="fa fa-file-text-o"></span>README</a>
</li>
<li class="link">
<a href="https://giantmonkey.github.io/gomus-components-doc/changelog.html"
>
<span class="fa fa-file-text-o"></span>CHANGELOG
</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-additional-pages"
>
<span class="fa fa-book"></span>
<span>Documentation</span>
<span class="fa fa-angle-up"></span>
</div>
<ul class="links collapse in"
id="xs-additional-pages"
>
<li class="link ">
<a href="./additional-documentation/getting-started.html" >Getting Started</a>
</li>
<li class="link ">
<a href="./additional-documentation/best-practices.html" >Best Practices</a>
</li>
<li class="link ">
<a href="./additional-documentation/top-level-components.html" >Top Level Components</a>
</li>
<li class="link ">
<a href="./additional-documentation/setup-&-deployment.html" >Setup & Deployment</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-components-links"
>
<span class="fa fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse "
id="xs-components-links"
>
<li class="link">
<a href="./components/CartButtonComponent.html" >CartButtonComponent</a>
</li>
<li class="link">
<a href="./components/CartComponent.html" >CartComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutComponent.html" >CheckoutComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutFailureComponent.html" >CheckoutFailureComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutPendingComponent.html" >CheckoutPendingComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutSuccessComponent.html" >CheckoutSuccessComponent</a>
</li>
<li class="link">
<a href="./components/InputErrorComponent.html" >InputErrorComponent</a>
</li>
<li class="link">
<a href="./components/OptionComponent.html" >OptionComponent</a>
</li>
<li class="link">
<a href="./components/ProductBreadcrumbsComponent.html" >ProductBreadcrumbsComponent</a>
</li>
<li class="link">
<a href="./components/ProductComponent.html" >ProductComponent</a>
</li>
<li class="link">
<a href="./components/ProductDateComponent.html" >ProductDateComponent</a>
</li>
<li class="link">
<a href="./components/ProductDetailComponent.html" >ProductDetailComponent</a>
</li>
<li class="link">
<a href="./components/ProductFiltersComponent.html" >ProductFiltersComponent</a>
</li>
<li class="link">
<a href="./components/ProductInfoComponent.html" >ProductInfoComponent</a>
</li>
<li class="link">
<a href="./components/ProductListComponent.html" >ProductListComponent</a>
</li>
<li class="link">
<a href="./components/ProductPricesComponent.html" >ProductPricesComponent</a>
</li>
<li class="link">
<a href="./components/ProductTimeComponent.html" >ProductTimeComponent</a>
</li>
<li class="link">
<a href="./components/SelectComponent.html" >SelectComponent</a>
</li>
<li class="link">
<a href="./components/TicketsBreadcrumbsComponent.html" >TicketsBreadcrumbsComponent</a>
</li>
<li class="link">
<a href="./components/TicketsComponent.html" >TicketsComponent</a>
</li>
<li class="link">
<a href="./components/TicketsDateComponent.html" >TicketsDateComponent</a>
</li>
<li class="link">
<a href="./components/TicketsTimeComponent.html" >TicketsTimeComponent</a>
</li>
<li class="link">
<a href="./components/TicketsTypeComponent.html" >TicketsTypeComponent</a>
</li>
<li class="link">
<a href="./components/TotalComponent.html" >TotalComponent</a>
</li>
<li class="link">
<a href="./components/UserAddressesComponent.html" >UserAddressesComponent</a>
</li>
<li class="link">
<a href="./components/UserComponent.html" >UserComponent</a>
</li>
<li class="link">
<a href="./components/UserDataComponent.html" >UserDataComponent</a>
</li>
<li class="link">
<a href="./components/UserGuestComponent.html" >UserGuestComponent</a>
</li>
<li class="link">
<a href="./components/UserLoginComponent.html" >UserLoginComponent</a>
</li>
<li class="link">
<a href="./components/UserNewPasswordComponent.html" >UserNewPasswordComponent</a>
</li>
<li class="link">
<a href="./components/UserOrdersComponent.html" >UserOrdersComponent</a>
</li>
<li class="link">
<a href="./components/UserOverviewComponent.html" >UserOverviewComponent</a>
</li>
<li class="link">
<a href="./components/UserPasswordResetComponent.html" >UserPasswordResetComponent</a>
</li>
<li class="link">
<a href="./components/UserProfileComponent.html" >UserProfileComponent</a>
</li>
<li class="link">
<a href="./components/UserRegistrationComponent.html" >UserRegistrationComponent</a>
</li>
<li class="link">
<a href="./components/UserToolbarComponent.html" >UserToolbarComponent</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li class="chapter issue">
<h6>Found something wrong or missing?</h6>
<h6>Tell us!</h6>
<a href="https://github.com/giantmonkey/gomus-components-doc/issues/new?title=Docs: index&body=Related%20page:%20[index]()&labels=documentation" role="tab" target="_blank" ><button class="btn btn-success" >Create issue</button></a>
</li>
<li class="divider"></li>
<li class="copyright">
Documentation generated using <a href="https://compodoc.github.io/website/" target="_blank">
<img src=".//images/compodoc-vectorise.svg" class="img-responsive">
</a>
</li>
</ul>
</nav>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<nav>
<ul class="list">
<li class="copyright logo">
<a href="https://giantmonkey.github.io/gomus-components-doc/">
<img src="http://gomus.de/wp-content/uploads/2016/06/gomus_label_300x300.png" width="100" height="100" alt="" class="img-responsive">
</a>
</li>
<li class="divider"></li>
<form>
<div class="form-group">
<select class="form-control version-select" id="version">
</select>
</div>
</form>
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search">
</div>
<li class="chapter">
<a data-type="chapter-link" href="./index.html"><span class="fa fa-home"></span>Getting started</a>
<ul class="links">
<li class="link">
<a href="./index.html" class="active" ><span class="fa fa-file-text-o"></span>README</a>
</li>
<li class="link">
<a href="https://giantmonkey.github.io/gomus-components-doc/changelog.html"
>
<span class="fa fa-file-text-o"></span>CHANGELOG
</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#additional-pages"
>
<span class="fa fa-book"></span>
<span>Documentation</span>
<span class="fa fa-angle-up"></span>
</div>
<ul class="links collapse in"
id="additional-pages"
>
<li class="link ">
<a href="./additional-documentation/getting-started.html" >Getting Started</a>
</li>
<li class="link ">
<a href="./additional-documentation/best-practices.html" >Best Practices</a>
</li>
<li class="link ">
<a href="./additional-documentation/top-level-components.html" >Top Level Components</a>
</li>
<li class="link ">
<a href="./additional-documentation/setup-&-deployment.html" >Setup & Deployment</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#components-links"
>
<span class="fa fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse "
id="components-links"
>
<li class="link">
<a href="./components/CartButtonComponent.html" >CartButtonComponent</a>
</li>
<li class="link">
<a href="./components/CartComponent.html" >CartComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutComponent.html" >CheckoutComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutFailureComponent.html" >CheckoutFailureComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutPendingComponent.html" >CheckoutPendingComponent</a>
</li>
<li class="link">
<a href="./components/CheckoutSuccessComponent.html" >CheckoutSuccessComponent</a>
</li>
<li class="link">
<a href="./components/InputErrorComponent.html" >InputErrorComponent</a>
</li>
<li class="link">
<a href="./components/OptionComponent.html" >OptionComponent</a>
</li>
<li class="link">
<a href="./components/ProductBreadcrumbsComponent.html" >ProductBreadcrumbsComponent</a>
</li>
<li class="link">
<a href="./components/ProductComponent.html" >ProductComponent</a>
</li>
<li class="link">
<a href="./components/ProductDateComponent.html" >ProductDateComponent</a>
</li>
<li class="link">
<a href="./components/ProductDetailComponent.html" >ProductDetailComponent</a>
</li>
<li class="link">
<a href="./components/ProductFiltersComponent.html" >ProductFiltersComponent</a>
</li>
<li class="link">
<a href="./components/ProductInfoComponent.html" >ProductInfoComponent</a>
</li>
<li class="link">
<a href="./components/ProductListComponent.html" >ProductListComponent</a>
</li>
<li class="link">
<a href="./components/ProductPricesComponent.html" >ProductPricesComponent</a>
</li>
<li class="link">
<a href="./components/ProductTimeComponent.html" >ProductTimeComponent</a>
</li>
<li class="link">
<a href="./components/SelectComponent.html" >SelectComponent</a>
</li>
<li class="link">
<a href="./components/TicketsBreadcrumbsComponent.html" >TicketsBreadcrumbsComponent</a>
</li>
<li class="link">
<a href="./components/TicketsComponent.html" >TicketsComponent</a>
</li>
<li class="link">
<a href="./components/TicketsDateComponent.html" >TicketsDateComponent</a>
</li>
<li class="link">
<a href="./components/TicketsTimeComponent.html" >TicketsTimeComponent</a>
</li>
<li class="link">
<a href="./components/TicketsTypeComponent.html" >TicketsTypeComponent</a>
</li>
<li class="link">
<a href="./components/TotalComponent.html" >TotalComponent</a>
</li>
<li class="link">
<a href="./components/UserAddressesComponent.html" >UserAddressesComponent</a>
</li>
<li class="link">
<a href="./components/UserComponent.html" >UserComponent</a>
</li>
<li class="link">
<a href="./components/UserDataComponent.html" >UserDataComponent</a>
</li>
<li class="link">
<a href="./components/UserGuestComponent.html" >UserGuestComponent</a>
</li>
<li class="link">
<a href="./components/UserLoginComponent.html" >UserLoginComponent</a>
</li>
<li class="link">
<a href="./components/UserNewPasswordComponent.html" >UserNewPasswordComponent</a>
</li>
<li class="link">
<a href="./components/UserOrdersComponent.html" >UserOrdersComponent</a>
</li>
<li class="link">
<a href="./components/UserOverviewComponent.html" >UserOverviewComponent</a>
</li>
<li class="link">
<a href="./components/UserPasswordResetComponent.html" >UserPasswordResetComponent</a>
</li>
<li class="link">
<a href="./components/UserProfileComponent.html" >UserProfileComponent</a>
</li>
<li class="link">
<a href="./components/UserRegistrationComponent.html" >UserRegistrationComponent</a>
</li>
<li class="link">
<a href="./components/UserToolbarComponent.html" >UserToolbarComponent</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li class="chapter issue">
<h6>Found something wrong or missing?</h6>
<h6>Tell us!</h6>
<a href="https://github.com/giantmonkey/gomus-components-doc/issues/new?title=Docs: index&body=Related%20page:%20[index]()&labels=documentation" role="tab" target="_blank" ><button class="btn btn-success" >Create issue</button></a>
</li>
<li class="divider"></li>
<li class="copyright">
Documentation generated using <a href="https://compodoc.github.io/website/" target="_blank">
<img src=".//images/compodoc-vectorise.svg" class="img-responsive">
</a>
</li>
</ul>
</nav>
</div>
<div class="content getting-started">
<div class="content-data">
<h1 id="go-mus-components">go~mus components</h1>
<!-- [](https://giantmonkey.githost.io/gomus/components/commits/master) -->
<!-- [](https://giantmonkey.githost.io/gomus/components/commits/master) -->
<h2 id="what-is-go-mus-components-">What is go~mus components?</h2>
<p><a href="https://gomus.de">go~mus</a> is a web-based software for visitor management in museums and cultural institutions. It provides the means of selling tickets or products online through different add-ons such as through an online shop or using the API.</p>
<p>These cover both extremes of the spectrum:</p>
<ul>
<li>The <a href="https://gomus.de/en/shop-en/">online shop</a> allows you to hit the ground running and start selling as soon as possible, but has often the disadvantage of double content management and navigating your users away from your website.</li>
<li>The <a href="https://gomus.de/en/api-en/">API</a> allows you to build a fully integrated application to whatever system you are currently using, but has the disadvantage of taking more time and resources to set up.</li>
</ul>
<p>go~mus components is a project that aims to meet you in the middle. It abstracts away the complicated logic that needs to happen in order to sell tickets and products from go~mus, and provides you a simple HTML API to use instead while still allowing a lot of customisation.</p>
<p>Simply put, it allows you to embed small widget-like components into your existing website to enable the selling of tickets, events and tours from <a href="https://gomus.de">go~mus</a>.</p>
<h2 id="assumptions">Assumptions</h2>
<p>This documentation assumes that you are already familiar with <a href="https://developer.mozilla.org/en-US/docs/Learn/HTML">HTML</a> and have a basic understanding of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript">JavaScript</a> and <a href="https://www.json.org/">JSON</a>. The code samples are written in HTML5, JSON and the latest JavaScript.</p>
<h2 id="compatibility">Compatibility</h2>
<p>This project is compatible with version 4 of the go~mus API. The documentation for which can be found online under: <a href="https://giantmonkey.github.io/gomus-api-doc">https://giantmonkey.github.io/gomus-api-doc</a></p>
<p><em>For browser compatibility please see the <a href="./additional-documentation/setup-&-deployment.html#browser-support">browser support</a> section under <a href="./additional-documentation/setup-&-deployment.html">setup and deployment</a>.</em></p>
<h2 id="project-status">Project status</h2>
<p>go~mus components is currently in beta and under active development. During beta, new features will be added regularly and APIs will evolve based on user feedback.</p>
<p><em>IMPORTANT: Custom tables for dynamic component parts are not possible due to strict browser rules. Flex or other CSS will need to be used instead.</em></p>
<!-- Stable and experimental components and their APIs are marked using the `@stable` and `@experimental` flags. -->
<h2 id="feedback">Feedback</h2>
<p>You can help us!</p>
<p>You can <a href="https://github.com/giantmonkey/gomus-components-doc/issues/new">create issues</a>, albeit documentation issues or code issues, on the <a href="https://github.com/giantmonkey/gomus-components-doc">Components Github repository</a>.</p>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/bootstrap-native.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/es6-shim.min.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/EventDispatcher.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/promise.min.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/zepto.min.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/compodoc.js"></script>
<script>var COMPODOC_CURRENT_PAGE_DEPTH = 0;</script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/search/search.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/search/lunr.min.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/search/search-lunr.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/tabs.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/menu.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/libs/prism.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/sourceCode.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/search/search_index.js"></script>
<script src="https://giantmonkey.github.io/gomus-components-doc/js/version.js"></script>
</body>
</html>