@rxap/ngx-theme 19.0.3 → 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 +10 -0
- package/README.md +85 -0
- package/compodoc/changelog.html +7 -0
- package/compodoc/dependencies.html +6 -6
- 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 +145 -64
- 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 +16 -16
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-theme v19.0.
|
|
1
|
+
[**@rxap/ngx-theme v19.1.0-dev.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ColorPaletteConfigWithName
|
|
8
8
|
|
|
9
|
-
Defined in: [theme.service.ts:
|
|
9
|
+
Defined in: [theme.service.ts:28](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L28)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [theme.service.ts:27](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
18
18
|
|
|
19
19
|
> `optional` **algorithm**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [theme.service.ts:
|
|
21
|
+
Defined in: [theme.service.ts:41](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L41)
|
|
22
22
|
|
|
23
23
|
#### Inherited from
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Defined in: [theme.service.ts:40](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
30
30
|
|
|
31
31
|
> `optional` **base**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [theme.service.ts:
|
|
33
|
+
Defined in: [theme.service.ts:42](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L42)
|
|
34
34
|
|
|
35
35
|
#### Inherited from
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ Defined in: [theme.service.ts:41](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
42
42
|
|
|
43
43
|
> `optional` **color**: `Partial`\<[`ColorPalette`](ColorPalette.md)\>
|
|
44
44
|
|
|
45
|
-
Defined in: [theme.service.ts:
|
|
45
|
+
Defined in: [theme.service.ts:43](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L43)
|
|
46
46
|
|
|
47
47
|
#### Inherited from
|
|
48
48
|
|
|
@@ -54,4 +54,4 @@ Defined in: [theme.service.ts:42](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
54
54
|
|
|
55
55
|
> `optional` **name**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [theme.service.ts:
|
|
57
|
+
Defined in: [theme.service.ts:29](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L29)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-theme v19.0.
|
|
1
|
+
[**@rxap/ngx-theme v19.1.0-dev.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ThemeConfig
|
|
8
8
|
|
|
9
|
-
Defined in: [theme.service.ts:
|
|
9
|
+
Defined in: [theme.service.ts:32](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L32)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [theme.service.ts:31](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
14
14
|
|
|
15
15
|
> `optional` **accentColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
16
16
|
|
|
17
|
-
Defined in: [theme.service.ts:
|
|
17
|
+
Defined in: [theme.service.ts:34](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L34)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [theme.service.ts:33](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
22
22
|
|
|
23
23
|
> `optional` **density**: `ThemeDensity`
|
|
24
24
|
|
|
25
|
-
Defined in: [theme.service.ts:
|
|
25
|
+
Defined in: [theme.service.ts:36](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L36)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [theme.service.ts:35](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
30
30
|
|
|
31
31
|
> `optional` **primaryColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
32
32
|
|
|
33
|
-
Defined in: [theme.service.ts:
|
|
33
|
+
Defined in: [theme.service.ts:33](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L33)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [theme.service.ts:32](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
38
38
|
|
|
39
39
|
> `optional` **typography**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [theme.service.ts:
|
|
41
|
+
Defined in: [theme.service.ts:37](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L37)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,4 +46,4 @@ Defined in: [theme.service.ts:36](https://gitlab.com/rxap/packages/-/blob/15b5fa
|
|
|
46
46
|
|
|
47
47
|
> `optional` **warnColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
48
48
|
|
|
49
|
-
Defined in: [theme.service.ts:
|
|
49
|
+
Defined in: [theme.service.ts:35](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme.service.ts#L35)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**@rxap/ngx-theme v19.1.0-dev.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / ActiveTheme
|
|
6
|
+
|
|
7
|
+
# Type Alias: ActiveTheme
|
|
8
|
+
|
|
9
|
+
> **ActiveTheme**: `"light"` \| `"dark"`
|
|
10
|
+
|
|
11
|
+
Defined in: [theme-mode.service.ts:30](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L30)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**@rxap/ngx-theme v19.1.0-dev.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / ThemeSetting
|
|
6
|
+
|
|
7
|
+
# Type Alias: ThemeSetting
|
|
8
|
+
|
|
9
|
+
> **ThemeSetting**: `"system"` \| `"light"` \| `"dark"`
|
|
10
|
+
|
|
11
|
+
Defined in: [theme-mode.service.ts:28](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L28)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**@rxap/ngx-theme v19.1.0-dev.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / THEME\_SETTING\_KEY
|
|
6
|
+
|
|
7
|
+
# Variable: THEME\_SETTING\_KEY
|
|
8
|
+
|
|
9
|
+
> `const` **THEME\_SETTING\_KEY**: `"rxap_theme_settings"` = `'rxap_theme_settings'`
|
|
10
|
+
|
|
11
|
+
Defined in: [theme-mode.service.ts:32](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L32)
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / ThemeModeService
|
|
2
|
+
|
|
3
|
+
# Class: ThemeModeService
|
|
4
|
+
|
|
5
|
+
Defined in: [theme-mode.service.ts:46](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L46)
|
|
6
|
+
|
|
7
|
+
Service to manage theme mode (light/dark/system) for the application.
|
|
8
|
+
It provides functionality to handle theme preferences, persist them, and synchronize changes.
|
|
9
|
+
|
|
10
|
+
This service integrates with media queries to detect system-level theme changes and allows the user
|
|
11
|
+
or application logic to toggle or set a specific theme.
|
|
12
|
+
|
|
13
|
+
It utilizes dependency injection to access various required services and the document object.
|
|
14
|
+
Additionally, it publishes theme-related events for other parts of the application to react to
|
|
15
|
+
theme changes.
|
|
16
|
+
|
|
17
|
+
## Implements
|
|
18
|
+
|
|
19
|
+
- `OnDestroy`
|
|
20
|
+
|
|
21
|
+
## Constructors
|
|
22
|
+
|
|
23
|
+
### new ThemeModeService()
|
|
24
|
+
|
|
25
|
+
> **new ThemeModeService**(`mediaMatcher`, `document`): [`ThemeModeService`](../wiki/Class.ThemeModeService)
|
|
26
|
+
|
|
27
|
+
Defined in: [theme-mode.service.ts:62](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L62)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
##### mediaMatcher
|
|
32
|
+
|
|
33
|
+
`MediaMatcher`
|
|
34
|
+
|
|
35
|
+
##### document
|
|
36
|
+
|
|
37
|
+
`Document`
|
|
38
|
+
|
|
39
|
+
#### Returns
|
|
40
|
+
|
|
41
|
+
[`ThemeModeService`](../wiki/Class.ThemeModeService)
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
### activeTheme
|
|
46
|
+
|
|
47
|
+
> `readonly` **activeTheme**: `WritableSignal`\<[`ActiveTheme`](../wiki/TypeAlias.ActiveTheme)\>
|
|
48
|
+
|
|
49
|
+
Defined in: [theme-mode.service.ts:51](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L51)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### config
|
|
54
|
+
|
|
55
|
+
> `readonly` **config**: `ConfigService`\<`any`\>
|
|
56
|
+
|
|
57
|
+
Defined in: [theme-mode.service.ts:48](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L48)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### darkColorSchemaMediaQuery
|
|
62
|
+
|
|
63
|
+
> `protected` `readonly` **darkColorSchemaMediaQuery**: `MediaQueryList`
|
|
64
|
+
|
|
65
|
+
Defined in: [theme-mode.service.ts:55](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L55)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### darkMode
|
|
70
|
+
|
|
71
|
+
> `readonly` **darkMode**: `Signal`\<`boolean`\>
|
|
72
|
+
|
|
73
|
+
Defined in: [theme-mode.service.ts:53](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L53)
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### document
|
|
78
|
+
|
|
79
|
+
> `protected` `readonly` **document**: `Document`
|
|
80
|
+
|
|
81
|
+
Defined in: [theme-mode.service.ts:64](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L64)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### mediaMatcher
|
|
86
|
+
|
|
87
|
+
> `protected` `readonly` **mediaMatcher**: `MediaMatcher`
|
|
88
|
+
|
|
89
|
+
Defined in: [theme-mode.service.ts:63](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L63)
|
|
90
|
+
|
|
91
|
+
***
|
|
92
|
+
|
|
93
|
+
### mediaQueryListener()
|
|
94
|
+
|
|
95
|
+
> `protected` `readonly` **mediaQueryListener**: (`this`, `ev`) => `any`
|
|
96
|
+
|
|
97
|
+
Defined in: [theme-mode.service.ts:58](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L58)
|
|
98
|
+
|
|
99
|
+
#### Parameters
|
|
100
|
+
|
|
101
|
+
##### this
|
|
102
|
+
|
|
103
|
+
`MediaQueryList`
|
|
104
|
+
|
|
105
|
+
##### ev
|
|
106
|
+
|
|
107
|
+
`MediaQueryListEvent`
|
|
108
|
+
|
|
109
|
+
#### Returns
|
|
110
|
+
|
|
111
|
+
`any`
|
|
112
|
+
|
|
113
|
+
***
|
|
114
|
+
|
|
115
|
+
### pubSub
|
|
116
|
+
|
|
117
|
+
> `readonly` **pubSub**: `PubSubService`
|
|
118
|
+
|
|
119
|
+
Defined in: [theme-mode.service.ts:49](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L49)
|
|
120
|
+
|
|
121
|
+
***
|
|
122
|
+
|
|
123
|
+
### subscriptions
|
|
124
|
+
|
|
125
|
+
> `protected` `readonly` **subscriptions**: `null` \| `Subscription` = `null`
|
|
126
|
+
|
|
127
|
+
Defined in: [theme-mode.service.ts:57](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L57)
|
|
128
|
+
|
|
129
|
+
***
|
|
130
|
+
|
|
131
|
+
### syncSubscription?
|
|
132
|
+
|
|
133
|
+
> `protected` `optional` **syncSubscription**: `Subscription`
|
|
134
|
+
|
|
135
|
+
Defined in: [theme-mode.service.ts:60](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L60)
|
|
136
|
+
|
|
137
|
+
***
|
|
138
|
+
|
|
139
|
+
### themeSetting
|
|
140
|
+
|
|
141
|
+
> `readonly` **themeSetting**: `WritableSignal`\<[`ThemeSetting`](../wiki/TypeAlias.ThemeSetting)\>
|
|
142
|
+
|
|
143
|
+
Defined in: [theme-mode.service.ts:52](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L52)
|
|
144
|
+
|
|
145
|
+
## Methods
|
|
146
|
+
|
|
147
|
+
### ngOnDestroy()
|
|
148
|
+
|
|
149
|
+
> **ngOnDestroy**(): `void`
|
|
150
|
+
|
|
151
|
+
Defined in: [theme-mode.service.ts:128](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L128)
|
|
152
|
+
|
|
153
|
+
Cleans up subscriptions and event listeners when the service is destroyed.
|
|
154
|
+
|
|
155
|
+
#### Returns
|
|
156
|
+
|
|
157
|
+
`void`
|
|
158
|
+
|
|
159
|
+
#### Implementation of
|
|
160
|
+
|
|
161
|
+
`OnDestroy.ngOnDestroy`
|
|
162
|
+
|
|
163
|
+
***
|
|
164
|
+
|
|
165
|
+
### removeThemeClasses()
|
|
166
|
+
|
|
167
|
+
> `protected` **removeThemeClasses**(): `void`
|
|
168
|
+
|
|
169
|
+
Defined in: [theme-mode.service.ts:148](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L148)
|
|
170
|
+
|
|
171
|
+
#### Returns
|
|
172
|
+
|
|
173
|
+
`void`
|
|
174
|
+
|
|
175
|
+
***
|
|
176
|
+
|
|
177
|
+
### restoreFromPubSub()
|
|
178
|
+
|
|
179
|
+
> `protected` **restoreFromPubSub**(): `void`
|
|
180
|
+
|
|
181
|
+
Defined in: [theme-mode.service.ts:108](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L108)
|
|
182
|
+
|
|
183
|
+
#### Returns
|
|
184
|
+
|
|
185
|
+
`void`
|
|
186
|
+
|
|
187
|
+
***
|
|
188
|
+
|
|
189
|
+
### restoreThemeSetting()
|
|
190
|
+
|
|
191
|
+
> `protected` **restoreThemeSetting**(): [`ThemeSetting`](../wiki/TypeAlias.ThemeSetting)
|
|
192
|
+
|
|
193
|
+
Defined in: [theme-mode.service.ts:136](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L136)
|
|
194
|
+
|
|
195
|
+
#### Returns
|
|
196
|
+
|
|
197
|
+
[`ThemeSetting`](../wiki/TypeAlias.ThemeSetting)
|
|
198
|
+
|
|
199
|
+
***
|
|
200
|
+
|
|
201
|
+
### setTheme()
|
|
202
|
+
|
|
203
|
+
> **setTheme**(`active`, `publish`?): `void`
|
|
204
|
+
|
|
205
|
+
Defined in: [theme-mode.service.ts:179](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L179)
|
|
206
|
+
|
|
207
|
+
Sets the active theme for the application and optionally publishes the change.
|
|
208
|
+
|
|
209
|
+
#### Parameters
|
|
210
|
+
|
|
211
|
+
##### active
|
|
212
|
+
|
|
213
|
+
[`ActiveTheme`](../wiki/TypeAlias.ActiveTheme)
|
|
214
|
+
|
|
215
|
+
The theme to be set as active.
|
|
216
|
+
|
|
217
|
+
##### publish?
|
|
218
|
+
|
|
219
|
+
`boolean` = `true`
|
|
220
|
+
|
|
221
|
+
Indicates whether to publish the theme change event.
|
|
222
|
+
|
|
223
|
+
#### Returns
|
|
224
|
+
|
|
225
|
+
`void`
|
|
226
|
+
|
|
227
|
+
***
|
|
228
|
+
|
|
229
|
+
### setThemeClasses()
|
|
230
|
+
|
|
231
|
+
> `protected` **setThemeClasses**(`active`): `void`
|
|
232
|
+
|
|
233
|
+
Defined in: [theme-mode.service.ts:153](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L153)
|
|
234
|
+
|
|
235
|
+
#### Parameters
|
|
236
|
+
|
|
237
|
+
##### active
|
|
238
|
+
|
|
239
|
+
[`ActiveTheme`](../wiki/TypeAlias.ActiveTheme)
|
|
240
|
+
|
|
241
|
+
#### Returns
|
|
242
|
+
|
|
243
|
+
`void`
|
|
244
|
+
|
|
245
|
+
***
|
|
246
|
+
|
|
247
|
+
### storeThemeSetting()
|
|
248
|
+
|
|
249
|
+
> `protected` **storeThemeSetting**(`setting`): `void`
|
|
250
|
+
|
|
251
|
+
Defined in: [theme-mode.service.ts:144](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L144)
|
|
252
|
+
|
|
253
|
+
#### Parameters
|
|
254
|
+
|
|
255
|
+
##### setting
|
|
256
|
+
|
|
257
|
+
[`ThemeSetting`](../wiki/TypeAlias.ThemeSetting)
|
|
258
|
+
|
|
259
|
+
#### Returns
|
|
260
|
+
|
|
261
|
+
`void`
|
|
262
|
+
|
|
263
|
+
***
|
|
264
|
+
|
|
265
|
+
### toggleTheme()
|
|
266
|
+
|
|
267
|
+
> **toggleTheme**(): `void`
|
|
268
|
+
|
|
269
|
+
Defined in: [theme-mode.service.ts:164](https://gitlab.com/rxap/packages/-/blob/b32f110144dafee760d535d217a2855e77f154a5/packages/angular/theme/src/lib/theme-mode.service.ts#L164)
|
|
270
|
+
|
|
271
|
+
Toggles the application theme between 'light' and 'dark' modes.
|
|
272
|
+
It checks the currently active theme and switches to the opposite mode.
|
|
273
|
+
|
|
274
|
+
#### Returns
|
|
275
|
+
|
|
276
|
+
`void`
|
|
277
|
+
|
|
278
|
+
Does not return a value.
|