@rxap/ngx-theme 19.0.4-dev.0 → 19.1.0-dev.0
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/CHANGELOG.md +6 -0
- package/README.md +85 -0
- package/compodoc/changelog.html +5 -0
- package/compodoc/dependencies.html +4 -4
- package/compodoc/index.html +69 -1
- package/compodoc/injectables/ThemeModeService.html +1256 -0
- package/compodoc/injectables/ThemeService.html +82 -265
- package/compodoc/interfaces/ColorPaletteConfig.html +6 -71
- package/compodoc/interfaces/ColorPaletteConfigWithName.html +6 -71
- package/compodoc/interfaces/ThemeConfig.html +6 -71
- package/compodoc/js/menu-wc.js +6 -0
- package/compodoc/js/menu-wc_es5.js +1 -1
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/miscellaneous/typealiases.html +235 -0
- package/compodoc/miscellaneous/variables.html +32 -0
- package/compodoc/overview.html +1 -1
- package/compodoc/properties.html +1 -1
- package/docs/documentation.json +1672 -532
- package/docs/html/assets/hierarchy.js +1 -1
- package/docs/html/assets/highlight.css +28 -0
- package/docs/html/assets/navigation.js +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/ThemeModeService.html +35 -0
- package/docs/html/classes/ThemeService.html +4 -6
- package/docs/html/enums/ColorPaletteAlgorithm.html +2 -2
- package/docs/html/functions/ComputeColorPalette.html +1 -1
- package/docs/html/functions/ObserveCurrentThemeDensity.html +1 -1
- package/docs/html/functions/provideTheme.html +1 -1
- package/docs/html/hierarchy.html +1 -1
- package/docs/html/index.html +60 -2
- package/docs/html/interfaces/ColorPalette.html +2 -2
- package/docs/html/interfaces/ColorPaletteConfig.html +2 -2
- package/docs/html/interfaces/ColorPaletteConfigWithName.html +2 -2
- package/docs/html/interfaces/ThemeConfig.html +2 -2
- package/docs/html/modules.html +1 -1
- package/docs/html/types/ActiveTheme.html +1 -0
- package/docs/html/types/ThemeSetting.html +1 -0
- package/docs/html/variables/THEME_SETTING_KEY.html +1 -0
- package/docs/markdown/README.md +86 -1
- package/docs/markdown/classes/ThemeModeService.md +282 -0
- package/docs/markdown/classes/ThemeService.md +39 -69
- package/docs/markdown/enumerations/ColorPaletteAlgorithm.md +4 -4
- package/docs/markdown/functions/ComputeColorPalette.md +2 -2
- package/docs/markdown/functions/ObserveCurrentThemeDensity.md +2 -2
- package/docs/markdown/functions/provideTheme.md +2 -2
- package/docs/markdown/globals.md +12 -2
- package/docs/markdown/interfaces/ColorPalette.md +16 -16
- package/docs/markdown/interfaces/ColorPaletteConfig.md +5 -5
- package/docs/markdown/interfaces/ColorPaletteConfigWithName.md +6 -6
- package/docs/markdown/interfaces/ThemeConfig.md +7 -7
- package/docs/markdown/type-aliases/ActiveTheme.md +11 -0
- package/docs/markdown/type-aliases/ThemeSetting.md +11 -0
- package/docs/markdown/variables/THEME_SETTING_KEY.md +11 -0
- package/docs/wiki/Class.ThemeModeService.md +278 -0
- package/docs/wiki/Class.ThemeService.md +38 -68
- package/docs/wiki/Enumeration.ColorPaletteAlgorithm.md +3 -3
- package/docs/wiki/Function.ComputeColorPalette.md +1 -1
- package/docs/wiki/Function.ObserveCurrentThemeDensity.md +1 -1
- package/docs/wiki/Function.provideTheme.md +1 -1
- package/docs/wiki/Home.md +85 -0
- package/docs/wiki/Interface.ColorPalette.md +15 -15
- package/docs/wiki/Interface.ColorPaletteConfig.md +4 -4
- package/docs/wiki/Interface.ColorPaletteConfigWithName.md +5 -5
- package/docs/wiki/Interface.ThemeConfig.md +6 -6
- package/docs/wiki/TypeAlias.ActiveTheme.md +7 -0
- package/docs/wiki/TypeAlias.ThemeSetting.md +7 -0
- package/docs/wiki/Variable.THEME_SETTING_KEY.md +7 -0
- package/docs/wiki/_Sidebar.md +10 -0
- package/docs/wiki/globals.md +11 -1
- package/fesm2022/rxap-ngx-theme.mjs +142 -61
- package/fesm2022/rxap-ngx-theme.mjs.map +1 -1
- package/index.d.ts +1 -0
- package/lib/theme-mode.service.d.ts +61 -0
- package/lib/theme.service.d.ts +3 -5
- package/package.json +12 -12
|
@@ -0,0 +1,1256 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="no-js" lang="">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
6
|
+
<title>angular-theme</title>
|
|
7
|
+
<meta name="description" content="">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
|
|
10
|
+
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
|
|
11
|
+
<link rel="stylesheet" href="../styles/style.css">
|
|
12
|
+
<link rel="stylesheet" href="../styles/dark.css">
|
|
13
|
+
</head>
|
|
14
|
+
<body>
|
|
15
|
+
<script>
|
|
16
|
+
// Blocking script to avoid flickering dark mode
|
|
17
|
+
// Dark mode toggle button
|
|
18
|
+
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
|
|
19
|
+
var darkModeState = useDark.matches;
|
|
20
|
+
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
21
|
+
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
|
|
22
|
+
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
|
|
23
|
+
|
|
24
|
+
function checkToggle(check) {
|
|
25
|
+
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
26
|
+
$darkModeToggleSwitchers[i].checked = check;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function toggleDarkMode(state) {
|
|
31
|
+
if (window.localStorage) {
|
|
32
|
+
localStorage.setItem('compodoc_darkmode-state', state);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
checkToggle(state);
|
|
36
|
+
|
|
37
|
+
const hasClass = document.body.classList.contains('dark');
|
|
38
|
+
|
|
39
|
+
if (state) {
|
|
40
|
+
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
41
|
+
$darkModeToggles[i].classList.add('dark');
|
|
42
|
+
}
|
|
43
|
+
if (!hasClass) {
|
|
44
|
+
document.body.classList.add('dark');
|
|
45
|
+
}
|
|
46
|
+
} else {
|
|
47
|
+
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
48
|
+
$darkModeToggles[i].classList.remove('dark');
|
|
49
|
+
}
|
|
50
|
+
if (hasClass) {
|
|
51
|
+
document.body.classList.remove('dark');
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
useDark.addEventListener('change', function (evt) {
|
|
57
|
+
toggleDarkMode(evt.matches);
|
|
58
|
+
});
|
|
59
|
+
if (darkModeStateLocal) {
|
|
60
|
+
darkModeState = darkModeStateLocal === 'true';
|
|
61
|
+
}
|
|
62
|
+
toggleDarkMode(darkModeState);
|
|
63
|
+
</script>
|
|
64
|
+
|
|
65
|
+
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
|
|
66
|
+
<div class="d-flex">
|
|
67
|
+
<a href="../" class="navbar-brand">angular-theme</a>
|
|
68
|
+
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
|
69
|
+
</div>
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
<div class="xs-menu menu" id="mobile-menu">
|
|
73
|
+
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
|
74
|
+
</div>
|
|
75
|
+
|
|
76
|
+
<div class="container-fluid main">
|
|
77
|
+
<div class="row main">
|
|
78
|
+
<div class="d-none d-md-block menu">
|
|
79
|
+
<compodoc-menu mode="normal"></compodoc-menu>
|
|
80
|
+
</div>
|
|
81
|
+
<!-- START CONTENT -->
|
|
82
|
+
<div class="content injectable">
|
|
83
|
+
<div class="content-data">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<ol class="breadcrumb">
|
|
93
|
+
<li class="breadcrumb-item">Injectables</li>
|
|
94
|
+
<li class="breadcrumb-item" >ThemeModeService</li>
|
|
95
|
+
</ol>
|
|
96
|
+
|
|
97
|
+
<ul class="nav nav-tabs" role="tablist">
|
|
98
|
+
<li class="nav-item">
|
|
99
|
+
<a href="#info"
|
|
100
|
+
class="nav-link"
|
|
101
|
+
class="nav-link active"
|
|
102
|
+
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
|
|
103
|
+
</li>
|
|
104
|
+
<li class="nav-item">
|
|
105
|
+
<a href="#source"
|
|
106
|
+
class="nav-link"
|
|
107
|
+
|
|
108
|
+
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
|
|
109
|
+
</li>
|
|
110
|
+
</ul>
|
|
111
|
+
|
|
112
|
+
<div class="tab-content">
|
|
113
|
+
<div class="tab-pane fade active in" id="info">
|
|
114
|
+
<p class="comment">
|
|
115
|
+
<h3>File</h3>
|
|
116
|
+
</p>
|
|
117
|
+
<p class="comment">
|
|
118
|
+
<code>src/lib/theme-mode.service.ts</code>
|
|
119
|
+
</p>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<p class="comment">
|
|
123
|
+
<h3>Description</h3>
|
|
124
|
+
</p>
|
|
125
|
+
<p class="comment">
|
|
126
|
+
<p>Service to manage theme mode (light/dark/system) for the application.
|
|
127
|
+
It provides functionality to handle theme preferences, persist them, and synchronize changes.</p>
|
|
128
|
+
<p>This service integrates with media queries to detect system-level theme changes and allows the user
|
|
129
|
+
or application logic to toggle or set a specific theme.</p>
|
|
130
|
+
<p>It utilizes dependency injection to access various required services and the document object.
|
|
131
|
+
Additionally, it publishes theme-related events for other parts of the application to react to
|
|
132
|
+
theme changes.</p>
|
|
133
|
+
|
|
134
|
+
</p>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<section data-compodoc="block-index">
|
|
139
|
+
<h3 id="index">Index</h3>
|
|
140
|
+
<table class="table table-sm table-bordered index-table">
|
|
141
|
+
<tbody>
|
|
142
|
+
<tr>
|
|
143
|
+
<td class="col-md-4">
|
|
144
|
+
<h6><b>Properties</b></h6>
|
|
145
|
+
</td>
|
|
146
|
+
</tr>
|
|
147
|
+
<tr>
|
|
148
|
+
<td class="col-md-4">
|
|
149
|
+
<ul class="index-list">
|
|
150
|
+
<li>
|
|
151
|
+
<span class="modifier">Public</span>
|
|
152
|
+
<span class="modifier">Readonly</span>
|
|
153
|
+
<a href="#activeTheme" >activeTheme</a>
|
|
154
|
+
</li>
|
|
155
|
+
<li>
|
|
156
|
+
<span class="modifier">Public</span>
|
|
157
|
+
<span class="modifier">Readonly</span>
|
|
158
|
+
<a href="#config" >config</a>
|
|
159
|
+
</li>
|
|
160
|
+
<li>
|
|
161
|
+
<span class="modifier">Protected</span>
|
|
162
|
+
<span class="modifier">Readonly</span>
|
|
163
|
+
<a href="#darkColorSchemaMediaQuery" >darkColorSchemaMediaQuery</a>
|
|
164
|
+
</li>
|
|
165
|
+
<li>
|
|
166
|
+
<span class="modifier">Public</span>
|
|
167
|
+
<span class="modifier">Readonly</span>
|
|
168
|
+
<a href="#darkMode" >darkMode</a>
|
|
169
|
+
</li>
|
|
170
|
+
<li>
|
|
171
|
+
<span class="modifier">Protected</span>
|
|
172
|
+
<span class="modifier">Readonly</span>
|
|
173
|
+
<a href="#mediaQueryListener" >mediaQueryListener</a>
|
|
174
|
+
</li>
|
|
175
|
+
<li>
|
|
176
|
+
<span class="modifier">Public</span>
|
|
177
|
+
<span class="modifier">Readonly</span>
|
|
178
|
+
<a href="#pubSub" >pubSub</a>
|
|
179
|
+
</li>
|
|
180
|
+
<li>
|
|
181
|
+
<span class="modifier">Protected</span>
|
|
182
|
+
<span class="modifier">Readonly</span>
|
|
183
|
+
<a href="#subscriptions" >subscriptions</a>
|
|
184
|
+
</li>
|
|
185
|
+
<li>
|
|
186
|
+
<span class="modifier">Protected</span>
|
|
187
|
+
<span class="modifier">Optional</span>
|
|
188
|
+
<a href="#syncSubscription" >syncSubscription</a>
|
|
189
|
+
</li>
|
|
190
|
+
<li>
|
|
191
|
+
<span class="modifier">Public</span>
|
|
192
|
+
<span class="modifier">Readonly</span>
|
|
193
|
+
<a href="#themeSetting" >themeSetting</a>
|
|
194
|
+
</li>
|
|
195
|
+
</ul>
|
|
196
|
+
</td>
|
|
197
|
+
</tr>
|
|
198
|
+
|
|
199
|
+
<tr>
|
|
200
|
+
<td class="col-md-4">
|
|
201
|
+
<h6><b>Methods</b></h6>
|
|
202
|
+
</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td class="col-md-4">
|
|
206
|
+
<ul class="index-list">
|
|
207
|
+
<li>
|
|
208
|
+
<span class="modifier">Protected</span>
|
|
209
|
+
<a href="#removeThemeClasses" >removeThemeClasses</a>
|
|
210
|
+
</li>
|
|
211
|
+
<li>
|
|
212
|
+
<span class="modifier">Protected</span>
|
|
213
|
+
<a href="#restoreFromPubSub" >restoreFromPubSub</a>
|
|
214
|
+
</li>
|
|
215
|
+
<li>
|
|
216
|
+
<span class="modifier">Protected</span>
|
|
217
|
+
<a href="#restoreThemeSetting" >restoreThemeSetting</a>
|
|
218
|
+
</li>
|
|
219
|
+
<li>
|
|
220
|
+
<span class="modifier">Public</span>
|
|
221
|
+
<a href="#setTheme" >setTheme</a>
|
|
222
|
+
</li>
|
|
223
|
+
<li>
|
|
224
|
+
<span class="modifier">Protected</span>
|
|
225
|
+
<a href="#setThemeClasses" >setThemeClasses</a>
|
|
226
|
+
</li>
|
|
227
|
+
<li>
|
|
228
|
+
<span class="modifier">Protected</span>
|
|
229
|
+
<a href="#storeThemeSetting" >storeThemeSetting</a>
|
|
230
|
+
</li>
|
|
231
|
+
<li>
|
|
232
|
+
<span class="modifier">Public</span>
|
|
233
|
+
<a href="#toggleTheme" >toggleTheme</a>
|
|
234
|
+
</li>
|
|
235
|
+
</ul>
|
|
236
|
+
</td>
|
|
237
|
+
</tr>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</tbody>
|
|
244
|
+
</table>
|
|
245
|
+
</section>
|
|
246
|
+
|
|
247
|
+
<section data-compodoc="block-constructor">
|
|
248
|
+
<h3 id="constructor">Constructor</h3>
|
|
249
|
+
<table class="table table-sm table-bordered">
|
|
250
|
+
<tbody>
|
|
251
|
+
<tr>
|
|
252
|
+
<td class="col-md-4">
|
|
253
|
+
<code>constructor(mediaMatcher: MediaMatcher, document: Document)</code>
|
|
254
|
+
</td>
|
|
255
|
+
</tr>
|
|
256
|
+
<tr>
|
|
257
|
+
<td class="col-md-4">
|
|
258
|
+
<div class="io-line">Defined in <a href="" data-line="60" class="link-to-prism">src/lib/theme-mode.service.ts:60</a></div>
|
|
259
|
+
</td>
|
|
260
|
+
</tr>
|
|
261
|
+
|
|
262
|
+
<tr>
|
|
263
|
+
<td class="col-md-4">
|
|
264
|
+
<div>
|
|
265
|
+
<b>Parameters :</b>
|
|
266
|
+
<table class="params">
|
|
267
|
+
<thead>
|
|
268
|
+
<tr>
|
|
269
|
+
<td>Name</td>
|
|
270
|
+
<td>Type</td>
|
|
271
|
+
<td>Optional</td>
|
|
272
|
+
</tr>
|
|
273
|
+
</thead>
|
|
274
|
+
<tbody>
|
|
275
|
+
<tr>
|
|
276
|
+
<td>mediaMatcher</td>
|
|
277
|
+
|
|
278
|
+
<td>
|
|
279
|
+
<code>MediaMatcher</code>
|
|
280
|
+
</td>
|
|
281
|
+
|
|
282
|
+
<td>
|
|
283
|
+
No
|
|
284
|
+
</td>
|
|
285
|
+
|
|
286
|
+
</tr>
|
|
287
|
+
<tr>
|
|
288
|
+
<td>document</td>
|
|
289
|
+
|
|
290
|
+
<td>
|
|
291
|
+
<code>Document</code>
|
|
292
|
+
</td>
|
|
293
|
+
|
|
294
|
+
<td>
|
|
295
|
+
No
|
|
296
|
+
</td>
|
|
297
|
+
|
|
298
|
+
</tr>
|
|
299
|
+
</tbody>
|
|
300
|
+
</table>
|
|
301
|
+
</div>
|
|
302
|
+
</td>
|
|
303
|
+
</tr>
|
|
304
|
+
</tbody>
|
|
305
|
+
</table>
|
|
306
|
+
</section>
|
|
307
|
+
|
|
308
|
+
<section data-compodoc="block-methods">
|
|
309
|
+
|
|
310
|
+
<h3 id="methods">
|
|
311
|
+
Methods
|
|
312
|
+
</h3>
|
|
313
|
+
<table class="table table-sm table-bordered">
|
|
314
|
+
<tbody>
|
|
315
|
+
<tr>
|
|
316
|
+
<td class="col-md-4">
|
|
317
|
+
<a name="removeThemeClasses"></a>
|
|
318
|
+
<span class="name">
|
|
319
|
+
<span class="modifier">Protected</span>
|
|
320
|
+
<span ><b>removeThemeClasses</b></span>
|
|
321
|
+
<a href="#removeThemeClasses"><span class="icon ion-ios-link"></span></a>
|
|
322
|
+
</span>
|
|
323
|
+
</td>
|
|
324
|
+
</tr>
|
|
325
|
+
<tr>
|
|
326
|
+
<td class="col-md-4">
|
|
327
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
328
|
+
<code>removeThemeClasses()</code>
|
|
329
|
+
</td>
|
|
330
|
+
</tr>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<tr>
|
|
334
|
+
<td class="col-md-4">
|
|
335
|
+
<div class="io-line">Defined in <a href="" data-line="148"
|
|
336
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:148</a></div>
|
|
337
|
+
</td>
|
|
338
|
+
</tr>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<tr>
|
|
342
|
+
<td class="col-md-4">
|
|
343
|
+
|
|
344
|
+
<div class="io-description">
|
|
345
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
</td>
|
|
349
|
+
</tr>
|
|
350
|
+
</tbody>
|
|
351
|
+
</table>
|
|
352
|
+
<table class="table table-sm table-bordered">
|
|
353
|
+
<tbody>
|
|
354
|
+
<tr>
|
|
355
|
+
<td class="col-md-4">
|
|
356
|
+
<a name="restoreFromPubSub"></a>
|
|
357
|
+
<span class="name">
|
|
358
|
+
<span class="modifier">Protected</span>
|
|
359
|
+
<span ><b>restoreFromPubSub</b></span>
|
|
360
|
+
<a href="#restoreFromPubSub"><span class="icon ion-ios-link"></span></a>
|
|
361
|
+
</span>
|
|
362
|
+
</td>
|
|
363
|
+
</tr>
|
|
364
|
+
<tr>
|
|
365
|
+
<td class="col-md-4">
|
|
366
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
367
|
+
<code>restoreFromPubSub()</code>
|
|
368
|
+
</td>
|
|
369
|
+
</tr>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<tr>
|
|
373
|
+
<td class="col-md-4">
|
|
374
|
+
<div class="io-line">Defined in <a href="" data-line="108"
|
|
375
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:108</a></div>
|
|
376
|
+
</td>
|
|
377
|
+
</tr>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<tr>
|
|
381
|
+
<td class="col-md-4">
|
|
382
|
+
|
|
383
|
+
<div class="io-description">
|
|
384
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
</td>
|
|
388
|
+
</tr>
|
|
389
|
+
</tbody>
|
|
390
|
+
</table>
|
|
391
|
+
<table class="table table-sm table-bordered">
|
|
392
|
+
<tbody>
|
|
393
|
+
<tr>
|
|
394
|
+
<td class="col-md-4">
|
|
395
|
+
<a name="restoreThemeSetting"></a>
|
|
396
|
+
<span class="name">
|
|
397
|
+
<span class="modifier">Protected</span>
|
|
398
|
+
<span ><b>restoreThemeSetting</b></span>
|
|
399
|
+
<a href="#restoreThemeSetting"><span class="icon ion-ios-link"></span></a>
|
|
400
|
+
</span>
|
|
401
|
+
</td>
|
|
402
|
+
</tr>
|
|
403
|
+
<tr>
|
|
404
|
+
<td class="col-md-4">
|
|
405
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
406
|
+
<code>restoreThemeSetting()</code>
|
|
407
|
+
</td>
|
|
408
|
+
</tr>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
<tr>
|
|
412
|
+
<td class="col-md-4">
|
|
413
|
+
<div class="io-line">Defined in <a href="" data-line="136"
|
|
414
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:136</a></div>
|
|
415
|
+
</td>
|
|
416
|
+
</tr>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<tr>
|
|
420
|
+
<td class="col-md-4">
|
|
421
|
+
|
|
422
|
+
<div class="io-description">
|
|
423
|
+
<b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#ThemeSetting" target="_self" >ThemeSetting</a></code>
|
|
424
|
+
|
|
425
|
+
</div>
|
|
426
|
+
</td>
|
|
427
|
+
</tr>
|
|
428
|
+
</tbody>
|
|
429
|
+
</table>
|
|
430
|
+
<table class="table table-sm table-bordered">
|
|
431
|
+
<tbody>
|
|
432
|
+
<tr>
|
|
433
|
+
<td class="col-md-4">
|
|
434
|
+
<a name="setTheme"></a>
|
|
435
|
+
<span class="name">
|
|
436
|
+
<span class="modifier">Public</span>
|
|
437
|
+
<span ><b>setTheme</b></span>
|
|
438
|
+
<a href="#setTheme"><span class="icon ion-ios-link"></span></a>
|
|
439
|
+
</span>
|
|
440
|
+
</td>
|
|
441
|
+
</tr>
|
|
442
|
+
<tr>
|
|
443
|
+
<td class="col-md-4">
|
|
444
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
445
|
+
<code>setTheme(active: <a href="../undefineds/ActiveTheme.html" target="_self">ActiveTheme</a>, publish)</code>
|
|
446
|
+
</td>
|
|
447
|
+
</tr>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<tr>
|
|
451
|
+
<td class="col-md-4">
|
|
452
|
+
<div class="io-line">Defined in <a href="" data-line="179"
|
|
453
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:179</a></div>
|
|
454
|
+
</td>
|
|
455
|
+
</tr>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<tr>
|
|
459
|
+
<td class="col-md-4">
|
|
460
|
+
<div class="io-description"><p>Sets the active theme for the application and optionally publishes the change.</p>
|
|
461
|
+
</div>
|
|
462
|
+
|
|
463
|
+
<div class="io-description">
|
|
464
|
+
<b>Parameters :</b>
|
|
465
|
+
|
|
466
|
+
<table class="params">
|
|
467
|
+
<thead>
|
|
468
|
+
<tr>
|
|
469
|
+
<td>Name</td>
|
|
470
|
+
<td>Type</td>
|
|
471
|
+
<td>Optional</td>
|
|
472
|
+
<td>Default value</td>
|
|
473
|
+
<td>Description</td>
|
|
474
|
+
</tr>
|
|
475
|
+
</thead>
|
|
476
|
+
<tbody>
|
|
477
|
+
<tr>
|
|
478
|
+
<td>active</td>
|
|
479
|
+
<td>
|
|
480
|
+
<code><a href="../miscellaneous/typealiases.html#ActiveTheme" target="_self" >ActiveTheme</a></code>
|
|
481
|
+
</td>
|
|
482
|
+
|
|
483
|
+
<td>
|
|
484
|
+
No
|
|
485
|
+
</td>
|
|
486
|
+
|
|
487
|
+
<td>
|
|
488
|
+
</td>
|
|
489
|
+
|
|
490
|
+
<td>
|
|
491
|
+
<ul>
|
|
492
|
+
<li>The theme to be set as active.</li>
|
|
493
|
+
</ul>
|
|
494
|
+
|
|
495
|
+
</td>
|
|
496
|
+
</tr>
|
|
497
|
+
<tr>
|
|
498
|
+
<td>publish</td>
|
|
499
|
+
<td>
|
|
500
|
+
</td>
|
|
501
|
+
|
|
502
|
+
<td>
|
|
503
|
+
No
|
|
504
|
+
</td>
|
|
505
|
+
|
|
506
|
+
<td>
|
|
507
|
+
<code>true</code>
|
|
508
|
+
</td>
|
|
509
|
+
|
|
510
|
+
<td>
|
|
511
|
+
<ul>
|
|
512
|
+
<li>Indicates whether to publish the theme change event.</li>
|
|
513
|
+
</ul>
|
|
514
|
+
|
|
515
|
+
</td>
|
|
516
|
+
</tr>
|
|
517
|
+
</tbody>
|
|
518
|
+
</table>
|
|
519
|
+
</div>
|
|
520
|
+
<div class="io-description">
|
|
521
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
522
|
+
|
|
523
|
+
</div>
|
|
524
|
+
<div class="io-description">
|
|
525
|
+
|
|
526
|
+
</div>
|
|
527
|
+
</td>
|
|
528
|
+
</tr>
|
|
529
|
+
</tbody>
|
|
530
|
+
</table>
|
|
531
|
+
<table class="table table-sm table-bordered">
|
|
532
|
+
<tbody>
|
|
533
|
+
<tr>
|
|
534
|
+
<td class="col-md-4">
|
|
535
|
+
<a name="setThemeClasses"></a>
|
|
536
|
+
<span class="name">
|
|
537
|
+
<span class="modifier">Protected</span>
|
|
538
|
+
<span ><b>setThemeClasses</b></span>
|
|
539
|
+
<a href="#setThemeClasses"><span class="icon ion-ios-link"></span></a>
|
|
540
|
+
</span>
|
|
541
|
+
</td>
|
|
542
|
+
</tr>
|
|
543
|
+
<tr>
|
|
544
|
+
<td class="col-md-4">
|
|
545
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
546
|
+
<code>setThemeClasses(active: <a href="../undefineds/ActiveTheme.html" target="_self">ActiveTheme</a>)</code>
|
|
547
|
+
</td>
|
|
548
|
+
</tr>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<tr>
|
|
552
|
+
<td class="col-md-4">
|
|
553
|
+
<div class="io-line">Defined in <a href="" data-line="153"
|
|
554
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:153</a></div>
|
|
555
|
+
</td>
|
|
556
|
+
</tr>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<tr>
|
|
560
|
+
<td class="col-md-4">
|
|
561
|
+
|
|
562
|
+
<div class="io-description">
|
|
563
|
+
<b>Parameters :</b>
|
|
564
|
+
|
|
565
|
+
<table class="params">
|
|
566
|
+
<thead>
|
|
567
|
+
<tr>
|
|
568
|
+
<td>Name</td>
|
|
569
|
+
<td>Type</td>
|
|
570
|
+
<td>Optional</td>
|
|
571
|
+
</tr>
|
|
572
|
+
</thead>
|
|
573
|
+
<tbody>
|
|
574
|
+
<tr>
|
|
575
|
+
<td>active</td>
|
|
576
|
+
<td>
|
|
577
|
+
<code><a href="../miscellaneous/typealiases.html#ActiveTheme" target="_self" >ActiveTheme</a></code>
|
|
578
|
+
</td>
|
|
579
|
+
|
|
580
|
+
<td>
|
|
581
|
+
No
|
|
582
|
+
</td>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
</tr>
|
|
586
|
+
</tbody>
|
|
587
|
+
</table>
|
|
588
|
+
</div>
|
|
589
|
+
<div class="io-description">
|
|
590
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
<div class="io-description">
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
</td>
|
|
597
|
+
</tr>
|
|
598
|
+
</tbody>
|
|
599
|
+
</table>
|
|
600
|
+
<table class="table table-sm table-bordered">
|
|
601
|
+
<tbody>
|
|
602
|
+
<tr>
|
|
603
|
+
<td class="col-md-4">
|
|
604
|
+
<a name="storeThemeSetting"></a>
|
|
605
|
+
<span class="name">
|
|
606
|
+
<span class="modifier">Protected</span>
|
|
607
|
+
<span ><b>storeThemeSetting</b></span>
|
|
608
|
+
<a href="#storeThemeSetting"><span class="icon ion-ios-link"></span></a>
|
|
609
|
+
</span>
|
|
610
|
+
</td>
|
|
611
|
+
</tr>
|
|
612
|
+
<tr>
|
|
613
|
+
<td class="col-md-4">
|
|
614
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
615
|
+
<code>storeThemeSetting(setting: <a href="../undefineds/ThemeSetting.html" target="_self">ThemeSetting</a>)</code>
|
|
616
|
+
</td>
|
|
617
|
+
</tr>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<tr>
|
|
621
|
+
<td class="col-md-4">
|
|
622
|
+
<div class="io-line">Defined in <a href="" data-line="144"
|
|
623
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:144</a></div>
|
|
624
|
+
</td>
|
|
625
|
+
</tr>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<tr>
|
|
629
|
+
<td class="col-md-4">
|
|
630
|
+
|
|
631
|
+
<div class="io-description">
|
|
632
|
+
<b>Parameters :</b>
|
|
633
|
+
|
|
634
|
+
<table class="params">
|
|
635
|
+
<thead>
|
|
636
|
+
<tr>
|
|
637
|
+
<td>Name</td>
|
|
638
|
+
<td>Type</td>
|
|
639
|
+
<td>Optional</td>
|
|
640
|
+
</tr>
|
|
641
|
+
</thead>
|
|
642
|
+
<tbody>
|
|
643
|
+
<tr>
|
|
644
|
+
<td>setting</td>
|
|
645
|
+
<td>
|
|
646
|
+
<code><a href="../miscellaneous/typealiases.html#ThemeSetting" target="_self" >ThemeSetting</a></code>
|
|
647
|
+
</td>
|
|
648
|
+
|
|
649
|
+
<td>
|
|
650
|
+
No
|
|
651
|
+
</td>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
</tr>
|
|
655
|
+
</tbody>
|
|
656
|
+
</table>
|
|
657
|
+
</div>
|
|
658
|
+
<div class="io-description">
|
|
659
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
660
|
+
|
|
661
|
+
</div>
|
|
662
|
+
<div class="io-description">
|
|
663
|
+
|
|
664
|
+
</div>
|
|
665
|
+
</td>
|
|
666
|
+
</tr>
|
|
667
|
+
</tbody>
|
|
668
|
+
</table>
|
|
669
|
+
<table class="table table-sm table-bordered">
|
|
670
|
+
<tbody>
|
|
671
|
+
<tr>
|
|
672
|
+
<td class="col-md-4">
|
|
673
|
+
<a name="toggleTheme"></a>
|
|
674
|
+
<span class="name">
|
|
675
|
+
<span class="modifier">Public</span>
|
|
676
|
+
<span ><b>toggleTheme</b></span>
|
|
677
|
+
<a href="#toggleTheme"><span class="icon ion-ios-link"></span></a>
|
|
678
|
+
</span>
|
|
679
|
+
</td>
|
|
680
|
+
</tr>
|
|
681
|
+
<tr>
|
|
682
|
+
<td class="col-md-4">
|
|
683
|
+
<span class="modifier-icon icon ion-ios-reset"></span>
|
|
684
|
+
<code>toggleTheme()</code>
|
|
685
|
+
</td>
|
|
686
|
+
</tr>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
<tr>
|
|
690
|
+
<td class="col-md-4">
|
|
691
|
+
<div class="io-line">Defined in <a href="" data-line="164"
|
|
692
|
+
class="link-to-prism">src/lib/theme-mode.service.ts:164</a></div>
|
|
693
|
+
</td>
|
|
694
|
+
</tr>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<tr>
|
|
698
|
+
<td class="col-md-4">
|
|
699
|
+
<div class="io-description"><p>Toggles the application theme between 'light' and 'dark' modes.
|
|
700
|
+
It checks the currently active theme and switches to the opposite mode.</p>
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
<div class="io-description">
|
|
704
|
+
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
|
|
705
|
+
|
|
706
|
+
</div>
|
|
707
|
+
<div class="io-description">
|
|
708
|
+
<p>Does not return a value.</p>
|
|
709
|
+
|
|
710
|
+
</div>
|
|
711
|
+
</td>
|
|
712
|
+
</tr>
|
|
713
|
+
</tbody>
|
|
714
|
+
</table>
|
|
715
|
+
</section>
|
|
716
|
+
<section data-compodoc="block-properties">
|
|
717
|
+
|
|
718
|
+
<h3 id="inputs">
|
|
719
|
+
Properties
|
|
720
|
+
</h3>
|
|
721
|
+
<table class="table table-sm table-bordered">
|
|
722
|
+
<tbody>
|
|
723
|
+
<tr>
|
|
724
|
+
<td class="col-md-4">
|
|
725
|
+
<a name="activeTheme"></a>
|
|
726
|
+
<span class="name">
|
|
727
|
+
<span class="modifier">Public</span>
|
|
728
|
+
<span class="modifier">Readonly</span>
|
|
729
|
+
<span ><b>activeTheme</b></span>
|
|
730
|
+
<a href="#activeTheme"><span class="icon ion-ios-link"></span></a>
|
|
731
|
+
</span>
|
|
732
|
+
</td>
|
|
733
|
+
</tr>
|
|
734
|
+
<tr>
|
|
735
|
+
<td class="col-md-4">
|
|
736
|
+
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#ActiveTheme" target="_self" >WritableSignal<ActiveTheme></a></code>
|
|
737
|
+
|
|
738
|
+
</td>
|
|
739
|
+
</tr>
|
|
740
|
+
<tr>
|
|
741
|
+
<td class="col-md-4">
|
|
742
|
+
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">src/lib/theme-mode.service.ts:51</a></div>
|
|
743
|
+
</td>
|
|
744
|
+
</tr>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
</tbody>
|
|
748
|
+
</table>
|
|
749
|
+
<table class="table table-sm table-bordered">
|
|
750
|
+
<tbody>
|
|
751
|
+
<tr>
|
|
752
|
+
<td class="col-md-4">
|
|
753
|
+
<a name="config"></a>
|
|
754
|
+
<span class="name">
|
|
755
|
+
<span class="modifier">Public</span>
|
|
756
|
+
<span class="modifier">Readonly</span>
|
|
757
|
+
<span ><b>config</b></span>
|
|
758
|
+
<a href="#config"><span class="icon ion-ios-link"></span></a>
|
|
759
|
+
</span>
|
|
760
|
+
</td>
|
|
761
|
+
</tr>
|
|
762
|
+
<tr>
|
|
763
|
+
<td class="col-md-4">
|
|
764
|
+
<i>Default value : </i><code>inject(ConfigService)</code>
|
|
765
|
+
</td>
|
|
766
|
+
</tr>
|
|
767
|
+
<tr>
|
|
768
|
+
<td class="col-md-4">
|
|
769
|
+
<div class="io-line">Defined in <a href="" data-line="48" class="link-to-prism">src/lib/theme-mode.service.ts:48</a></div>
|
|
770
|
+
</td>
|
|
771
|
+
</tr>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</tbody>
|
|
775
|
+
</table>
|
|
776
|
+
<table class="table table-sm table-bordered">
|
|
777
|
+
<tbody>
|
|
778
|
+
<tr>
|
|
779
|
+
<td class="col-md-4">
|
|
780
|
+
<a name="darkColorSchemaMediaQuery"></a>
|
|
781
|
+
<span class="name">
|
|
782
|
+
<span class="modifier">Protected</span>
|
|
783
|
+
<span class="modifier">Readonly</span>
|
|
784
|
+
<span ><b>darkColorSchemaMediaQuery</b></span>
|
|
785
|
+
<a href="#darkColorSchemaMediaQuery"><span class="icon ion-ios-link"></span></a>
|
|
786
|
+
</span>
|
|
787
|
+
</td>
|
|
788
|
+
</tr>
|
|
789
|
+
<tr>
|
|
790
|
+
<td class="col-md-4">
|
|
791
|
+
<i>Type : </i> <code>MediaQueryList</code>
|
|
792
|
+
|
|
793
|
+
</td>
|
|
794
|
+
</tr>
|
|
795
|
+
<tr>
|
|
796
|
+
<td class="col-md-4">
|
|
797
|
+
<div class="io-line">Defined in <a href="" data-line="55" class="link-to-prism">src/lib/theme-mode.service.ts:55</a></div>
|
|
798
|
+
</td>
|
|
799
|
+
</tr>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
</tbody>
|
|
803
|
+
</table>
|
|
804
|
+
<table class="table table-sm table-bordered">
|
|
805
|
+
<tbody>
|
|
806
|
+
<tr>
|
|
807
|
+
<td class="col-md-4">
|
|
808
|
+
<a name="darkMode"></a>
|
|
809
|
+
<span class="name">
|
|
810
|
+
<span class="modifier">Public</span>
|
|
811
|
+
<span class="modifier">Readonly</span>
|
|
812
|
+
<span ><b>darkMode</b></span>
|
|
813
|
+
<a href="#darkMode"><span class="icon ion-ios-link"></span></a>
|
|
814
|
+
</span>
|
|
815
|
+
</td>
|
|
816
|
+
</tr>
|
|
817
|
+
<tr>
|
|
818
|
+
<td class="col-md-4">
|
|
819
|
+
<i>Default value : </i><code>computed(() => this.activeTheme() === 'dark')</code>
|
|
820
|
+
</td>
|
|
821
|
+
</tr>
|
|
822
|
+
<tr>
|
|
823
|
+
<td class="col-md-4">
|
|
824
|
+
<div class="io-line">Defined in <a href="" data-line="53" class="link-to-prism">src/lib/theme-mode.service.ts:53</a></div>
|
|
825
|
+
</td>
|
|
826
|
+
</tr>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
</tbody>
|
|
830
|
+
</table>
|
|
831
|
+
<table class="table table-sm table-bordered">
|
|
832
|
+
<tbody>
|
|
833
|
+
<tr>
|
|
834
|
+
<td class="col-md-4">
|
|
835
|
+
<a name="mediaQueryListener"></a>
|
|
836
|
+
<span class="name">
|
|
837
|
+
<span class="modifier">Protected</span>
|
|
838
|
+
<span class="modifier">Readonly</span>
|
|
839
|
+
<span ><b>mediaQueryListener</b></span>
|
|
840
|
+
<a href="#mediaQueryListener"><span class="icon ion-ios-link"></span></a>
|
|
841
|
+
</span>
|
|
842
|
+
</td>
|
|
843
|
+
</tr>
|
|
844
|
+
<tr>
|
|
845
|
+
<td class="col-md-4">
|
|
846
|
+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
|
|
847
|
+
|
|
848
|
+
</td>
|
|
849
|
+
</tr>
|
|
850
|
+
<tr>
|
|
851
|
+
<td class="col-md-4">
|
|
852
|
+
<div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">src/lib/theme-mode.service.ts:58</a></div>
|
|
853
|
+
</td>
|
|
854
|
+
</tr>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
</tbody>
|
|
858
|
+
</table>
|
|
859
|
+
<table class="table table-sm table-bordered">
|
|
860
|
+
<tbody>
|
|
861
|
+
<tr>
|
|
862
|
+
<td class="col-md-4">
|
|
863
|
+
<a name="pubSub"></a>
|
|
864
|
+
<span class="name">
|
|
865
|
+
<span class="modifier">Public</span>
|
|
866
|
+
<span class="modifier">Readonly</span>
|
|
867
|
+
<span ><b>pubSub</b></span>
|
|
868
|
+
<a href="#pubSub"><span class="icon ion-ios-link"></span></a>
|
|
869
|
+
</span>
|
|
870
|
+
</td>
|
|
871
|
+
</tr>
|
|
872
|
+
<tr>
|
|
873
|
+
<td class="col-md-4">
|
|
874
|
+
<i>Default value : </i><code>inject(PubSubService)</code>
|
|
875
|
+
</td>
|
|
876
|
+
</tr>
|
|
877
|
+
<tr>
|
|
878
|
+
<td class="col-md-4">
|
|
879
|
+
<div class="io-line">Defined in <a href="" data-line="49" class="link-to-prism">src/lib/theme-mode.service.ts:49</a></div>
|
|
880
|
+
</td>
|
|
881
|
+
</tr>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
</tbody>
|
|
885
|
+
</table>
|
|
886
|
+
<table class="table table-sm table-bordered">
|
|
887
|
+
<tbody>
|
|
888
|
+
<tr>
|
|
889
|
+
<td class="col-md-4">
|
|
890
|
+
<a name="subscriptions"></a>
|
|
891
|
+
<span class="name">
|
|
892
|
+
<span class="modifier">Protected</span>
|
|
893
|
+
<span class="modifier">Readonly</span>
|
|
894
|
+
<span ><b>subscriptions</b></span>
|
|
895
|
+
<a href="#subscriptions"><span class="icon ion-ios-link"></span></a>
|
|
896
|
+
</span>
|
|
897
|
+
</td>
|
|
898
|
+
</tr>
|
|
899
|
+
<tr>
|
|
900
|
+
<td class="col-md-4">
|
|
901
|
+
<i>Type : </i> <code>Subscription | null</code>
|
|
902
|
+
|
|
903
|
+
</td>
|
|
904
|
+
</tr>
|
|
905
|
+
<tr>
|
|
906
|
+
<td class="col-md-4">
|
|
907
|
+
<i>Default value : </i><code>null</code>
|
|
908
|
+
</td>
|
|
909
|
+
</tr>
|
|
910
|
+
<tr>
|
|
911
|
+
<td class="col-md-4">
|
|
912
|
+
<div class="io-line">Defined in <a href="" data-line="57" class="link-to-prism">src/lib/theme-mode.service.ts:57</a></div>
|
|
913
|
+
</td>
|
|
914
|
+
</tr>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
</tbody>
|
|
918
|
+
</table>
|
|
919
|
+
<table class="table table-sm table-bordered">
|
|
920
|
+
<tbody>
|
|
921
|
+
<tr>
|
|
922
|
+
<td class="col-md-4">
|
|
923
|
+
<a name="syncSubscription"></a>
|
|
924
|
+
<span class="name">
|
|
925
|
+
<span class="modifier">Protected</span>
|
|
926
|
+
<span class="modifier">Optional</span>
|
|
927
|
+
<span ><b>syncSubscription</b></span>
|
|
928
|
+
<a href="#syncSubscription"><span class="icon ion-ios-link"></span></a>
|
|
929
|
+
</span>
|
|
930
|
+
</td>
|
|
931
|
+
</tr>
|
|
932
|
+
<tr>
|
|
933
|
+
<td class="col-md-4">
|
|
934
|
+
<i>Type : </i> <code>Subscription</code>
|
|
935
|
+
|
|
936
|
+
</td>
|
|
937
|
+
</tr>
|
|
938
|
+
<tr>
|
|
939
|
+
<td class="col-md-4">
|
|
940
|
+
<div class="io-line">Defined in <a href="" data-line="60" class="link-to-prism">src/lib/theme-mode.service.ts:60</a></div>
|
|
941
|
+
</td>
|
|
942
|
+
</tr>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
</tbody>
|
|
946
|
+
</table>
|
|
947
|
+
<table class="table table-sm table-bordered">
|
|
948
|
+
<tbody>
|
|
949
|
+
<tr>
|
|
950
|
+
<td class="col-md-4">
|
|
951
|
+
<a name="themeSetting"></a>
|
|
952
|
+
<span class="name">
|
|
953
|
+
<span class="modifier">Public</span>
|
|
954
|
+
<span class="modifier">Readonly</span>
|
|
955
|
+
<span ><b>themeSetting</b></span>
|
|
956
|
+
<a href="#themeSetting"><span class="icon ion-ios-link"></span></a>
|
|
957
|
+
</span>
|
|
958
|
+
</td>
|
|
959
|
+
</tr>
|
|
960
|
+
<tr>
|
|
961
|
+
<td class="col-md-4">
|
|
962
|
+
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#ThemeSetting" target="_self" >WritableSignal<ThemeSetting></a></code>
|
|
963
|
+
|
|
964
|
+
</td>
|
|
965
|
+
</tr>
|
|
966
|
+
<tr>
|
|
967
|
+
<td class="col-md-4">
|
|
968
|
+
<div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/lib/theme-mode.service.ts:52</a></div>
|
|
969
|
+
</td>
|
|
970
|
+
</tr>
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
</tbody>
|
|
974
|
+
</table>
|
|
975
|
+
</section>
|
|
976
|
+
|
|
977
|
+
</div>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
<div class="tab-pane fade tab-source-code" id="source">
|
|
981
|
+
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { MediaMatcher } from '@angular/cdk/layout';
|
|
982
|
+
import { DOCUMENT } from '@angular/common';
|
|
983
|
+
import {
|
|
984
|
+
computed,
|
|
985
|
+
effect,
|
|
986
|
+
inject,
|
|
987
|
+
Inject,
|
|
988
|
+
Injectable,
|
|
989
|
+
OnDestroy,
|
|
990
|
+
Renderer2,
|
|
991
|
+
signal,
|
|
992
|
+
WritableSignal,
|
|
993
|
+
} from '@angular/core';
|
|
994
|
+
import { ConfigService } from '@rxap/config';
|
|
995
|
+
import {
|
|
996
|
+
PubSubService,
|
|
997
|
+
RXAP_TOPICS,
|
|
998
|
+
} from '@rxap/ngx-pub-sub';
|
|
999
|
+
import { isDefined } from '@rxap/rxjs';
|
|
1000
|
+
import {
|
|
1001
|
+
debounceTime,
|
|
1002
|
+
map,
|
|
1003
|
+
Subscription,
|
|
1004
|
+
tap,
|
|
1005
|
+
} from 'rxjs';
|
|
1006
|
+
|
|
1007
|
+
// Represents the user's preference setting ('system', 'light', or 'dark')
|
|
1008
|
+
export type ThemeSetting = 'system' | 'light' | 'dark';
|
|
1009
|
+
// Represents the currently active theme ('light' or 'dark')
|
|
1010
|
+
export type ActiveTheme = 'light' | 'dark';
|
|
1011
|
+
|
|
1012
|
+
export const THEME_SETTING_KEY = 'rxap_theme_settings';
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* Service to manage theme mode (light/dark/system) for the application.
|
|
1016
|
+
* It provides functionality to handle theme preferences, persist them, and synchronize changes.
|
|
1017
|
+
*
|
|
1018
|
+
* This service integrates with media queries to detect system-level theme changes and allows the user
|
|
1019
|
+
* or application logic to toggle or set a specific theme.
|
|
1020
|
+
*
|
|
1021
|
+
* It utilizes dependency injection to access various required services and the document object.
|
|
1022
|
+
* Additionally, it publishes theme-related events for other parts of the application to react to
|
|
1023
|
+
* theme changes.
|
|
1024
|
+
*/
|
|
1025
|
+
@Injectable({ providedIn: 'root' })
|
|
1026
|
+
export class ThemeModeService implements OnDestroy {
|
|
1027
|
+
|
|
1028
|
+
public readonly config = inject(ConfigService);
|
|
1029
|
+
public readonly pubSub = inject(PubSubService);
|
|
1030
|
+
|
|
1031
|
+
public readonly activeTheme: WritableSignal<ActiveTheme>;
|
|
1032
|
+
public readonly themeSetting: WritableSignal<ThemeSetting>;
|
|
1033
|
+
public readonly darkMode = computed(() => this.activeTheme() === 'dark');
|
|
1034
|
+
|
|
1035
|
+
protected readonly darkColorSchemaMediaQuery: MediaQueryList;
|
|
1036
|
+
|
|
1037
|
+
protected readonly subscriptions: Subscription | null = null;
|
|
1038
|
+
protected readonly mediaQueryListener: (this: MediaQueryList, ev: MediaQueryListEventMap['change']) => any;
|
|
1039
|
+
|
|
1040
|
+
protected syncSubscription?: Subscription;
|
|
1041
|
+
|
|
1042
|
+
constructor(
|
|
1043
|
+
protected readonly mediaMatcher: MediaMatcher,
|
|
1044
|
+
@Inject(DOCUMENT) protected readonly document: Document,
|
|
1045
|
+
) {
|
|
1046
|
+
this.darkColorSchemaMediaQuery = this.mediaMatcher.matchMedia('(prefers-color-scheme: dark)');
|
|
1047
|
+
this.themeSetting = signal(this.restoreThemeSetting());
|
|
1048
|
+
let activeTheme: ActiveTheme;
|
|
1049
|
+
const themeSetting = this.themeSetting();
|
|
1050
|
+
switch (themeSetting) {
|
|
1051
|
+
case 'system':
|
|
1052
|
+
activeTheme = this.darkColorSchemaMediaQuery.matches ? 'dark' : 'light';
|
|
1053
|
+
break;
|
|
1054
|
+
case 'light':
|
|
1055
|
+
activeTheme = 'light';
|
|
1056
|
+
break;
|
|
1057
|
+
case 'dark':
|
|
1058
|
+
activeTheme = 'dark';
|
|
1059
|
+
break;
|
|
1060
|
+
default:
|
|
1061
|
+
activeTheme = this.config.get('theme.active', 'light');
|
|
1062
|
+
break;
|
|
1063
|
+
}
|
|
1064
|
+
this.activeTheme = signal(activeTheme);
|
|
1065
|
+
effect(() => {
|
|
1066
|
+
const setting = this.themeSetting();
|
|
1067
|
+
this.storeThemeSetting(setting);
|
|
1068
|
+
});
|
|
1069
|
+
effect(() => {
|
|
1070
|
+
const active = this.activeTheme();
|
|
1071
|
+
this.setThemeClasses(active);
|
|
1072
|
+
});
|
|
1073
|
+
this.mediaQueryListener = (event: MediaQueryListEventMap['change']) => {
|
|
1074
|
+
if (this.themeSetting() === 'system') {
|
|
1075
|
+
this.activeTheme.set(event.matches ? 'dark' : 'light');
|
|
1076
|
+
}
|
|
1077
|
+
};
|
|
1078
|
+
this.darkColorSchemaMediaQuery.addEventListener('change', this.mediaQueryListener);
|
|
1079
|
+
this.restoreFromPubSub();
|
|
1080
|
+
}
|
|
1081
|
+
|
|
1082
|
+
private get darkModeLocalStorageKey() {
|
|
1083
|
+
return (
|
|
1084
|
+
window as any
|
|
1085
|
+
)?.['__rxap__']?.['ngx']?.['theme']?.['darkMode']?.['key'] ?? THEME_SETTING_KEY;
|
|
1086
|
+
}
|
|
1087
|
+
|
|
1088
|
+
protected restoreFromPubSub() {
|
|
1089
|
+
if (this.syncSubscription) {
|
|
1090
|
+
return;
|
|
1091
|
+
}
|
|
1092
|
+
this.syncSubscription = new Subscription();
|
|
1093
|
+
this.syncSubscription.add(this.pubSub.subscribe<boolean>(RXAP_TOPICS.theme.darkMode.restore).pipe(
|
|
1094
|
+
debounceTime(1000),
|
|
1095
|
+
map(event => event.data),
|
|
1096
|
+
isDefined(),
|
|
1097
|
+
tap(data => {
|
|
1098
|
+
const active = data ? 'dark' : 'light';
|
|
1099
|
+
this.themeSetting.set(active);
|
|
1100
|
+
this.activeTheme.set(active);
|
|
1101
|
+
})
|
|
1102
|
+
).subscribe());
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* Cleans up subscriptions and event listeners when the service is destroyed.
|
|
1107
|
+
*/
|
|
1108
|
+
ngOnDestroy(): void {
|
|
1109
|
+
// Remove the media query listener if it exists.
|
|
1110
|
+
this.darkColorSchemaMediaQuery.removeEventListener('change', this.mediaQueryListener);
|
|
1111
|
+
// Unsubscribe from all RxJS subscriptions.
|
|
1112
|
+
this.subscriptions?.unsubscribe();
|
|
1113
|
+
this.syncSubscription?.unsubscribe();
|
|
1114
|
+
}
|
|
1115
|
+
|
|
1116
|
+
protected restoreThemeSetting() {
|
|
1117
|
+
const setting = localStorage.getItem(this.darkModeLocalStorageKey) ?? this.config.get('theme.setting', 'system');
|
|
1118
|
+
if (setting && ['system', 'dark', 'light'].includes(setting)) {
|
|
1119
|
+
return setting as ThemeSetting;
|
|
1120
|
+
}
|
|
1121
|
+
return 'system';
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
protected storeThemeSetting(setting: ThemeSetting) {
|
|
1125
|
+
localStorage.setItem(this.darkModeLocalStorageKey, setting);
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
protected removeThemeClasses() {
|
|
1129
|
+
this.document.body.classList.remove('light');
|
|
1130
|
+
this.document.body.classList.remove('dark');
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
protected setThemeClasses(active: ActiveTheme) {
|
|
1134
|
+
this.document.body.classList.remove(active === 'light' ? 'dark' : 'light');
|
|
1135
|
+
this.document.body.classList.add(active);
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* Toggles the application theme between 'light' and 'dark' modes.
|
|
1140
|
+
* It checks the currently active theme and switches to the opposite mode.
|
|
1141
|
+
*
|
|
1142
|
+
* @return {void} Does not return a value.
|
|
1143
|
+
*/
|
|
1144
|
+
public toggleTheme(): void {
|
|
1145
|
+
const currentActive = this.activeTheme();
|
|
1146
|
+
// Determine the new setting based on the *currently active* theme.
|
|
1147
|
+
const newActive = currentActive === 'light' ? 'dark' : 'light';
|
|
1148
|
+
this.themeSetting.set(newActive);
|
|
1149
|
+
this.activeTheme.set(newActive);
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* Sets the active theme for the application and optionally publishes the change.
|
|
1154
|
+
*
|
|
1155
|
+
* @param {ActiveTheme} active - The theme to be set as active.
|
|
1156
|
+
* @param {boolean} [publish=true] - Indicates whether to publish the theme change event.
|
|
1157
|
+
* @return {void}
|
|
1158
|
+
*/
|
|
1159
|
+
public setTheme(active: ActiveTheme, publish = true) {
|
|
1160
|
+
this.themeSetting.set(active);
|
|
1161
|
+
this.activeTheme.set(active);
|
|
1162
|
+
if (publish) {
|
|
1163
|
+
this.pubSub.publish(RXAP_TOPICS.theme.darkMode.changed, this.darkMode());
|
|
1164
|
+
}
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
}
|
|
1168
|
+
</code></pre>
|
|
1169
|
+
</div>
|
|
1170
|
+
|
|
1171
|
+
</div>
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
</div><div class="search-results">
|
|
1186
|
+
<div class="has-results">
|
|
1187
|
+
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
1188
|
+
<ul class="search-results-list"></ul>
|
|
1189
|
+
</div>
|
|
1190
|
+
<div class="no-results">
|
|
1191
|
+
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
1192
|
+
</div>
|
|
1193
|
+
</div>
|
|
1194
|
+
</div>
|
|
1195
|
+
<!-- END CONTENT -->
|
|
1196
|
+
</div>
|
|
1197
|
+
</div>
|
|
1198
|
+
|
|
1199
|
+
<label class="dark-mode-switch">
|
|
1200
|
+
<input type="checkbox">
|
|
1201
|
+
<span class="slider">
|
|
1202
|
+
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
|
|
1203
|
+
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
|
|
1204
|
+
</svg>
|
|
1205
|
+
</span>
|
|
1206
|
+
</label>
|
|
1207
|
+
|
|
1208
|
+
<script>
|
|
1209
|
+
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
|
|
1210
|
+
var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
|
|
1211
|
+
var COMPODOC_CURRENT_PAGE_URL = 'ThemeModeService.html';
|
|
1212
|
+
var MAX_SEARCH_RESULTS = 15;
|
|
1213
|
+
</script>
|
|
1214
|
+
|
|
1215
|
+
<script>
|
|
1216
|
+
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
1217
|
+
checkToggle(darkModeState);
|
|
1218
|
+
if ($darkModeToggleSwitchers.length > 0) {
|
|
1219
|
+
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
1220
|
+
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
|
|
1221
|
+
darkModeState = !darkModeState;
|
|
1222
|
+
toggleDarkMode(darkModeState);
|
|
1223
|
+
});
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1226
|
+
</script>
|
|
1227
|
+
|
|
1228
|
+
<script src="../js/libs/custom-elements.min.js"></script>
|
|
1229
|
+
<script src="../js/libs/lit-html.js"></script>
|
|
1230
|
+
|
|
1231
|
+
<script src="../js/menu-wc.js" defer></script>
|
|
1232
|
+
<script nomodule src="../js/menu-wc_es5.js" defer></script>
|
|
1233
|
+
|
|
1234
|
+
<script src="../js/libs/bootstrap-native.js"></script>
|
|
1235
|
+
|
|
1236
|
+
<script src="../js/libs/es6-shim.min.js"></script>
|
|
1237
|
+
<script src="../js/libs/EventDispatcher.js"></script>
|
|
1238
|
+
<script src="../js/libs/promise.min.js"></script>
|
|
1239
|
+
<script src="../js/libs/zepto.min.js"></script>
|
|
1240
|
+
|
|
1241
|
+
<script src="../js/compodoc.js"></script>
|
|
1242
|
+
|
|
1243
|
+
<script src="../js/tabs.js"></script>
|
|
1244
|
+
<script src="../js/menu.js"></script>
|
|
1245
|
+
<script src="../js/libs/clipboard.min.js"></script>
|
|
1246
|
+
<script src="../js/libs/prism.js"></script>
|
|
1247
|
+
<script src="../js/sourceCode.js"></script>
|
|
1248
|
+
<script src="../js/search/search.js"></script>
|
|
1249
|
+
<script src="../js/search/lunr.min.js"></script>
|
|
1250
|
+
<script src="../js/search/search-lunr.js"></script>
|
|
1251
|
+
<script src="../js/search/search_index.js"></script>
|
|
1252
|
+
<script src="../js/lazy-load-graphs.js"></script>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
</body>
|
|
1256
|
+
</html>
|