@rxap/ngx-theme 19.0.1-dev.4 → 19.0.1
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 +14 -0
- package/README.md +24 -25
- package/compodoc/changelog.html +9 -0
- package/compodoc/dependencies.html +4 -4
- package/compodoc/index.html +26 -17
- package/compodoc/js/menu-wc.js +3 -0
- package/compodoc/js/menu-wc_es5.js +1 -1
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/miscellaneous/variables.html +221 -0
- package/compodoc/properties.html +4 -1
- package/docs/documentation.json +211 -765
- package/docs/html/assets/hierarchy.js +1 -0
- package/docs/{assets → html/assets}/highlight.css +13 -6
- package/docs/html/assets/icons.js +18 -0
- package/docs/html/assets/icons.svg +1 -0
- package/docs/{assets → html/assets}/main.js +5 -4
- package/docs/html/assets/navigation.js +1 -0
- package/docs/html/assets/search.js +1 -0
- package/docs/html/assets/style.css +1611 -0
- package/docs/html/classes/ThemeService.html +32 -0
- package/docs/html/enums/ColorPaletteAlgorithm.html +3 -0
- package/docs/html/functions/ComputeColorPalette.html +1 -0
- package/docs/html/functions/ObserveCurrentThemeDensity.html +1 -0
- package/docs/html/functions/provideTheme.html +1 -0
- package/docs/html/hierarchy.html +1 -0
- package/docs/html/index.html +33 -0
- package/docs/html/interfaces/ColorPalette.html +15 -0
- package/docs/html/interfaces/ColorPaletteConfig.html +4 -0
- package/docs/html/interfaces/ColorPaletteConfigWithName.html +5 -0
- package/docs/html/interfaces/ThemeConfig.html +6 -0
- package/docs/html/modules.html +1 -0
- package/docs/markdown/README.md +37 -0
- package/docs/markdown/classes/ThemeService.md +441 -0
- package/docs/markdown/enumerations/ColorPaletteAlgorithm.md +25 -0
- package/docs/markdown/functions/ComputeColorPalette.md +29 -0
- package/docs/markdown/functions/ObserveCurrentThemeDensity.md +15 -0
- package/docs/markdown/functions/provideTheme.md +15 -0
- package/docs/markdown/globals.md +26 -0
- package/docs/markdown/interfaces/ColorPalette.md +121 -0
- package/docs/markdown/interfaces/ColorPaletteConfig.md +37 -0
- package/docs/markdown/interfaces/ColorPaletteConfigWithName.md +57 -0
- package/docs/markdown/interfaces/ThemeConfig.md +49 -0
- package/docs/wiki/Class.ThemeService.md +437 -0
- package/docs/wiki/Enumeration.ColorPaletteAlgorithm.md +21 -0
- package/docs/wiki/Function.ComputeColorPalette.md +25 -0
- package/docs/wiki/Function.ObserveCurrentThemeDensity.md +11 -0
- package/docs/wiki/Function.provideTheme.md +11 -0
- package/docs/wiki/Home.md +33 -0
- package/docs/wiki/Interface.ColorPalette.md +117 -0
- package/docs/wiki/Interface.ColorPaletteConfig.md +33 -0
- package/docs/wiki/Interface.ColorPaletteConfigWithName.md +53 -0
- package/docs/wiki/Interface.ThemeConfig.md +45 -0
- package/docs/wiki/_Sidebar.md +22 -0
- package/docs/wiki/globals.md +22 -0
- package/package.json +13 -11
- package/docs/assets/icons.js +0 -15
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1412
- package/docs/classes/ThemeService.html +0 -42
- package/docs/enums/ColorPaletteAlgorithm.html +0 -3
- package/docs/functions/ComputeColorPalette.html +0 -1
- package/docs/functions/ObserveCurrentThemeDensity.html +0 -1
- package/docs/functions/provideTheme.html +0 -1
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -25
- package/docs/interfaces/ColorPalette.html +0 -15
- package/docs/interfaces/ColorPaletteConfig.html +0 -4
- package/docs/interfaces/ColorPaletteConfigWithName.html +0 -5
- package/docs/interfaces/ThemeConfig.html +0 -6
- package/docs/modules.html +0 -10
- /package/docs/{.nojekyll → html/.nojekyll} +0 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@rxap/ngx-theme**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / ColorPaletteConfig
|
|
6
|
+
|
|
7
|
+
# Interface: ColorPaletteConfig
|
|
8
|
+
|
|
9
|
+
Defined in: [theme.service.ts:39](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L39)
|
|
10
|
+
|
|
11
|
+
## Extended by
|
|
12
|
+
|
|
13
|
+
- [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### algorithm?
|
|
18
|
+
|
|
19
|
+
> `optional` **algorithm**: `string`
|
|
20
|
+
|
|
21
|
+
Defined in: [theme.service.ts:40](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L40)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### base?
|
|
26
|
+
|
|
27
|
+
> `optional` **base**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [theme.service.ts:41](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L41)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### color?
|
|
34
|
+
|
|
35
|
+
> `optional` **color**: `Partial`\<[`ColorPalette`](ColorPalette.md)\>
|
|
36
|
+
|
|
37
|
+
Defined in: [theme.service.ts:42](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L42)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[**@rxap/ngx-theme**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / ColorPaletteConfigWithName
|
|
6
|
+
|
|
7
|
+
# Interface: ColorPaletteConfigWithName
|
|
8
|
+
|
|
9
|
+
Defined in: [theme.service.ts:27](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L27)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`ColorPaletteConfig`](ColorPaletteConfig.md)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### algorithm?
|
|
18
|
+
|
|
19
|
+
> `optional` **algorithm**: `string`
|
|
20
|
+
|
|
21
|
+
Defined in: [theme.service.ts:40](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L40)
|
|
22
|
+
|
|
23
|
+
#### Inherited from
|
|
24
|
+
|
|
25
|
+
[`ColorPaletteConfig`](ColorPaletteConfig.md).[`algorithm`](ColorPaletteConfig.md#algorithm)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### base?
|
|
30
|
+
|
|
31
|
+
> `optional` **base**: `string`
|
|
32
|
+
|
|
33
|
+
Defined in: [theme.service.ts:41](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L41)
|
|
34
|
+
|
|
35
|
+
#### Inherited from
|
|
36
|
+
|
|
37
|
+
[`ColorPaletteConfig`](ColorPaletteConfig.md).[`base`](ColorPaletteConfig.md#base)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### color?
|
|
42
|
+
|
|
43
|
+
> `optional` **color**: `Partial`\<[`ColorPalette`](ColorPalette.md)\>
|
|
44
|
+
|
|
45
|
+
Defined in: [theme.service.ts:42](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L42)
|
|
46
|
+
|
|
47
|
+
#### Inherited from
|
|
48
|
+
|
|
49
|
+
[`ColorPaletteConfig`](ColorPaletteConfig.md).[`color`](ColorPaletteConfig.md#color)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### name?
|
|
54
|
+
|
|
55
|
+
> `optional` **name**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [theme.service.ts:28](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L28)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@rxap/ngx-theme**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/ngx-theme](../globals.md) / ThemeConfig
|
|
6
|
+
|
|
7
|
+
# Interface: ThemeConfig
|
|
8
|
+
|
|
9
|
+
Defined in: [theme.service.ts:31](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L31)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### accentColor?
|
|
14
|
+
|
|
15
|
+
> `optional` **accentColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
16
|
+
|
|
17
|
+
Defined in: [theme.service.ts:33](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L33)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### density?
|
|
22
|
+
|
|
23
|
+
> `optional` **density**: `ThemeDensity`
|
|
24
|
+
|
|
25
|
+
Defined in: [theme.service.ts:35](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L35)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### primaryColor?
|
|
30
|
+
|
|
31
|
+
> `optional` **primaryColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
32
|
+
|
|
33
|
+
Defined in: [theme.service.ts:32](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L32)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### typography?
|
|
38
|
+
|
|
39
|
+
> `optional` **typography**: `string`
|
|
40
|
+
|
|
41
|
+
Defined in: [theme.service.ts:36](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L36)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### warnColor?
|
|
46
|
+
|
|
47
|
+
> `optional` **warnColor**: [`ColorPaletteConfigWithName`](ColorPaletteConfigWithName.md)
|
|
48
|
+
|
|
49
|
+
Defined in: [theme.service.ts:34](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L34)
|
|
@@ -0,0 +1,437 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / ThemeService
|
|
2
|
+
|
|
3
|
+
# Class: ThemeService
|
|
4
|
+
|
|
5
|
+
Defined in: [theme.service.ts:46](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L46)
|
|
6
|
+
|
|
7
|
+
## Constructors
|
|
8
|
+
|
|
9
|
+
### new ThemeService()
|
|
10
|
+
|
|
11
|
+
> **new ThemeService**(`mediaMatcher`): [`ThemeService`](../wiki/Class.ThemeService)
|
|
12
|
+
|
|
13
|
+
Defined in: [theme.service.ts:60](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L60)
|
|
14
|
+
|
|
15
|
+
#### Parameters
|
|
16
|
+
|
|
17
|
+
##### mediaMatcher
|
|
18
|
+
|
|
19
|
+
`MediaMatcher`
|
|
20
|
+
|
|
21
|
+
#### Returns
|
|
22
|
+
|
|
23
|
+
[`ThemeService`](../wiki/Class.ThemeService)
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
### config
|
|
28
|
+
|
|
29
|
+
> `readonly` **config**: `ConfigService`\<`any`\>
|
|
30
|
+
|
|
31
|
+
Defined in: [theme.service.ts:48](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L48)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### darkMode
|
|
36
|
+
|
|
37
|
+
> `readonly` **darkMode**: `WritableSignal`\<`boolean`\>
|
|
38
|
+
|
|
39
|
+
Defined in: [theme.service.ts:51](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L51)
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### darkModeMediaQuery
|
|
44
|
+
|
|
45
|
+
> `protected` `readonly` **darkModeMediaQuery**: `MediaQueryList`
|
|
46
|
+
|
|
47
|
+
Defined in: [theme.service.ts:56](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L56)
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### density
|
|
52
|
+
|
|
53
|
+
> `readonly` **density**: `WritableSignal`\<`ThemeDensity`\>
|
|
54
|
+
|
|
55
|
+
Defined in: [theme.service.ts:53](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L53)
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### pubSub
|
|
60
|
+
|
|
61
|
+
> `readonly` **pubSub**: `PubSubService`
|
|
62
|
+
|
|
63
|
+
Defined in: [theme.service.ts:49](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L49)
|
|
64
|
+
|
|
65
|
+
***
|
|
66
|
+
|
|
67
|
+
### syncSubscription?
|
|
68
|
+
|
|
69
|
+
> `protected` `optional` **syncSubscription**: `Subscription`
|
|
70
|
+
|
|
71
|
+
Defined in: [theme.service.ts:58](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L58)
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### themeName
|
|
76
|
+
|
|
77
|
+
> `readonly` **themeName**: `WritableSignal`\<`string`\>
|
|
78
|
+
|
|
79
|
+
Defined in: [theme.service.ts:52](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L52)
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### typography
|
|
84
|
+
|
|
85
|
+
> `readonly` **typography**: `WritableSignal`\<`string`\>
|
|
86
|
+
|
|
87
|
+
Defined in: [theme.service.ts:54](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L54)
|
|
88
|
+
|
|
89
|
+
## Methods
|
|
90
|
+
|
|
91
|
+
### applyDarkMode()
|
|
92
|
+
|
|
93
|
+
> **applyDarkMode**(`darkMode`): `void`
|
|
94
|
+
|
|
95
|
+
Defined in: [theme.service.ts:258](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L258)
|
|
96
|
+
|
|
97
|
+
#### Parameters
|
|
98
|
+
|
|
99
|
+
##### darkMode
|
|
100
|
+
|
|
101
|
+
`boolean`
|
|
102
|
+
|
|
103
|
+
#### Returns
|
|
104
|
+
|
|
105
|
+
`void`
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### applyDensity()
|
|
110
|
+
|
|
111
|
+
> **applyDensity**(`density`): `void`
|
|
112
|
+
|
|
113
|
+
Defined in: [theme.service.ts:274](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L274)
|
|
114
|
+
|
|
115
|
+
#### Parameters
|
|
116
|
+
|
|
117
|
+
##### density
|
|
118
|
+
|
|
119
|
+
`ThemeDensity`
|
|
120
|
+
|
|
121
|
+
#### Returns
|
|
122
|
+
|
|
123
|
+
`void`
|
|
124
|
+
|
|
125
|
+
***
|
|
126
|
+
|
|
127
|
+
### applyTheme()
|
|
128
|
+
|
|
129
|
+
> **applyTheme**(`themeName`): `void`
|
|
130
|
+
|
|
131
|
+
Defined in: [theme.service.ts:285](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L285)
|
|
132
|
+
|
|
133
|
+
#### Parameters
|
|
134
|
+
|
|
135
|
+
##### themeName
|
|
136
|
+
|
|
137
|
+
`string`
|
|
138
|
+
|
|
139
|
+
#### Returns
|
|
140
|
+
|
|
141
|
+
`void`
|
|
142
|
+
|
|
143
|
+
***
|
|
144
|
+
|
|
145
|
+
### applyTypography()
|
|
146
|
+
|
|
147
|
+
> **applyTypography**(`typography`): `void`
|
|
148
|
+
|
|
149
|
+
Defined in: [theme.service.ts:281](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L281)
|
|
150
|
+
|
|
151
|
+
#### Parameters
|
|
152
|
+
|
|
153
|
+
##### typography
|
|
154
|
+
|
|
155
|
+
`string`
|
|
156
|
+
|
|
157
|
+
#### Returns
|
|
158
|
+
|
|
159
|
+
`void`
|
|
160
|
+
|
|
161
|
+
***
|
|
162
|
+
|
|
163
|
+
### getAvailableColorPalettes()
|
|
164
|
+
|
|
165
|
+
> **getAvailableColorPalettes**(): `null` \| `string`[]
|
|
166
|
+
|
|
167
|
+
Defined in: [theme.service.ts:348](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L348)
|
|
168
|
+
|
|
169
|
+
#### Returns
|
|
170
|
+
|
|
171
|
+
`null` \| `string`[]
|
|
172
|
+
|
|
173
|
+
***
|
|
174
|
+
|
|
175
|
+
### getAvailableThemes()
|
|
176
|
+
|
|
177
|
+
> **getAvailableThemes**(): `null` \| `string`[]
|
|
178
|
+
|
|
179
|
+
Defined in: [theme.service.ts:358](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L358)
|
|
180
|
+
|
|
181
|
+
#### Returns
|
|
182
|
+
|
|
183
|
+
`null` \| `string`[]
|
|
184
|
+
|
|
185
|
+
***
|
|
186
|
+
|
|
187
|
+
### getAvailableTypographies()
|
|
188
|
+
|
|
189
|
+
> **getAvailableTypographies**(): `null` \| `string`[]
|
|
190
|
+
|
|
191
|
+
Defined in: [theme.service.ts:368](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L368)
|
|
192
|
+
|
|
193
|
+
#### Returns
|
|
194
|
+
|
|
195
|
+
`null` \| `string`[]
|
|
196
|
+
|
|
197
|
+
***
|
|
198
|
+
|
|
199
|
+
### getColorPalette()
|
|
200
|
+
|
|
201
|
+
> **getColorPalette**(`colorPaletteName`): `Partial`\<[`ColorPalette`](../wiki/Interface.ColorPalette)\>
|
|
202
|
+
|
|
203
|
+
Defined in: [theme.service.ts:387](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L387)
|
|
204
|
+
|
|
205
|
+
#### Parameters
|
|
206
|
+
|
|
207
|
+
##### colorPaletteName
|
|
208
|
+
|
|
209
|
+
`string`
|
|
210
|
+
|
|
211
|
+
#### Returns
|
|
212
|
+
|
|
213
|
+
`Partial`\<[`ColorPalette`](../wiki/Interface.ColorPalette)\>
|
|
214
|
+
|
|
215
|
+
***
|
|
216
|
+
|
|
217
|
+
### getDensity()
|
|
218
|
+
|
|
219
|
+
> **getDensity**(): `ThemeDensity`
|
|
220
|
+
|
|
221
|
+
Defined in: [theme.service.ts:320](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L320)
|
|
222
|
+
|
|
223
|
+
#### Returns
|
|
224
|
+
|
|
225
|
+
`ThemeDensity`
|
|
226
|
+
|
|
227
|
+
***
|
|
228
|
+
|
|
229
|
+
### getTheme()
|
|
230
|
+
|
|
231
|
+
> **getTheme**(): `string`
|
|
232
|
+
|
|
233
|
+
Defined in: [theme.service.ts:340](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L340)
|
|
234
|
+
|
|
235
|
+
#### Returns
|
|
236
|
+
|
|
237
|
+
`string`
|
|
238
|
+
|
|
239
|
+
***
|
|
240
|
+
|
|
241
|
+
### getTypography()
|
|
242
|
+
|
|
243
|
+
> **getTypography**(): `string`
|
|
244
|
+
|
|
245
|
+
Defined in: [theme.service.ts:331](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L331)
|
|
246
|
+
|
|
247
|
+
#### Returns
|
|
248
|
+
|
|
249
|
+
`string`
|
|
250
|
+
|
|
251
|
+
***
|
|
252
|
+
|
|
253
|
+
### restore()
|
|
254
|
+
|
|
255
|
+
> **restore**(): `void`
|
|
256
|
+
|
|
257
|
+
Defined in: [theme.service.ts:71](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L71)
|
|
258
|
+
|
|
259
|
+
#### Returns
|
|
260
|
+
|
|
261
|
+
`void`
|
|
262
|
+
|
|
263
|
+
***
|
|
264
|
+
|
|
265
|
+
### restoreDarkMode()
|
|
266
|
+
|
|
267
|
+
> **restoreDarkMode**(): `null` \| `boolean`
|
|
268
|
+
|
|
269
|
+
Defined in: [theme.service.ts:149](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L149)
|
|
270
|
+
|
|
271
|
+
#### Returns
|
|
272
|
+
|
|
273
|
+
`null` \| `boolean`
|
|
274
|
+
|
|
275
|
+
***
|
|
276
|
+
|
|
277
|
+
### restoreDensity()
|
|
278
|
+
|
|
279
|
+
> **restoreDensity**(): `null` \| `ThemeDensity`
|
|
280
|
+
|
|
281
|
+
Defined in: [theme.service.ts:180](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L180)
|
|
282
|
+
|
|
283
|
+
#### Returns
|
|
284
|
+
|
|
285
|
+
`null` \| `ThemeDensity`
|
|
286
|
+
|
|
287
|
+
***
|
|
288
|
+
|
|
289
|
+
### restoreFromPubSub()
|
|
290
|
+
|
|
291
|
+
> `protected` **restoreFromPubSub**(): `void`
|
|
292
|
+
|
|
293
|
+
Defined in: [theme.service.ts:92](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L92)
|
|
294
|
+
|
|
295
|
+
#### Returns
|
|
296
|
+
|
|
297
|
+
`void`
|
|
298
|
+
|
|
299
|
+
***
|
|
300
|
+
|
|
301
|
+
### restoreThemeName()
|
|
302
|
+
|
|
303
|
+
> **restoreThemeName**(): `null` \| `string`
|
|
304
|
+
|
|
305
|
+
Defined in: [theme.service.ts:164](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L164)
|
|
306
|
+
|
|
307
|
+
#### Returns
|
|
308
|
+
|
|
309
|
+
`null` \| `string`
|
|
310
|
+
|
|
311
|
+
***
|
|
312
|
+
|
|
313
|
+
### restoreTypography()
|
|
314
|
+
|
|
315
|
+
> **restoreTypography**(): `null` \| `string`
|
|
316
|
+
|
|
317
|
+
Defined in: [theme.service.ts:172](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L172)
|
|
318
|
+
|
|
319
|
+
#### Returns
|
|
320
|
+
|
|
321
|
+
`null` \| `string`
|
|
322
|
+
|
|
323
|
+
***
|
|
324
|
+
|
|
325
|
+
### setDarkTheme()
|
|
326
|
+
|
|
327
|
+
> **setDarkTheme**(`darkMode`, `silent`, `publish`): `void`
|
|
328
|
+
|
|
329
|
+
Defined in: [theme.service.ts:200](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L200)
|
|
330
|
+
|
|
331
|
+
#### Parameters
|
|
332
|
+
|
|
333
|
+
##### darkMode
|
|
334
|
+
|
|
335
|
+
`boolean`
|
|
336
|
+
|
|
337
|
+
##### silent
|
|
338
|
+
|
|
339
|
+
`boolean` = `false`
|
|
340
|
+
|
|
341
|
+
##### publish
|
|
342
|
+
|
|
343
|
+
`boolean` = `true`
|
|
344
|
+
|
|
345
|
+
#### Returns
|
|
346
|
+
|
|
347
|
+
`void`
|
|
348
|
+
|
|
349
|
+
***
|
|
350
|
+
|
|
351
|
+
### setDensity()
|
|
352
|
+
|
|
353
|
+
> **setDensity**(`density`, `silent`, `publish`): `void`
|
|
354
|
+
|
|
355
|
+
Defined in: [theme.service.ts:213](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L213)
|
|
356
|
+
|
|
357
|
+
#### Parameters
|
|
358
|
+
|
|
359
|
+
##### density
|
|
360
|
+
|
|
361
|
+
`ThemeDensity`
|
|
362
|
+
|
|
363
|
+
##### silent
|
|
364
|
+
|
|
365
|
+
`boolean` = `false`
|
|
366
|
+
|
|
367
|
+
##### publish
|
|
368
|
+
|
|
369
|
+
`boolean` = `true`
|
|
370
|
+
|
|
371
|
+
#### Returns
|
|
372
|
+
|
|
373
|
+
`void`
|
|
374
|
+
|
|
375
|
+
***
|
|
376
|
+
|
|
377
|
+
### setTheme()
|
|
378
|
+
|
|
379
|
+
> **setTheme**(`themeName`, `silent`, `publish`): `void`
|
|
380
|
+
|
|
381
|
+
Defined in: [theme.service.ts:239](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L239)
|
|
382
|
+
|
|
383
|
+
#### Parameters
|
|
384
|
+
|
|
385
|
+
##### themeName
|
|
386
|
+
|
|
387
|
+
`string`
|
|
388
|
+
|
|
389
|
+
##### silent
|
|
390
|
+
|
|
391
|
+
`boolean` = `false`
|
|
392
|
+
|
|
393
|
+
##### publish
|
|
394
|
+
|
|
395
|
+
`boolean` = `true`
|
|
396
|
+
|
|
397
|
+
#### Returns
|
|
398
|
+
|
|
399
|
+
`void`
|
|
400
|
+
|
|
401
|
+
***
|
|
402
|
+
|
|
403
|
+
### setTypography()
|
|
404
|
+
|
|
405
|
+
> **setTypography**(`typography`, `silent`, `publish`): `void`
|
|
406
|
+
|
|
407
|
+
Defined in: [theme.service.ts:226](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L226)
|
|
408
|
+
|
|
409
|
+
#### Parameters
|
|
410
|
+
|
|
411
|
+
##### typography
|
|
412
|
+
|
|
413
|
+
`string`
|
|
414
|
+
|
|
415
|
+
##### silent
|
|
416
|
+
|
|
417
|
+
`boolean` = `false`
|
|
418
|
+
|
|
419
|
+
##### publish
|
|
420
|
+
|
|
421
|
+
`boolean` = `true`
|
|
422
|
+
|
|
423
|
+
#### Returns
|
|
424
|
+
|
|
425
|
+
`void`
|
|
426
|
+
|
|
427
|
+
***
|
|
428
|
+
|
|
429
|
+
### toggleDarkTheme()
|
|
430
|
+
|
|
431
|
+
> **toggleDarkTheme**(): `void`
|
|
432
|
+
|
|
433
|
+
Defined in: [theme.service.ts:194](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/theme.service.ts#L194)
|
|
434
|
+
|
|
435
|
+
#### Returns
|
|
436
|
+
|
|
437
|
+
`void`
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / ColorPaletteAlgorithm
|
|
2
|
+
|
|
3
|
+
# Enumeration: ColorPaletteAlgorithm
|
|
4
|
+
|
|
5
|
+
Defined in: [compute-color-palette.ts:25](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/compute-color-palette.ts#L25)
|
|
6
|
+
|
|
7
|
+
## Enumeration Members
|
|
8
|
+
|
|
9
|
+
### BUCKNER
|
|
10
|
+
|
|
11
|
+
> **BUCKNER**: `"buckner"`
|
|
12
|
+
|
|
13
|
+
Defined in: [compute-color-palette.ts:27](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/compute-color-palette.ts#L27)
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### CONSTANTIN
|
|
18
|
+
|
|
19
|
+
> **CONSTANTIN**: `"constantin"`
|
|
20
|
+
|
|
21
|
+
Defined in: [compute-color-palette.ts:26](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/compute-color-palette.ts#L26)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / ComputeColorPalette
|
|
2
|
+
|
|
3
|
+
# Function: ComputeColorPalette()
|
|
4
|
+
|
|
5
|
+
> **ComputeColorPalette**(`color`, `colorPalette`, `algorithm`?): [`ColorPalette`](../wiki/Interface.ColorPalette)
|
|
6
|
+
|
|
7
|
+
Defined in: [compute-color-palette.ts:30](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/compute-color-palette.ts#L30)
|
|
8
|
+
|
|
9
|
+
## Parameters
|
|
10
|
+
|
|
11
|
+
### color
|
|
12
|
+
|
|
13
|
+
`ColorInput`
|
|
14
|
+
|
|
15
|
+
### colorPalette
|
|
16
|
+
|
|
17
|
+
`Partial`\<[`ColorPalette`](../wiki/Interface.ColorPalette)\> = `{}`
|
|
18
|
+
|
|
19
|
+
### algorithm?
|
|
20
|
+
|
|
21
|
+
`string`
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
[`ColorPalette`](../wiki/Interface.ColorPalette)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / ObserveCurrentThemeDensity
|
|
2
|
+
|
|
3
|
+
# Function: ObserveCurrentThemeDensity()
|
|
4
|
+
|
|
5
|
+
> **ObserveCurrentThemeDensity**(): `Observable`\<`ThemeDensity`\>
|
|
6
|
+
|
|
7
|
+
Defined in: [observe-current-theme-density.ts:4](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/observe-current-theme-density.ts#L4)
|
|
8
|
+
|
|
9
|
+
## Returns
|
|
10
|
+
|
|
11
|
+
`Observable`\<`ThemeDensity`\>
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[@rxap/ngx-theme](../wiki/globals) / provideTheme
|
|
2
|
+
|
|
3
|
+
# Function: provideTheme()
|
|
4
|
+
|
|
5
|
+
> **provideTheme**(): `EnvironmentProviders`[]
|
|
6
|
+
|
|
7
|
+
Defined in: [provide.ts:7](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/theme/src/lib/provide.ts#L7)
|
|
8
|
+
|
|
9
|
+
## Returns
|
|
10
|
+
|
|
11
|
+
`EnvironmentProviders`[]
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
This package provides an Angular theme service that allows you to manage and customize the look and feel of your application. It includes features such as dark mode support, theme density control, typography settings, and color palette management. The service also provides utilities for computing color palettes and observing theme density changes.
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@rxap/ngx-theme)
|
|
4
|
+
[](https://commitizen.github.io/cz-cli/)
|
|
6
|
+
[](https://github.com/prettier/prettier)
|
|
8
|
+

|
|
10
|
+

|
|
11
|
+
 -
|
|
12
|
+
[Installation](../wiki/#installation)
|
|
13
|
+
- [Generators](../wiki/#generators)
|
|
14
|
+
- [init](../wiki/#init)
|
|
15
|
+
|
|
16
|
+
# Installation **Add the package to your workspace:** ```bash yarn add
|
|
17
|
+
@rxap/ngx-theme
|
|
18
|
+
```
|
|
19
|
+
**Install peer dependencies:** ```bash yarn add
|
|
20
|
+
@angular/cdk@^19.1.1 @angular/core@^19.1.3 @rxap/config@^19.0.1-dev.5 @rxap/ngx-pub-sub@^19.0.1-dev.5 @rxap/rxjs@^1.1.12-dev.5 @rxap/utilities@^16.4.2-dev.4 rxjs@^7.8.1
|
|
21
|
+
```
|
|
22
|
+
**Execute the init generator:** ```bash yarn nx g
|
|
23
|
+
@rxap/ngx-theme:init ```
|
|
24
|
+
# Generators
|
|
25
|
+
|
|
26
|
+
##
|
|
27
|
+
init
|
|
28
|
+
>
|
|
29
|
+
Initialize the package in the workspace
|
|
30
|
+
|
|
31
|
+
```bash nx g
|
|
32
|
+
@rxap/ngx-theme:init
|
|
33
|
+
```
|