@internetarchive/modal-manager 0.2.8 → 0.2.9-alpha.2
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.
- package/.editorconfig +29 -29
- package/.eslintrc.js +14 -14
- package/.github/workflows/ci.yml +26 -26
- package/LICENSE +661 -661
- package/README.md +139 -139
- package/custom-elements.json +170 -170
- package/demo/index.html +278 -278
- package/dist/index.d.ts +7 -7
- package/dist/index.js +5 -5
- package/dist/index.js.map +1 -1
- package/dist/src/modal-config.d.ts +92 -92
- package/dist/src/modal-config.js +22 -22
- package/dist/src/modal-config.js.map +1 -1
- package/dist/src/modal-manager-host-bridge-interface.d.ts +12 -12
- package/dist/src/modal-manager-host-bridge-interface.js.map +1 -1
- package/dist/src/modal-manager-host-bridge.d.ts +34 -34
- package/dist/src/modal-manager-host-bridge.js +62 -62
- package/dist/src/modal-manager-host-bridge.js.map +1 -1
- package/dist/src/modal-manager-interface.d.ts +25 -25
- package/dist/src/modal-manager-interface.js.map +1 -1
- package/dist/src/modal-manager-mode.d.ts +10 -10
- package/dist/src/modal-manager-mode.js +11 -11
- package/dist/src/modal-manager-mode.js.map +1 -1
- package/dist/src/modal-manager.d.ts +108 -108
- package/dist/src/modal-manager.js +189 -189
- package/dist/src/modal-manager.js.map +1 -1
- package/dist/src/modal-template.d.ts +32 -32
- package/dist/src/modal-template.js +276 -276
- package/dist/src/modal-template.js.map +1 -1
- package/dist/test/modal-config.test.d.ts +1 -1
- package/dist/test/modal-config.test.js +61 -61
- package/dist/test/modal-config.test.js.map +1 -1
- package/dist/test/modal-manager.test.d.ts +1 -1
- package/dist/test/modal-manager.test.js +200 -200
- package/dist/test/modal-manager.test.js.map +1 -1
- package/dist/test/modal-template.test.d.ts +1 -1
- package/dist/test/modal-template.test.js +95 -95
- package/dist/test/modal-template.test.js.map +1 -1
- package/docs/assets/css/main.css +2678 -2678
- package/docs/classes/_src_modal_config_.modalconfig.html +429 -429
- package/docs/classes/_src_modal_manager_.modalmanager.html +7702 -7702
- package/docs/classes/_src_modal_manager_host_bridge_.modalmanagerhostbridge.html +409 -409
- package/docs/classes/_src_modal_template_.modaltemplate.html +7096 -7096
- package/docs/enums/_src_modal_manager_mode_.modalmanagermode.html +196 -196
- package/docs/globals.html +150 -150
- package/docs/index.html +252 -252
- package/docs/interfaces/_src_modal_manager_host_bridge_interface_.modalmanagerhostbridgeinterface.html +210 -210
- package/docs/interfaces/_src_modal_manager_interface_.modalmanagerinterface.html +7095 -7095
- package/docs/modules/_index_.html +208 -208
- package/docs/modules/_src_modal_config_.html +146 -146
- package/docs/modules/_src_modal_manager_.html +146 -146
- package/docs/modules/_src_modal_manager_host_bridge_.html +146 -146
- package/docs/modules/_src_modal_manager_host_bridge_interface_.html +146 -146
- package/docs/modules/_src_modal_manager_interface_.html +146 -146
- package/docs/modules/_src_modal_manager_mode_.html +146 -146
- package/docs/modules/_src_modal_template_.html +146 -146
- package/docs/modules/_test_modal_config_test_.html +106 -106
- package/docs/modules/_test_modal_manager_test_.html +106 -106
- package/docs/modules/_test_modal_template_test_.html +106 -106
- package/index.ts +7 -7
- package/karma.conf.js +24 -24
- package/package.json +82 -82
- package/src/modal-config.ts +117 -117
- package/src/modal-manager-host-bridge-interface.ts +13 -13
- package/src/modal-manager-host-bridge.ts +82 -82
- package/src/modal-manager-interface.ts +28 -28
- package/src/modal-manager-mode.ts +10 -10
- package/src/modal-manager.ts +228 -228
- package/src/modal-template.ts +279 -279
- package/test/modal-config.test.ts +69 -69
- package/test/modal-manager.test.ts +245 -245
- package/test/modal-template.test.ts +111 -111
- package/tsconfig.json +20 -20
|
@@ -1,430 +1,430 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html class="default no-js">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>ModalConfig | @internetarchive/modal-manager</title>
|
|
7
|
-
<meta name="description" content="Documentation for @internetarchive/modal-manager">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
-
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
-
</head>
|
|
11
|
-
<body>
|
|
12
|
-
<header>
|
|
13
|
-
<div class="tsd-page-toolbar">
|
|
14
|
-
<div class="container">
|
|
15
|
-
<div class="table-wrap">
|
|
16
|
-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
-
<div class="field">
|
|
18
|
-
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
-
<input id="tsd-search-field" type="text" />
|
|
20
|
-
</div>
|
|
21
|
-
<ul class="results">
|
|
22
|
-
<li class="state loading">Preparing search index...</li>
|
|
23
|
-
<li class="state failure">The search index is not available</li>
|
|
24
|
-
</ul>
|
|
25
|
-
<a href="../index.html" class="title">@internetarchive/modal-manager</a>
|
|
26
|
-
</div>
|
|
27
|
-
<div class="table-cell" id="tsd-widgets">
|
|
28
|
-
<div id="tsd-filter">
|
|
29
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
-
<div class="tsd-filter-group">
|
|
31
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
-
<span class="tsd-select-label">All</span>
|
|
33
|
-
<ul class="tsd-select-list">
|
|
34
|
-
<li data-value="public">Public</li>
|
|
35
|
-
<li data-value="protected">Public/Protected</li>
|
|
36
|
-
<li data-value="private" class="selected">All</li>
|
|
37
|
-
</ul>
|
|
38
|
-
</div>
|
|
39
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
-
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
-
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
-
</div>
|
|
46
|
-
</div>
|
|
47
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
</div>
|
|
51
|
-
</div>
|
|
52
|
-
<div class="tsd-page-title">
|
|
53
|
-
<div class="container">
|
|
54
|
-
<ul class="tsd-breadcrumb">
|
|
55
|
-
<li>
|
|
56
|
-
<a href="../globals.html">Globals</a>
|
|
57
|
-
</li>
|
|
58
|
-
<li>
|
|
59
|
-
<a href="../modules/_src_modal_config_.html">"src/modal-config"</a>
|
|
60
|
-
</li>
|
|
61
|
-
<li>
|
|
62
|
-
<a href="_src_modal_config_.modalconfig.html">ModalConfig</a>
|
|
63
|
-
</li>
|
|
64
|
-
</ul>
|
|
65
|
-
<h1>Class ModalConfig</h1>
|
|
66
|
-
</div>
|
|
67
|
-
</div>
|
|
68
|
-
</header>
|
|
69
|
-
<div class="container container-main">
|
|
70
|
-
<div class="row">
|
|
71
|
-
<div class="col-8 col-content">
|
|
72
|
-
<section class="tsd-panel tsd-comment">
|
|
73
|
-
<div class="tsd-comment tsd-typography">
|
|
74
|
-
<div class="lead">
|
|
75
|
-
<p>Configuration to show a modal</p>
|
|
76
|
-
</div>
|
|
77
|
-
<dl class="tsd-comment-tags">
|
|
78
|
-
<dt>export</dt>
|
|
79
|
-
<dd></dd>
|
|
80
|
-
</dl>
|
|
81
|
-
</div>
|
|
82
|
-
</section>
|
|
83
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
84
|
-
<h3>Hierarchy</h3>
|
|
85
|
-
<ul class="tsd-hierarchy">
|
|
86
|
-
<li>
|
|
87
|
-
<span class="target">ModalConfig</span>
|
|
88
|
-
</li>
|
|
89
|
-
</ul>
|
|
90
|
-
</section>
|
|
91
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
92
|
-
<h2>Index</h2>
|
|
93
|
-
<section class="tsd-panel tsd-index-panel">
|
|
94
|
-
<div class="tsd-index-content">
|
|
95
|
-
<section class="tsd-index-section ">
|
|
96
|
-
<h3>Constructors</h3>
|
|
97
|
-
<ul class="tsd-index-list">
|
|
98
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
99
|
-
</ul>
|
|
100
|
-
</section>
|
|
101
|
-
<section class="tsd-index-section ">
|
|
102
|
-
<h3>Properties</h3>
|
|
103
|
-
<ul class="tsd-index-list">
|
|
104
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#closeonbackdropclick" class="tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click</a></li>
|
|
105
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#headercolor" class="tsd-kind-icon">header<wbr>Color</a></li>
|
|
106
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#headline" class="tsd-kind-icon">headline</a></li>
|
|
107
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#message" class="tsd-kind-icon">message</a></li>
|
|
108
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#processingimagemode" class="tsd-kind-icon">processing<wbr>Image<wbr>Mode</a></li>
|
|
109
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#showclosebutton" class="tsd-kind-icon">show<wbr>Close<wbr>Button</a></li>
|
|
110
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#showprocessingindicator" class="tsd-kind-icon">show<wbr>Processing<wbr>Indicator</a></li>
|
|
111
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#subtitle" class="tsd-kind-icon">subtitle</a></li>
|
|
112
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#title" class="tsd-kind-icon">title</a></li>
|
|
113
|
-
</ul>
|
|
114
|
-
</section>
|
|
115
|
-
</div>
|
|
116
|
-
</section>
|
|
117
|
-
</section>
|
|
118
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
119
|
-
<h2>Constructors</h2>
|
|
120
|
-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
121
|
-
<a name="constructor" class="tsd-anchor"></a>
|
|
122
|
-
<h3>constructor</h3>
|
|
123
|
-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
124
|
-
<li class="tsd-signature tsd-kind-icon">new <wbr>Modal<wbr>Config<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>closeOnBackdropClick<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>headerColor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>headline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>processingImageMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>showCloseButton<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>showProcessingIndicator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_modal_config_.modalconfig.html" class="tsd-signature-type">ModalConfig</a></li>
|
|
125
|
-
</ul>
|
|
126
|
-
<ul class="tsd-descriptions">
|
|
127
|
-
<li class="tsd-description">
|
|
128
|
-
<aside class="tsd-sources">
|
|
129
|
-
<ul>
|
|
130
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L75">src/modal-config.ts:75</a></li>
|
|
131
|
-
</ul>
|
|
132
|
-
</aside>
|
|
133
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
134
|
-
<ul class="tsd-parameters">
|
|
135
|
-
<li>
|
|
136
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>closeOnBackdropClick<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>headerColor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>headline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>processingImageMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>showCloseButton<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>showProcessingIndicator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
137
|
-
</li>
|
|
138
|
-
</ul>
|
|
139
|
-
<h4 class="tsd-returns-title">Returns <a href="_src_modal_config_.modalconfig.html" class="tsd-signature-type">ModalConfig</a></h4>
|
|
140
|
-
</li>
|
|
141
|
-
</ul>
|
|
142
|
-
</section>
|
|
143
|
-
</section>
|
|
144
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
145
|
-
<h2>Properties</h2>
|
|
146
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
147
|
-
<a name="closeonbackdropclick" class="tsd-anchor"></a>
|
|
148
|
-
<h3>close<wbr>OnBackdrop<wbr>Click</h3>
|
|
149
|
-
<div class="tsd-signature tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
150
|
-
<aside class="tsd-sources">
|
|
151
|
-
<ul>
|
|
152
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L75">src/modal-config.ts:75</a></li>
|
|
153
|
-
</ul>
|
|
154
|
-
</aside>
|
|
155
|
-
<div class="tsd-comment tsd-typography">
|
|
156
|
-
<div class="lead">
|
|
157
|
-
<p>Close the modal if the user taps on the background</p>
|
|
158
|
-
</div>
|
|
159
|
-
<dl class="tsd-comment-tags">
|
|
160
|
-
<dt>memberof</dt>
|
|
161
|
-
<dd><p>ModalConfig</p>
|
|
162
|
-
</dd>
|
|
163
|
-
</dl>
|
|
164
|
-
</div>
|
|
165
|
-
</section>
|
|
166
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
167
|
-
<a name="headercolor" class="tsd-anchor"></a>
|
|
168
|
-
<h3>header<wbr>Color</h3>
|
|
169
|
-
<div class="tsd-signature tsd-kind-icon">header<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
|
-
<aside class="tsd-sources">
|
|
171
|
-
<ul>
|
|
172
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L47">src/modal-config.ts:47</a></li>
|
|
173
|
-
</ul>
|
|
174
|
-
</aside>
|
|
175
|
-
<div class="tsd-comment tsd-typography">
|
|
176
|
-
<div class="lead">
|
|
177
|
-
<p>The color of the header</p>
|
|
178
|
-
</div>
|
|
179
|
-
<dl class="tsd-comment-tags">
|
|
180
|
-
<dt>memberof</dt>
|
|
181
|
-
<dd><p>ModalConfig</p>
|
|
182
|
-
</dd>
|
|
183
|
-
</dl>
|
|
184
|
-
</div>
|
|
185
|
-
</section>
|
|
186
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
187
|
-
<a name="headline" class="tsd-anchor"></a>
|
|
188
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> headline</h3>
|
|
189
|
-
<div class="tsd-signature tsd-kind-icon">headline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
190
|
-
<aside class="tsd-sources">
|
|
191
|
-
<ul>
|
|
192
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L32">src/modal-config.ts:32</a></li>
|
|
193
|
-
</ul>
|
|
194
|
-
</aside>
|
|
195
|
-
<div class="tsd-comment tsd-typography">
|
|
196
|
-
<div class="lead">
|
|
197
|
-
<p>The headline shown at the top of the content section</p>
|
|
198
|
-
</div>
|
|
199
|
-
<dl class="tsd-comment-tags">
|
|
200
|
-
<dt>memberof</dt>
|
|
201
|
-
<dd><p>ModalConfig</p>
|
|
202
|
-
</dd>
|
|
203
|
-
</dl>
|
|
204
|
-
</div>
|
|
205
|
-
</section>
|
|
206
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
207
|
-
<a name="message" class="tsd-anchor"></a>
|
|
208
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> message</h3>
|
|
209
|
-
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
210
|
-
<aside class="tsd-sources">
|
|
211
|
-
<ul>
|
|
212
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L40">src/modal-config.ts:40</a></li>
|
|
213
|
-
</ul>
|
|
214
|
-
</aside>
|
|
215
|
-
<div class="tsd-comment tsd-typography">
|
|
216
|
-
<div class="lead">
|
|
217
|
-
<p>The text shown below the headline in the content section</p>
|
|
218
|
-
</div>
|
|
219
|
-
<dl class="tsd-comment-tags">
|
|
220
|
-
<dt>memberof</dt>
|
|
221
|
-
<dd><p>ModalConfig</p>
|
|
222
|
-
</dd>
|
|
223
|
-
</dl>
|
|
224
|
-
</div>
|
|
225
|
-
</section>
|
|
226
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
227
|
-
<a name="processingimagemode" class="tsd-anchor"></a>
|
|
228
|
-
<h3>processing<wbr>Image<wbr>Mode</h3>
|
|
229
|
-
<div class="tsd-signature tsd-kind-icon">processing<wbr>Image<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
230
|
-
<aside class="tsd-sources">
|
|
231
|
-
<ul>
|
|
232
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L61">src/modal-config.ts:61</a></li>
|
|
233
|
-
</ul>
|
|
234
|
-
</aside>
|
|
235
|
-
<div class="tsd-comment tsd-typography">
|
|
236
|
-
<div class="lead">
|
|
237
|
-
<p>Set the processing image mode, currently <code>processing</code> or <code>complete</code></p>
|
|
238
|
-
</div>
|
|
239
|
-
<dl class="tsd-comment-tags">
|
|
240
|
-
<dt>memberof</dt>
|
|
241
|
-
<dd><p>ModalConfig</p>
|
|
242
|
-
</dd>
|
|
243
|
-
</dl>
|
|
244
|
-
</div>
|
|
245
|
-
</section>
|
|
246
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
247
|
-
<a name="showclosebutton" class="tsd-anchor"></a>
|
|
248
|
-
<h3>show<wbr>Close<wbr>Button</h3>
|
|
249
|
-
<div class="tsd-signature tsd-kind-icon">show<wbr>Close<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
250
|
-
<aside class="tsd-sources">
|
|
251
|
-
<ul>
|
|
252
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L68">src/modal-config.ts:68</a></li>
|
|
253
|
-
</ul>
|
|
254
|
-
</aside>
|
|
255
|
-
<div class="tsd-comment tsd-typography">
|
|
256
|
-
<div class="lead">
|
|
257
|
-
<p>Show the close button</p>
|
|
258
|
-
</div>
|
|
259
|
-
<dl class="tsd-comment-tags">
|
|
260
|
-
<dt>memberof</dt>
|
|
261
|
-
<dd><p>ModalConfig</p>
|
|
262
|
-
</dd>
|
|
263
|
-
</dl>
|
|
264
|
-
</div>
|
|
265
|
-
</section>
|
|
266
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
267
|
-
<a name="showprocessingindicator" class="tsd-anchor"></a>
|
|
268
|
-
<h3>show<wbr>Processing<wbr>Indicator</h3>
|
|
269
|
-
<div class="tsd-signature tsd-kind-icon">show<wbr>Processing<wbr>Indicator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
270
|
-
<aside class="tsd-sources">
|
|
271
|
-
<ul>
|
|
272
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L54">src/modal-config.ts:54</a></li>
|
|
273
|
-
</ul>
|
|
274
|
-
</aside>
|
|
275
|
-
<div class="tsd-comment tsd-typography">
|
|
276
|
-
<div class="lead">
|
|
277
|
-
<p>Show or hide the processing indicator</p>
|
|
278
|
-
</div>
|
|
279
|
-
<dl class="tsd-comment-tags">
|
|
280
|
-
<dt>memberof</dt>
|
|
281
|
-
<dd><p>ModalConfig</p>
|
|
282
|
-
</dd>
|
|
283
|
-
</dl>
|
|
284
|
-
</div>
|
|
285
|
-
</section>
|
|
286
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
287
|
-
<a name="subtitle" class="tsd-anchor"></a>
|
|
288
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> subtitle</h3>
|
|
289
|
-
<div class="tsd-signature tsd-kind-icon">subtitle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
290
|
-
<aside class="tsd-sources">
|
|
291
|
-
<ul>
|
|
292
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L24">src/modal-config.ts:24</a></li>
|
|
293
|
-
</ul>
|
|
294
|
-
</aside>
|
|
295
|
-
<div class="tsd-comment tsd-typography">
|
|
296
|
-
<div class="lead">
|
|
297
|
-
<p>The subtitle shown in the header under the title</p>
|
|
298
|
-
</div>
|
|
299
|
-
<dl class="tsd-comment-tags">
|
|
300
|
-
<dt>memberof</dt>
|
|
301
|
-
<dd><p>ModalConfig</p>
|
|
302
|
-
</dd>
|
|
303
|
-
</dl>
|
|
304
|
-
</div>
|
|
305
|
-
</section>
|
|
306
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
307
|
-
<a name="title" class="tsd-anchor"></a>
|
|
308
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
|
|
309
|
-
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
310
|
-
<aside class="tsd-sources">
|
|
311
|
-
<ul>
|
|
312
|
-
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L16">src/modal-config.ts:16</a></li>
|
|
313
|
-
</ul>
|
|
314
|
-
</aside>
|
|
315
|
-
<div class="tsd-comment tsd-typography">
|
|
316
|
-
<div class="lead">
|
|
317
|
-
<p>The title that shows in the header</p>
|
|
318
|
-
</div>
|
|
319
|
-
<dl class="tsd-comment-tags">
|
|
320
|
-
<dt>memberof</dt>
|
|
321
|
-
<dd><p>ModalConfig</p>
|
|
322
|
-
</dd>
|
|
323
|
-
</dl>
|
|
324
|
-
</div>
|
|
325
|
-
</section>
|
|
326
|
-
</section>
|
|
327
|
-
</div>
|
|
328
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
329
|
-
<nav class="tsd-navigation primary">
|
|
330
|
-
<ul>
|
|
331
|
-
<li class="globals ">
|
|
332
|
-
<a href="../globals.html"><em>Globals</em></a>
|
|
333
|
-
</li>
|
|
334
|
-
<li class=" tsd-kind-module">
|
|
335
|
-
<a href="../modules/_index_.html">"index"</a>
|
|
336
|
-
</li>
|
|
337
|
-
<li class="current tsd-kind-module">
|
|
338
|
-
<a href="../modules/_src_modal_config_.html">"src/modal-<wbr>config"</a>
|
|
339
|
-
</li>
|
|
340
|
-
<li class=" tsd-kind-module">
|
|
341
|
-
<a href="../modules/_src_modal_manager_.html">"src/modal-<wbr>manager"</a>
|
|
342
|
-
</li>
|
|
343
|
-
<li class=" tsd-kind-module">
|
|
344
|
-
<a href="../modules/_src_modal_manager_host_bridge_.html">"src/modal-<wbr>manager-<wbr>host-<wbr>bridge"</a>
|
|
345
|
-
</li>
|
|
346
|
-
<li class=" tsd-kind-module">
|
|
347
|
-
<a href="../modules/_src_modal_manager_host_bridge_interface_.html">"src/modal-<wbr>manager-<wbr>host-<wbr>bridge-<wbr>interface"</a>
|
|
348
|
-
</li>
|
|
349
|
-
<li class=" tsd-kind-module">
|
|
350
|
-
<a href="../modules/_src_modal_manager_interface_.html">"src/modal-<wbr>manager-<wbr>interface"</a>
|
|
351
|
-
</li>
|
|
352
|
-
<li class=" tsd-kind-module">
|
|
353
|
-
<a href="../modules/_src_modal_manager_mode_.html">"src/modal-<wbr>manager-<wbr>mode"</a>
|
|
354
|
-
</li>
|
|
355
|
-
<li class=" tsd-kind-module">
|
|
356
|
-
<a href="../modules/_src_modal_template_.html">"src/modal-<wbr>template"</a>
|
|
357
|
-
</li>
|
|
358
|
-
</ul>
|
|
359
|
-
</nav>
|
|
360
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
361
|
-
<ul class="before-current">
|
|
362
|
-
</ul>
|
|
363
|
-
<ul class="current">
|
|
364
|
-
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
365
|
-
<a href="_src_modal_config_.modalconfig.html" class="tsd-kind-icon">Modal<wbr>Config</a>
|
|
366
|
-
<ul>
|
|
367
|
-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
368
|
-
<a href="_src_modal_config_.modalconfig.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
369
|
-
</li>
|
|
370
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
371
|
-
<a href="_src_modal_config_.modalconfig.html#closeonbackdropclick" class="tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click</a>
|
|
372
|
-
</li>
|
|
373
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
374
|
-
<a href="_src_modal_config_.modalconfig.html#headercolor" class="tsd-kind-icon">header<wbr>Color</a>
|
|
375
|
-
</li>
|
|
376
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
377
|
-
<a href="_src_modal_config_.modalconfig.html#headline" class="tsd-kind-icon">headline</a>
|
|
378
|
-
</li>
|
|
379
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
380
|
-
<a href="_src_modal_config_.modalconfig.html#message" class="tsd-kind-icon">message</a>
|
|
381
|
-
</li>
|
|
382
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
383
|
-
<a href="_src_modal_config_.modalconfig.html#processingimagemode" class="tsd-kind-icon">processing<wbr>Image<wbr>Mode</a>
|
|
384
|
-
</li>
|
|
385
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
386
|
-
<a href="_src_modal_config_.modalconfig.html#showclosebutton" class="tsd-kind-icon">show<wbr>Close<wbr>Button</a>
|
|
387
|
-
</li>
|
|
388
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
389
|
-
<a href="_src_modal_config_.modalconfig.html#showprocessingindicator" class="tsd-kind-icon">show<wbr>Processing<wbr>Indicator</a>
|
|
390
|
-
</li>
|
|
391
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
392
|
-
<a href="_src_modal_config_.modalconfig.html#subtitle" class="tsd-kind-icon">subtitle</a>
|
|
393
|
-
</li>
|
|
394
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
395
|
-
<a href="_src_modal_config_.modalconfig.html#title" class="tsd-kind-icon">title</a>
|
|
396
|
-
</li>
|
|
397
|
-
</ul>
|
|
398
|
-
</li>
|
|
399
|
-
</ul>
|
|
400
|
-
<ul class="after-current">
|
|
401
|
-
</ul>
|
|
402
|
-
</nav>
|
|
403
|
-
</div>
|
|
404
|
-
</div>
|
|
405
|
-
</div>
|
|
406
|
-
<footer class="with-border-bottom">
|
|
407
|
-
<div class="container">
|
|
408
|
-
<h2>Legend</h2>
|
|
409
|
-
<div class="tsd-legend-group">
|
|
410
|
-
<ul class="tsd-legend">
|
|
411
|
-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
412
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
413
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
414
|
-
</ul>
|
|
415
|
-
<ul class="tsd-legend">
|
|
416
|
-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
417
|
-
</ul>
|
|
418
|
-
<ul class="tsd-legend">
|
|
419
|
-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
420
|
-
</ul>
|
|
421
|
-
</div>
|
|
422
|
-
</div>
|
|
423
|
-
</footer>
|
|
424
|
-
<div class="container tsd-generator">
|
|
425
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
426
|
-
</div>
|
|
427
|
-
<div class="overlay"></div>
|
|
428
|
-
<script src="../assets/js/main.js"></script>
|
|
429
|
-
</body>
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>ModalConfig | @internetarchive/modal-manager</title>
|
|
7
|
+
<meta name="description" content="Documentation for @internetarchive/modal-manager">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
</head>
|
|
11
|
+
<body>
|
|
12
|
+
<header>
|
|
13
|
+
<div class="tsd-page-toolbar">
|
|
14
|
+
<div class="container">
|
|
15
|
+
<div class="table-wrap">
|
|
16
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
+
<div class="field">
|
|
18
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
+
<input id="tsd-search-field" type="text" />
|
|
20
|
+
</div>
|
|
21
|
+
<ul class="results">
|
|
22
|
+
<li class="state loading">Preparing search index...</li>
|
|
23
|
+
<li class="state failure">The search index is not available</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<a href="../index.html" class="title">@internetarchive/modal-manager</a>
|
|
26
|
+
</div>
|
|
27
|
+
<div class="table-cell" id="tsd-widgets">
|
|
28
|
+
<div id="tsd-filter">
|
|
29
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
+
<div class="tsd-filter-group">
|
|
31
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
+
<span class="tsd-select-label">All</span>
|
|
33
|
+
<ul class="tsd-select-list">
|
|
34
|
+
<li data-value="public">Public</li>
|
|
35
|
+
<li data-value="protected">Public/Protected</li>
|
|
36
|
+
<li data-value="private" class="selected">All</li>
|
|
37
|
+
</ul>
|
|
38
|
+
</div>
|
|
39
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
+
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
</div>
|
|
52
|
+
<div class="tsd-page-title">
|
|
53
|
+
<div class="container">
|
|
54
|
+
<ul class="tsd-breadcrumb">
|
|
55
|
+
<li>
|
|
56
|
+
<a href="../globals.html">Globals</a>
|
|
57
|
+
</li>
|
|
58
|
+
<li>
|
|
59
|
+
<a href="../modules/_src_modal_config_.html">"src/modal-config"</a>
|
|
60
|
+
</li>
|
|
61
|
+
<li>
|
|
62
|
+
<a href="_src_modal_config_.modalconfig.html">ModalConfig</a>
|
|
63
|
+
</li>
|
|
64
|
+
</ul>
|
|
65
|
+
<h1>Class ModalConfig</h1>
|
|
66
|
+
</div>
|
|
67
|
+
</div>
|
|
68
|
+
</header>
|
|
69
|
+
<div class="container container-main">
|
|
70
|
+
<div class="row">
|
|
71
|
+
<div class="col-8 col-content">
|
|
72
|
+
<section class="tsd-panel tsd-comment">
|
|
73
|
+
<div class="tsd-comment tsd-typography">
|
|
74
|
+
<div class="lead">
|
|
75
|
+
<p>Configuration to show a modal</p>
|
|
76
|
+
</div>
|
|
77
|
+
<dl class="tsd-comment-tags">
|
|
78
|
+
<dt>export</dt>
|
|
79
|
+
<dd></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
</div>
|
|
82
|
+
</section>
|
|
83
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
84
|
+
<h3>Hierarchy</h3>
|
|
85
|
+
<ul class="tsd-hierarchy">
|
|
86
|
+
<li>
|
|
87
|
+
<span class="target">ModalConfig</span>
|
|
88
|
+
</li>
|
|
89
|
+
</ul>
|
|
90
|
+
</section>
|
|
91
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
92
|
+
<h2>Index</h2>
|
|
93
|
+
<section class="tsd-panel tsd-index-panel">
|
|
94
|
+
<div class="tsd-index-content">
|
|
95
|
+
<section class="tsd-index-section ">
|
|
96
|
+
<h3>Constructors</h3>
|
|
97
|
+
<ul class="tsd-index-list">
|
|
98
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
99
|
+
</ul>
|
|
100
|
+
</section>
|
|
101
|
+
<section class="tsd-index-section ">
|
|
102
|
+
<h3>Properties</h3>
|
|
103
|
+
<ul class="tsd-index-list">
|
|
104
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#closeonbackdropclick" class="tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click</a></li>
|
|
105
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#headercolor" class="tsd-kind-icon">header<wbr>Color</a></li>
|
|
106
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#headline" class="tsd-kind-icon">headline</a></li>
|
|
107
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#message" class="tsd-kind-icon">message</a></li>
|
|
108
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#processingimagemode" class="tsd-kind-icon">processing<wbr>Image<wbr>Mode</a></li>
|
|
109
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#showclosebutton" class="tsd-kind-icon">show<wbr>Close<wbr>Button</a></li>
|
|
110
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#showprocessingindicator" class="tsd-kind-icon">show<wbr>Processing<wbr>Indicator</a></li>
|
|
111
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#subtitle" class="tsd-kind-icon">subtitle</a></li>
|
|
112
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_modal_config_.modalconfig.html#title" class="tsd-kind-icon">title</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
</section>
|
|
115
|
+
</div>
|
|
116
|
+
</section>
|
|
117
|
+
</section>
|
|
118
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
119
|
+
<h2>Constructors</h2>
|
|
120
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
121
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
122
|
+
<h3>constructor</h3>
|
|
123
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
124
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>Modal<wbr>Config<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>closeOnBackdropClick<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>headerColor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>headline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>processingImageMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>showCloseButton<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>showProcessingIndicator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_modal_config_.modalconfig.html" class="tsd-signature-type">ModalConfig</a></li>
|
|
125
|
+
</ul>
|
|
126
|
+
<ul class="tsd-descriptions">
|
|
127
|
+
<li class="tsd-description">
|
|
128
|
+
<aside class="tsd-sources">
|
|
129
|
+
<ul>
|
|
130
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L75">src/modal-config.ts:75</a></li>
|
|
131
|
+
</ul>
|
|
132
|
+
</aside>
|
|
133
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
134
|
+
<ul class="tsd-parameters">
|
|
135
|
+
<li>
|
|
136
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>closeOnBackdropClick<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>headerColor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>headline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>processingImageMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>showCloseButton<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>showProcessingIndicator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TemplateResult</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
137
|
+
</li>
|
|
138
|
+
</ul>
|
|
139
|
+
<h4 class="tsd-returns-title">Returns <a href="_src_modal_config_.modalconfig.html" class="tsd-signature-type">ModalConfig</a></h4>
|
|
140
|
+
</li>
|
|
141
|
+
</ul>
|
|
142
|
+
</section>
|
|
143
|
+
</section>
|
|
144
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
145
|
+
<h2>Properties</h2>
|
|
146
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
147
|
+
<a name="closeonbackdropclick" class="tsd-anchor"></a>
|
|
148
|
+
<h3>close<wbr>OnBackdrop<wbr>Click</h3>
|
|
149
|
+
<div class="tsd-signature tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
150
|
+
<aside class="tsd-sources">
|
|
151
|
+
<ul>
|
|
152
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L75">src/modal-config.ts:75</a></li>
|
|
153
|
+
</ul>
|
|
154
|
+
</aside>
|
|
155
|
+
<div class="tsd-comment tsd-typography">
|
|
156
|
+
<div class="lead">
|
|
157
|
+
<p>Close the modal if the user taps on the background</p>
|
|
158
|
+
</div>
|
|
159
|
+
<dl class="tsd-comment-tags">
|
|
160
|
+
<dt>memberof</dt>
|
|
161
|
+
<dd><p>ModalConfig</p>
|
|
162
|
+
</dd>
|
|
163
|
+
</dl>
|
|
164
|
+
</div>
|
|
165
|
+
</section>
|
|
166
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
167
|
+
<a name="headercolor" class="tsd-anchor"></a>
|
|
168
|
+
<h3>header<wbr>Color</h3>
|
|
169
|
+
<div class="tsd-signature tsd-kind-icon">header<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
|
+
<aside class="tsd-sources">
|
|
171
|
+
<ul>
|
|
172
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L47">src/modal-config.ts:47</a></li>
|
|
173
|
+
</ul>
|
|
174
|
+
</aside>
|
|
175
|
+
<div class="tsd-comment tsd-typography">
|
|
176
|
+
<div class="lead">
|
|
177
|
+
<p>The color of the header</p>
|
|
178
|
+
</div>
|
|
179
|
+
<dl class="tsd-comment-tags">
|
|
180
|
+
<dt>memberof</dt>
|
|
181
|
+
<dd><p>ModalConfig</p>
|
|
182
|
+
</dd>
|
|
183
|
+
</dl>
|
|
184
|
+
</div>
|
|
185
|
+
</section>
|
|
186
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
187
|
+
<a name="headline" class="tsd-anchor"></a>
|
|
188
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> headline</h3>
|
|
189
|
+
<div class="tsd-signature tsd-kind-icon">headline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
190
|
+
<aside class="tsd-sources">
|
|
191
|
+
<ul>
|
|
192
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L32">src/modal-config.ts:32</a></li>
|
|
193
|
+
</ul>
|
|
194
|
+
</aside>
|
|
195
|
+
<div class="tsd-comment tsd-typography">
|
|
196
|
+
<div class="lead">
|
|
197
|
+
<p>The headline shown at the top of the content section</p>
|
|
198
|
+
</div>
|
|
199
|
+
<dl class="tsd-comment-tags">
|
|
200
|
+
<dt>memberof</dt>
|
|
201
|
+
<dd><p>ModalConfig</p>
|
|
202
|
+
</dd>
|
|
203
|
+
</dl>
|
|
204
|
+
</div>
|
|
205
|
+
</section>
|
|
206
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
207
|
+
<a name="message" class="tsd-anchor"></a>
|
|
208
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> message</h3>
|
|
209
|
+
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
210
|
+
<aside class="tsd-sources">
|
|
211
|
+
<ul>
|
|
212
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L40">src/modal-config.ts:40</a></li>
|
|
213
|
+
</ul>
|
|
214
|
+
</aside>
|
|
215
|
+
<div class="tsd-comment tsd-typography">
|
|
216
|
+
<div class="lead">
|
|
217
|
+
<p>The text shown below the headline in the content section</p>
|
|
218
|
+
</div>
|
|
219
|
+
<dl class="tsd-comment-tags">
|
|
220
|
+
<dt>memberof</dt>
|
|
221
|
+
<dd><p>ModalConfig</p>
|
|
222
|
+
</dd>
|
|
223
|
+
</dl>
|
|
224
|
+
</div>
|
|
225
|
+
</section>
|
|
226
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
227
|
+
<a name="processingimagemode" class="tsd-anchor"></a>
|
|
228
|
+
<h3>processing<wbr>Image<wbr>Mode</h3>
|
|
229
|
+
<div class="tsd-signature tsd-kind-icon">processing<wbr>Image<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
230
|
+
<aside class="tsd-sources">
|
|
231
|
+
<ul>
|
|
232
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L61">src/modal-config.ts:61</a></li>
|
|
233
|
+
</ul>
|
|
234
|
+
</aside>
|
|
235
|
+
<div class="tsd-comment tsd-typography">
|
|
236
|
+
<div class="lead">
|
|
237
|
+
<p>Set the processing image mode, currently <code>processing</code> or <code>complete</code></p>
|
|
238
|
+
</div>
|
|
239
|
+
<dl class="tsd-comment-tags">
|
|
240
|
+
<dt>memberof</dt>
|
|
241
|
+
<dd><p>ModalConfig</p>
|
|
242
|
+
</dd>
|
|
243
|
+
</dl>
|
|
244
|
+
</div>
|
|
245
|
+
</section>
|
|
246
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
247
|
+
<a name="showclosebutton" class="tsd-anchor"></a>
|
|
248
|
+
<h3>show<wbr>Close<wbr>Button</h3>
|
|
249
|
+
<div class="tsd-signature tsd-kind-icon">show<wbr>Close<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
250
|
+
<aside class="tsd-sources">
|
|
251
|
+
<ul>
|
|
252
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L68">src/modal-config.ts:68</a></li>
|
|
253
|
+
</ul>
|
|
254
|
+
</aside>
|
|
255
|
+
<div class="tsd-comment tsd-typography">
|
|
256
|
+
<div class="lead">
|
|
257
|
+
<p>Show the close button</p>
|
|
258
|
+
</div>
|
|
259
|
+
<dl class="tsd-comment-tags">
|
|
260
|
+
<dt>memberof</dt>
|
|
261
|
+
<dd><p>ModalConfig</p>
|
|
262
|
+
</dd>
|
|
263
|
+
</dl>
|
|
264
|
+
</div>
|
|
265
|
+
</section>
|
|
266
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
267
|
+
<a name="showprocessingindicator" class="tsd-anchor"></a>
|
|
268
|
+
<h3>show<wbr>Processing<wbr>Indicator</h3>
|
|
269
|
+
<div class="tsd-signature tsd-kind-icon">show<wbr>Processing<wbr>Indicator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
270
|
+
<aside class="tsd-sources">
|
|
271
|
+
<ul>
|
|
272
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L54">src/modal-config.ts:54</a></li>
|
|
273
|
+
</ul>
|
|
274
|
+
</aside>
|
|
275
|
+
<div class="tsd-comment tsd-typography">
|
|
276
|
+
<div class="lead">
|
|
277
|
+
<p>Show or hide the processing indicator</p>
|
|
278
|
+
</div>
|
|
279
|
+
<dl class="tsd-comment-tags">
|
|
280
|
+
<dt>memberof</dt>
|
|
281
|
+
<dd><p>ModalConfig</p>
|
|
282
|
+
</dd>
|
|
283
|
+
</dl>
|
|
284
|
+
</div>
|
|
285
|
+
</section>
|
|
286
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
287
|
+
<a name="subtitle" class="tsd-anchor"></a>
|
|
288
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> subtitle</h3>
|
|
289
|
+
<div class="tsd-signature tsd-kind-icon">subtitle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
290
|
+
<aside class="tsd-sources">
|
|
291
|
+
<ul>
|
|
292
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L24">src/modal-config.ts:24</a></li>
|
|
293
|
+
</ul>
|
|
294
|
+
</aside>
|
|
295
|
+
<div class="tsd-comment tsd-typography">
|
|
296
|
+
<div class="lead">
|
|
297
|
+
<p>The subtitle shown in the header under the title</p>
|
|
298
|
+
</div>
|
|
299
|
+
<dl class="tsd-comment-tags">
|
|
300
|
+
<dt>memberof</dt>
|
|
301
|
+
<dd><p>ModalConfig</p>
|
|
302
|
+
</dd>
|
|
303
|
+
</dl>
|
|
304
|
+
</div>
|
|
305
|
+
</section>
|
|
306
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
307
|
+
<a name="title" class="tsd-anchor"></a>
|
|
308
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
|
|
309
|
+
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateResult</span></div>
|
|
310
|
+
<aside class="tsd-sources">
|
|
311
|
+
<ul>
|
|
312
|
+
<li>Defined in <a href="https://github.com/internetarchive/iaux-modal-manager/blob/8f34a2b/src/modal-config.ts#L16">src/modal-config.ts:16</a></li>
|
|
313
|
+
</ul>
|
|
314
|
+
</aside>
|
|
315
|
+
<div class="tsd-comment tsd-typography">
|
|
316
|
+
<div class="lead">
|
|
317
|
+
<p>The title that shows in the header</p>
|
|
318
|
+
</div>
|
|
319
|
+
<dl class="tsd-comment-tags">
|
|
320
|
+
<dt>memberof</dt>
|
|
321
|
+
<dd><p>ModalConfig</p>
|
|
322
|
+
</dd>
|
|
323
|
+
</dl>
|
|
324
|
+
</div>
|
|
325
|
+
</section>
|
|
326
|
+
</section>
|
|
327
|
+
</div>
|
|
328
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
329
|
+
<nav class="tsd-navigation primary">
|
|
330
|
+
<ul>
|
|
331
|
+
<li class="globals ">
|
|
332
|
+
<a href="../globals.html"><em>Globals</em></a>
|
|
333
|
+
</li>
|
|
334
|
+
<li class=" tsd-kind-module">
|
|
335
|
+
<a href="../modules/_index_.html">"index"</a>
|
|
336
|
+
</li>
|
|
337
|
+
<li class="current tsd-kind-module">
|
|
338
|
+
<a href="../modules/_src_modal_config_.html">"src/modal-<wbr>config"</a>
|
|
339
|
+
</li>
|
|
340
|
+
<li class=" tsd-kind-module">
|
|
341
|
+
<a href="../modules/_src_modal_manager_.html">"src/modal-<wbr>manager"</a>
|
|
342
|
+
</li>
|
|
343
|
+
<li class=" tsd-kind-module">
|
|
344
|
+
<a href="../modules/_src_modal_manager_host_bridge_.html">"src/modal-<wbr>manager-<wbr>host-<wbr>bridge"</a>
|
|
345
|
+
</li>
|
|
346
|
+
<li class=" tsd-kind-module">
|
|
347
|
+
<a href="../modules/_src_modal_manager_host_bridge_interface_.html">"src/modal-<wbr>manager-<wbr>host-<wbr>bridge-<wbr>interface"</a>
|
|
348
|
+
</li>
|
|
349
|
+
<li class=" tsd-kind-module">
|
|
350
|
+
<a href="../modules/_src_modal_manager_interface_.html">"src/modal-<wbr>manager-<wbr>interface"</a>
|
|
351
|
+
</li>
|
|
352
|
+
<li class=" tsd-kind-module">
|
|
353
|
+
<a href="../modules/_src_modal_manager_mode_.html">"src/modal-<wbr>manager-<wbr>mode"</a>
|
|
354
|
+
</li>
|
|
355
|
+
<li class=" tsd-kind-module">
|
|
356
|
+
<a href="../modules/_src_modal_template_.html">"src/modal-<wbr>template"</a>
|
|
357
|
+
</li>
|
|
358
|
+
</ul>
|
|
359
|
+
</nav>
|
|
360
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
361
|
+
<ul class="before-current">
|
|
362
|
+
</ul>
|
|
363
|
+
<ul class="current">
|
|
364
|
+
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
365
|
+
<a href="_src_modal_config_.modalconfig.html" class="tsd-kind-icon">Modal<wbr>Config</a>
|
|
366
|
+
<ul>
|
|
367
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
368
|
+
<a href="_src_modal_config_.modalconfig.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
369
|
+
</li>
|
|
370
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
371
|
+
<a href="_src_modal_config_.modalconfig.html#closeonbackdropclick" class="tsd-kind-icon">close<wbr>OnBackdrop<wbr>Click</a>
|
|
372
|
+
</li>
|
|
373
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
374
|
+
<a href="_src_modal_config_.modalconfig.html#headercolor" class="tsd-kind-icon">header<wbr>Color</a>
|
|
375
|
+
</li>
|
|
376
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
377
|
+
<a href="_src_modal_config_.modalconfig.html#headline" class="tsd-kind-icon">headline</a>
|
|
378
|
+
</li>
|
|
379
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
380
|
+
<a href="_src_modal_config_.modalconfig.html#message" class="tsd-kind-icon">message</a>
|
|
381
|
+
</li>
|
|
382
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
383
|
+
<a href="_src_modal_config_.modalconfig.html#processingimagemode" class="tsd-kind-icon">processing<wbr>Image<wbr>Mode</a>
|
|
384
|
+
</li>
|
|
385
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
386
|
+
<a href="_src_modal_config_.modalconfig.html#showclosebutton" class="tsd-kind-icon">show<wbr>Close<wbr>Button</a>
|
|
387
|
+
</li>
|
|
388
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
389
|
+
<a href="_src_modal_config_.modalconfig.html#showprocessingindicator" class="tsd-kind-icon">show<wbr>Processing<wbr>Indicator</a>
|
|
390
|
+
</li>
|
|
391
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
392
|
+
<a href="_src_modal_config_.modalconfig.html#subtitle" class="tsd-kind-icon">subtitle</a>
|
|
393
|
+
</li>
|
|
394
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
395
|
+
<a href="_src_modal_config_.modalconfig.html#title" class="tsd-kind-icon">title</a>
|
|
396
|
+
</li>
|
|
397
|
+
</ul>
|
|
398
|
+
</li>
|
|
399
|
+
</ul>
|
|
400
|
+
<ul class="after-current">
|
|
401
|
+
</ul>
|
|
402
|
+
</nav>
|
|
403
|
+
</div>
|
|
404
|
+
</div>
|
|
405
|
+
</div>
|
|
406
|
+
<footer class="with-border-bottom">
|
|
407
|
+
<div class="container">
|
|
408
|
+
<h2>Legend</h2>
|
|
409
|
+
<div class="tsd-legend-group">
|
|
410
|
+
<ul class="tsd-legend">
|
|
411
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
412
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
413
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
414
|
+
</ul>
|
|
415
|
+
<ul class="tsd-legend">
|
|
416
|
+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
417
|
+
</ul>
|
|
418
|
+
<ul class="tsd-legend">
|
|
419
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
420
|
+
</ul>
|
|
421
|
+
</div>
|
|
422
|
+
</div>
|
|
423
|
+
</footer>
|
|
424
|
+
<div class="container tsd-generator">
|
|
425
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
426
|
+
</div>
|
|
427
|
+
<div class="overlay"></div>
|
|
428
|
+
<script src="../assets/js/main.js"></script>
|
|
429
|
+
</body>
|
|
430
430
|
</html>
|