@su-labs/theme 21.0.4 → 22.0.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 +11 -0
- package/README.md +189 -24
- package/fesm2022/su-labs-theme.mjs +121 -188
- package/fesm2022/su-labs-theme.mjs.map +1 -1
- package/package.json +7 -6
- package/types/su-labs-theme.d.ts +84 -89
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [22.0.0] - 2026-11-04
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- Upgrade to Angular 22 (peer dependencies now `^22.0.0`)
|
|
12
|
+
- Remove emojis from README.md
|
|
13
|
+
|
|
14
|
+
## [21.0.5] - 2026-02-04
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
- Update README.md
|
|
18
|
+
|
|
8
19
|
## [21.0.4] - 2026-02-03
|
|
9
20
|
|
|
10
21
|
### Changed
|
package/README.md
CHANGED
|
@@ -1,27 +1,115 @@
|
|
|
1
1
|
# SuThemeService
|
|
2
2
|
|
|
3
|
+
`@su-labs/theme`
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+

|
|
7
|
+

|
|
8
|
+

|
|
9
|
+

|
|
10
|
+

|
|
11
|
+

|
|
12
|
+

|
|
13
|
+
|
|
3
14
|
A robust and reactive Angular service for managing application themes. It provides a full-featured solution that supports dynamic switching, user preference persistence, and automatic system theme detection.
|
|
4
15
|
|
|
16
|
+
## Table of Contents
|
|
17
|
+
|
|
18
|
+
- [Why Use This Library?](#-why-use-this-library)
|
|
19
|
+
- [Features](#features)
|
|
20
|
+
- [Available Themes](#available-themes)
|
|
21
|
+
- [Installation](#installation)
|
|
22
|
+
- [Quick Start](#-quick-start)
|
|
23
|
+
- [Usage](#usage)
|
|
24
|
+
- [API Reference](#-api-reference)
|
|
25
|
+
- [Configuration Options](#configuration-options)
|
|
26
|
+
- [Browser Compatibility](#-browser-compatibility)
|
|
27
|
+
- [Related Libraries](#-related-libraries)
|
|
28
|
+
- [Troubleshooting](#-troubleshooting)
|
|
29
|
+
- [Support](#-support)
|
|
30
|
+
- [Contributing](#contributing)
|
|
31
|
+
- [License](#license)
|
|
32
|
+
|
|
33
|
+
## Why Use This Library?
|
|
34
|
+
|
|
35
|
+
- **Lightweight** - Minimal bundle size
|
|
36
|
+
- **Reactive** - Built with Angular Signals
|
|
37
|
+
- **CSS Variables** - Modern CSS custom properties
|
|
38
|
+
- **System Theme** - Auto-detects OS preference
|
|
39
|
+
- **Persistent** - Remembers user choice
|
|
40
|
+
- **Type-Safe** - Full TypeScript support
|
|
41
|
+
- **Zero Dependencies** - No bloat
|
|
42
|
+
- **Well Tested** - Comprehensive test coverage
|
|
43
|
+
|
|
5
44
|
## Features
|
|
6
45
|
|
|
7
|
-
* Reactive State
|
|
8
|
-
* System Theme Integration
|
|
9
|
-
* Persistence
|
|
10
|
-
* Configurable
|
|
11
|
-
* Programmatic Control
|
|
46
|
+
* **Reactive State**: Uses Angular signals for efficient, reactive theme management.
|
|
47
|
+
* **System Theme Integration**: Automatically follows the user's system theme preference (`prefers-color-scheme`).
|
|
48
|
+
* **Persistence**: Remembers the user's last-selected theme using `localStorage`.
|
|
49
|
+
* **Configurable**: Customizable with a configuration object for storage keys, CSS variable prefixes, and default themes.
|
|
50
|
+
* **Programmatic Control**: Simple public API to set, get, and track the active theme.
|
|
12
51
|
|
|
13
52
|
## Available Themes
|
|
14
53
|
|
|
15
54
|
The service currently supports the following theme names by default:
|
|
16
55
|
|
|
17
|
-
* `light`
|
|
18
|
-
* `dark`
|
|
19
|
-
* `contrast`
|
|
20
|
-
* `custom`
|
|
21
|
-
* `system`
|
|
56
|
+
* `light` - Light theme
|
|
57
|
+
* `dark` - Dark theme
|
|
58
|
+
* `contrast` - High contrast theme
|
|
59
|
+
* `custom` - Custom theme with your own variables
|
|
60
|
+
* `system` - Automatically follows OS preference
|
|
22
61
|
|
|
23
62
|
You can provide custom variables for any of these themes via the `themes` property in `SuThemeConfig`.
|
|
24
63
|
|
|
64
|
+
## Installation
|
|
65
|
+
|
|
66
|
+
You can install this library via npm:
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
npm install @su-labs/theme
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Peer Dependencies
|
|
73
|
+
|
|
74
|
+
This library requires the following peer dependencies:
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
npm install @angular/common@^22 @angular/core@^22
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Quick Start
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
// 1. Install
|
|
84
|
+
npm install @su-labs/theme
|
|
85
|
+
|
|
86
|
+
// 2. Initialize in app.config.ts
|
|
87
|
+
import { provideAppInitializer, inject } from '@angular/core';
|
|
88
|
+
import { SuThemeService } from '@su-labs/theme';
|
|
89
|
+
|
|
90
|
+
export const appConfig = {
|
|
91
|
+
providers: [
|
|
92
|
+
provideAppInitializer(() => {
|
|
93
|
+
inject(SuThemeService).init();
|
|
94
|
+
}),
|
|
95
|
+
],
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
// 3. Use in component
|
|
99
|
+
import { Component, inject } from '@angular/core';
|
|
100
|
+
import { SuThemeService } from '@su-labs/theme';
|
|
101
|
+
|
|
102
|
+
@Component({
|
|
103
|
+
template: `
|
|
104
|
+
<button (click)="themeService.setTheme('dark')">Dark Mode</button>
|
|
105
|
+
<p>Current: {{ themeService.theme() }}</p>
|
|
106
|
+
`
|
|
107
|
+
})
|
|
108
|
+
export class AppComponent {
|
|
109
|
+
themeService = inject(SuThemeService);
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
25
113
|
## Usage
|
|
26
114
|
|
|
27
115
|
The `SuThemeService` must be initialized at application startup to load its configuration and initial theme.
|
|
@@ -56,13 +144,13 @@ export const appConfig = {
|
|
|
56
144
|
};
|
|
57
145
|
```
|
|
58
146
|
|
|
59
|
-
|
|
147
|
+
This ensures the theme is loaded and applied before the application renders. The `SuThemeService` handles all the logic internally, including loading from `localStorage` and applying the initial theme.
|
|
148
|
+
|
|
149
|
+
### Example 2: Using the Theme in Your Styles
|
|
60
150
|
|
|
61
|
-
### Example 2: Using the Theme in a Component
|
|
62
151
|
Your service automatically applies CSS variables to the `:root` element. Your application stylesheets can use these variables, and the service will handle updating their values when the theme changes.
|
|
63
152
|
|
|
64
153
|
```CSS
|
|
65
|
-
|
|
66
154
|
/* styles.css */
|
|
67
155
|
/* Use the CSS variables in your stylesheet */
|
|
68
156
|
body {
|
|
@@ -77,11 +165,11 @@ h1 {
|
|
|
77
165
|
|
|
78
166
|
The service dynamically updates these variables based on the active theme, applying a combination of its internal defaults and any custom overrides you provide in the configuration.
|
|
79
167
|
|
|
80
|
-
###
|
|
168
|
+
### Example 3: Dynamic Theme Switching
|
|
169
|
+
|
|
81
170
|
Use the setTheme() method to switch themes and the theme signal to read the current state.
|
|
82
171
|
|
|
83
172
|
```TypeScript
|
|
84
|
-
|
|
85
173
|
import { Component, inject } from '@angular/core';
|
|
86
174
|
import { SuThemeService, SuThemeName } from '@su-labs/theme';
|
|
87
175
|
|
|
@@ -98,7 +186,6 @@ import { SuThemeService, SuThemeName } from '@su-labs/theme';
|
|
|
98
186
|
`,
|
|
99
187
|
})
|
|
100
188
|
export class ThemeSwitcherComponent {
|
|
101
|
-
// Use the service directly in the template
|
|
102
189
|
public readonly themeService = inject(SuThemeService);
|
|
103
190
|
|
|
104
191
|
setTheme(themeName: SuThemeName) {
|
|
@@ -106,8 +193,39 @@ export class ThemeSwitcherComponent {
|
|
|
106
193
|
}
|
|
107
194
|
}
|
|
108
195
|
```
|
|
109
|
-
|
|
110
|
-
|
|
196
|
+
|
|
197
|
+
This correctly shows how to use your service's public API to switch between themes. The service handles the underlying logic, including persistence and CSS variable application.
|
|
198
|
+
|
|
199
|
+
## API Reference
|
|
200
|
+
|
|
201
|
+
### Signals
|
|
202
|
+
|
|
203
|
+
| Signal | Type | Description |
|
|
204
|
+
|--------|------|-------------|
|
|
205
|
+
| `theme()` | `SuThemeName` | Current active theme name |
|
|
206
|
+
|
|
207
|
+
### Methods
|
|
208
|
+
|
|
209
|
+
| Method | Parameters | Description |
|
|
210
|
+
|--------|------------|-------------|
|
|
211
|
+
| `init(config?)` | `SuThemeConfig` | Initialize with custom configuration |
|
|
212
|
+
| `setTheme(theme, persist?)` | `SuThemeName, boolean` | Change theme (persist defaults to true) |
|
|
213
|
+
| `getTheme()` | - | Returns current theme name |
|
|
214
|
+
|
|
215
|
+
### Types
|
|
216
|
+
|
|
217
|
+
```typescript
|
|
218
|
+
type SuThemeName = 'light' | 'dark' | 'contrast' | 'custom' | 'system';
|
|
219
|
+
|
|
220
|
+
interface SuThemeConfig {
|
|
221
|
+
storageKey?: string; // Default: 'su:theme'
|
|
222
|
+
cssVarPrefix?: string; // Default: '--su-theme-'
|
|
223
|
+
defaultTheme?: SuThemeName; // Default: 'system'
|
|
224
|
+
themes?: {
|
|
225
|
+
[key in SuThemeName]?: Record<string, string>;
|
|
226
|
+
};
|
|
227
|
+
}
|
|
228
|
+
```
|
|
111
229
|
|
|
112
230
|
## Configuration Options
|
|
113
231
|
|
|
@@ -120,12 +238,60 @@ The service can be configured to fit your application's needs.
|
|
|
120
238
|
| `defaultTheme` | The theme to use if no preference is saved in `localStorage`. | `'system'` |
|
|
121
239
|
| `themes` | An object with custom CSS variable overrides for each theme. | `undefined` |
|
|
122
240
|
|
|
123
|
-
##
|
|
124
|
-
|
|
241
|
+
## Browser Compatibility
|
|
242
|
+
|
|
243
|
+
Works in all modern browsers that support:
|
|
244
|
+
- CSS Custom Properties
|
|
245
|
+
- localStorage API
|
|
246
|
+
- matchMedia (for system theme)
|
|
247
|
+
- Angular 22+
|
|
248
|
+
- ES2022+
|
|
249
|
+
|
|
250
|
+
| Browser | Version |
|
|
251
|
+
|---------|---------|
|
|
252
|
+
| Chrome | ≥ 90 |
|
|
253
|
+
| Firefox | ≥ 88 |
|
|
254
|
+
| Safari | ≥ 14 |
|
|
255
|
+
| Edge | ≥ 90 |
|
|
125
256
|
|
|
126
|
-
|
|
257
|
+
## Related Libraries
|
|
127
258
|
|
|
128
|
-
|
|
259
|
+
Part of the **@su-labs** suite:
|
|
260
|
+
|
|
261
|
+
- [@su-labs/visit-tracker](https://www.npmjs.com/package/@su-labs/visit-tracker) - User visit tracking
|
|
262
|
+
- [@su-labs/notifications](https://www.npmjs.com/package/@su-labs/notifications) - Toast notification system
|
|
263
|
+
- [@su-labs/scroll-spy](https://www.npmjs.com/package/@su-labs/scroll-spy) - Scroll position tracking
|
|
264
|
+
- [@su-labs/font-size](https://www.npmjs.com/package/@su-labs/font-size) - Accessible font size controls
|
|
265
|
+
|
|
266
|
+
## Troubleshooting
|
|
267
|
+
|
|
268
|
+
### Theme not persisting?
|
|
269
|
+
|
|
270
|
+
Make sure localStorage is enabled in your browser and not blocked by privacy settings.
|
|
271
|
+
|
|
272
|
+
### CSS variables not updating?
|
|
273
|
+
|
|
274
|
+
Ensure you're using the correct prefix in your CSS (`--su-theme-` by default) and that you've initialized the service.
|
|
275
|
+
|
|
276
|
+
### System theme not working?
|
|
277
|
+
|
|
278
|
+
Check that your OS has a theme preference set and your browser supports `prefers-color-scheme` media query.
|
|
279
|
+
|
|
280
|
+
### TypeScript errors?
|
|
281
|
+
|
|
282
|
+
Ensure you have Angular 22+ and TypeScript 6.0+ installed.
|
|
283
|
+
|
|
284
|
+
## Support
|
|
285
|
+
|
|
286
|
+
- Found a bug? [Open an issue](https://github.com/Greezaaa/settings-utils-lib/issues)
|
|
287
|
+
- Have a feature request? [Start a discussion](https://github.com/Greezaaa/settings-utils-lib/discussions)
|
|
288
|
+
- Like this library? [Give it a star!](https://github.com/Greezaaa/settings-utils-lib)
|
|
289
|
+
|
|
290
|
+
## Notes
|
|
291
|
+
|
|
292
|
+
- The service safely handles properties and ignores null or undefined values, preventing issues like prototype pollution.
|
|
293
|
+
- Works seamlessly with standalone components and reactive setups thanks to its signal-based API.
|
|
294
|
+
- Persistence is handled automatically: The service saves the user's preference to `localStorage` when you call `setTheme(..., true)`. On initialization, it automatically restores this saved preference. You do not need to add this logic in your components.
|
|
129
295
|
|
|
130
296
|
## Contributing
|
|
131
297
|
|
|
@@ -135,5 +301,4 @@ To contribute code, please ensure your changes include unit tests to maintain co
|
|
|
135
301
|
|
|
136
302
|
## License
|
|
137
303
|
|
|
138
|
-
This project is licensed under the MIT License. See the [**LICENSE**](https://github.com/Greezaaa/settings-utils-lib/blob/main/projects/su-labs/theme/LICENSE) file for details.
|
|
139
|
-
|
|
304
|
+
This project is licensed under the MIT License. See the [**LICENSE**](https://github.com/Greezaaa/settings-utils-lib/blob/main/projects/su-labs/theme/LICENSE) file for details.
|
|
@@ -1,189 +1,122 @@
|
|
|
1
|
-
import * as i0 from
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
this.mediaQuery = undefined;
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
/**
|
|
124
|
-
* Apply CSS variables for the given theme.
|
|
125
|
-
* This method applies default variables if they are not overridden in the config.
|
|
126
|
-
* @param theme The theme whose variables should be applied.
|
|
127
|
-
*/
|
|
128
|
-
applyThemeVariables(theme) {
|
|
129
|
-
// Map of default variables for light and dark themes
|
|
130
|
-
const defaultThemes = {
|
|
131
|
-
light: {
|
|
132
|
-
color: '#333',
|
|
133
|
-
background: '#fff',
|
|
134
|
-
'main-accent': '#007bff',
|
|
135
|
-
'second-accent': '#6c757d',
|
|
136
|
-
'third-accent': '#28a745',
|
|
137
|
-
},
|
|
138
|
-
dark: {
|
|
139
|
-
color: '#f0f0f0',
|
|
140
|
-
background: '#1a1a1a',
|
|
141
|
-
'main-accent': '#38a8e1',
|
|
142
|
-
'second-accent': '#a8b0b5',
|
|
143
|
-
'third-accent': '#2ee057',
|
|
144
|
-
},
|
|
145
|
-
// You can add more default themes here
|
|
146
|
-
contrast: {
|
|
147
|
-
color: '#000',
|
|
148
|
-
background: '#fff',
|
|
149
|
-
'main-accent': '#ff0000',
|
|
150
|
-
},
|
|
151
|
-
custom: {},
|
|
152
|
-
system: {},
|
|
153
|
-
};
|
|
154
|
-
// Use a combination of default and user-defined variables
|
|
155
|
-
const variablesToApply = {
|
|
156
|
-
...defaultThemes[theme],
|
|
157
|
-
...(this.suThemeConfig.themes?.[theme] ?? {}),
|
|
158
|
-
};
|
|
159
|
-
// Apply the variables to the root element
|
|
160
|
-
for (const [key, value] of Object.entries(variablesToApply)) {
|
|
161
|
-
if (value) {
|
|
162
|
-
document.documentElement.style.setProperty(`${this.cssVarPrefix}${key}`, value);
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
/** Angular lifecycle hook for service destruction */
|
|
167
|
-
ngOnDestroy() {
|
|
168
|
-
this.stopListeningToSystemChanges();
|
|
169
|
-
}
|
|
170
|
-
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.1.2", ngImport: i0, type: SuThemeService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
|
|
171
|
-
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.1.2", ngImport: i0, type: SuThemeService, providedIn: 'root' });
|
|
172
|
-
}
|
|
173
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.2", ngImport: i0, type: SuThemeService, decorators: [{
|
|
174
|
-
type: Injectable,
|
|
175
|
-
args: [{
|
|
176
|
-
providedIn: 'root',
|
|
177
|
-
}]
|
|
178
|
-
}] });
|
|
179
|
-
|
|
180
|
-
/*
|
|
181
|
-
* Public API Surface of theme
|
|
182
|
-
*/
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Generated bundle index. Do not edit.
|
|
186
|
-
*/
|
|
187
|
-
|
|
1
|
+
import * as i0 from "@angular/core";
|
|
2
|
+
import { Injectable, signal } from "@angular/core";
|
|
3
|
+
var SuThemeService = class SuThemeService {
|
|
4
|
+
suThemeConfig = {};
|
|
5
|
+
cssVarPrefix = "--su-theme-";
|
|
6
|
+
storageKey = "su:theme";
|
|
7
|
+
userPreference = "light";
|
|
8
|
+
currentThemeSignal = signal("light", ...ngDevMode ? [{ debugName: "currentThemeSignal" }] : /* istanbul ignore next */ []);
|
|
9
|
+
theme = this.currentThemeSignal.asReadonly();
|
|
10
|
+
systemChangeHandler = null;
|
|
11
|
+
mediaQuery;
|
|
12
|
+
init(config) {
|
|
13
|
+
this.suThemeConfig = {
|
|
14
|
+
...this.suThemeConfig,
|
|
15
|
+
...config
|
|
16
|
+
};
|
|
17
|
+
this.cssVarPrefix = this.suThemeConfig.cssVarPrefix ?? this.cssVarPrefix;
|
|
18
|
+
this.storageKey = this.suThemeConfig.storageKey ?? this.storageKey;
|
|
19
|
+
this.userPreference = localStorage.getItem(this.storageKey) ?? this.suThemeConfig.defaultTheme ?? "system";
|
|
20
|
+
this.setTheme(this.userPreference, false);
|
|
21
|
+
}
|
|
22
|
+
getTheme() {
|
|
23
|
+
return this.currentThemeSignal();
|
|
24
|
+
}
|
|
25
|
+
getUserPreference() {
|
|
26
|
+
return this.userPreference;
|
|
27
|
+
}
|
|
28
|
+
setTheme(theme, persist = true) {
|
|
29
|
+
if (theme !== "system") this.stopListeningToSystemChanges();
|
|
30
|
+
const resolvedTheme = theme === "system" ? this.resolveSystemTheme() : theme;
|
|
31
|
+
this.userPreference = theme;
|
|
32
|
+
this.currentThemeSignal.set(resolvedTheme);
|
|
33
|
+
document.documentElement.setAttribute("data-theme", resolvedTheme);
|
|
34
|
+
this.applyThemeVariables(resolvedTheme);
|
|
35
|
+
if (persist) localStorage.setItem(this.storageKey, theme);
|
|
36
|
+
if (theme === "system") this.listenToSystemChanges();
|
|
37
|
+
}
|
|
38
|
+
resolveSystemTheme() {
|
|
39
|
+
if (typeof window !== "undefined" && window.matchMedia("(prefers-color-scheme: dark)").matches) return "dark";
|
|
40
|
+
return "light";
|
|
41
|
+
}
|
|
42
|
+
listenToSystemChanges() {
|
|
43
|
+
if (!this.mediaQuery) {
|
|
44
|
+
this.mediaQuery = window.matchMedia("(prefers-color-scheme: dark)");
|
|
45
|
+
this.systemChangeHandler = (event) => {
|
|
46
|
+
if (this.userPreference === "system") {
|
|
47
|
+
this.currentThemeSignal.set(event.matches ? "dark" : "light");
|
|
48
|
+
document.documentElement.setAttribute("data-theme", this.currentThemeSignal());
|
|
49
|
+
this.applyThemeVariables(this.currentThemeSignal());
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
this.mediaQuery.addEventListener("change", this.systemChangeHandler);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
stopListeningToSystemChanges() {
|
|
56
|
+
if (this.mediaQuery && this.systemChangeHandler) {
|
|
57
|
+
this.mediaQuery.removeEventListener("change", this.systemChangeHandler);
|
|
58
|
+
this.systemChangeHandler = null;
|
|
59
|
+
this.mediaQuery = void 0;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
applyThemeVariables(theme) {
|
|
63
|
+
const variablesToApply = {
|
|
64
|
+
...{
|
|
65
|
+
light: {
|
|
66
|
+
color: "#333",
|
|
67
|
+
background: "#fff",
|
|
68
|
+
"main-accent": "#007bff",
|
|
69
|
+
"second-accent": "#6c757d",
|
|
70
|
+
"third-accent": "#28a745"
|
|
71
|
+
},
|
|
72
|
+
dark: {
|
|
73
|
+
color: "#f0f0f0",
|
|
74
|
+
background: "#1a1a1a",
|
|
75
|
+
"main-accent": "#38a8e1",
|
|
76
|
+
"second-accent": "#a8b0b5",
|
|
77
|
+
"third-accent": "#2ee057"
|
|
78
|
+
},
|
|
79
|
+
contrast: {
|
|
80
|
+
color: "#000",
|
|
81
|
+
background: "#fff",
|
|
82
|
+
"main-accent": "#ff0000"
|
|
83
|
+
},
|
|
84
|
+
custom: {},
|
|
85
|
+
system: {}
|
|
86
|
+
}[theme],
|
|
87
|
+
...this.suThemeConfig.themes?.[theme] ?? {}
|
|
88
|
+
};
|
|
89
|
+
for (const [key, value] of Object.entries(variablesToApply)) if (value) document.documentElement.style.setProperty(`${this.cssVarPrefix}${key}`, value);
|
|
90
|
+
}
|
|
91
|
+
ngOnDestroy() {
|
|
92
|
+
this.stopListeningToSystemChanges();
|
|
93
|
+
}
|
|
94
|
+
static ɵfac = i0.ɵɵngDeclareFactory({
|
|
95
|
+
minVersion: "12.0.0",
|
|
96
|
+
version: "22.2.4",
|
|
97
|
+
ngImport: i0,
|
|
98
|
+
type: SuThemeService,
|
|
99
|
+
deps: [],
|
|
100
|
+
target: i0.ɵɵFactoryTarget.Injectable
|
|
101
|
+
});
|
|
102
|
+
static ɵprov = i0.ɵɵngDeclareInjectable({
|
|
103
|
+
minVersion: "12.0.0",
|
|
104
|
+
version: "22.2.4",
|
|
105
|
+
ngImport: i0,
|
|
106
|
+
type: SuThemeService,
|
|
107
|
+
providedIn: "root"
|
|
108
|
+
});
|
|
109
|
+
};
|
|
110
|
+
i0.ɵɵngDeclareClassMetadata({
|
|
111
|
+
minVersion: "12.0.0",
|
|
112
|
+
version: "22.2.4",
|
|
113
|
+
ngImport: i0,
|
|
114
|
+
type: SuThemeService,
|
|
115
|
+
decorators: [{
|
|
116
|
+
type: Injectable,
|
|
117
|
+
args: [{ providedIn: "root" }]
|
|
118
|
+
}]
|
|
119
|
+
});
|
|
188
120
|
export { SuThemeService };
|
|
189
|
-
|
|
121
|
+
|
|
122
|
+
//# sourceMappingURL=su-labs-theme.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"su-labs-theme.mjs","sources":["../../../../projects/su-labs/theme/src/lib/theme.service.ts","../../../../projects/su-labs/theme/src/public-api.ts","../../../../projects/su-labs/theme/src/su-labs-theme.ts"],"sourcesContent":["import { Injectable, signal, WritableSignal, OnDestroy, computed } from '@angular/core';\nimport { SuThemeConfig, SuThemeName, ThemeCssVariables } from './theme.types';\n\n/**\n * Service for managing application themes.\n *\n * Provides reactive theme state via signals and methods to set/get the theme.\n * Supports user preference, system-based themes, and custom CSS variable overrides.\n */\n@Injectable({\n providedIn: 'root',\n})\nexport class SuThemeService implements OnDestroy {\n /** Configuration for the theme, provided during initialization */\n private suThemeConfig: SuThemeConfig = {};\n\n /** CSS variable prefix, can be customized */\n private cssVarPrefix = '--su-theme-';\n\n /** localStorage key for storing user preference, can be customized */\n private storageKey = 'su:theme';\n\n /** User selected theme (can be 'system') */\n private userPreference: SuThemeName = 'light';\n\n /** Current resolved theme signal ('light' | 'dark' | 'contrast' | 'custom') */\n private currentThemeSignal: WritableSignal<SuThemeName> = signal('light');\n\n /** Read-only access to the resolved theme signal */\n readonly theme = this.currentThemeSignal.asReadonly();\n\n /** System media query listener callback */\n private systemChangeHandler: ((event: MediaQueryListEvent) => void) | null = null;\n\n /** MediaQueryList instance for system theme changes */\n private mediaQuery?: MediaQueryList;\n\n /**\n * Initialize the service with optional configuration.\n * Should be called from APP_INITIALIZER for default setup.\n * @param config Optional configuration object.\n */\n public init(config?: SuThemeConfig): void {\n // Apply configuration and defaults\n this.suThemeConfig = { ...this.suThemeConfig, ...config };\n this.cssVarPrefix = this.suThemeConfig.cssVarPrefix ?? this.cssVarPrefix;\n this.storageKey = this.suThemeConfig.storageKey ?? this.storageKey;\n\n // Set user preference from localStorage or default\n this.userPreference = (localStorage.getItem(this.storageKey) as SuThemeName | null) ?? this.suThemeConfig.defaultTheme ?? 'system';\n\n // Set the initial theme based on the resolved preference\n this.setTheme(this.userPreference, false);\n }\n\n /**\n * Get the currently active, resolved theme.\n * @returns The resolved theme name ('light', 'dark', 'contrast', 'custom').\n */\n public getTheme(): SuThemeName {\n return this.currentThemeSignal();\n }\n\n /**\n * Get the user's theme preference (may be 'system').\n * @returns The user preference ('light', 'dark', 'contrast', 'custom', 'system').\n */\n public getUserPreference(): SuThemeName {\n return this.userPreference;\n }\n\n /**\n * Set a new theme.\n * @param theme The theme to set ('light', 'dark', 'contrast', 'custom', 'system').\n * @param persist Whether to store the preference in localStorage (default: true).\n */\n public setTheme(theme: SuThemeName, persist: boolean = true): void {\n // Stop listening to system changes if we are setting a non-system theme\n if (theme !== 'system') {\n this.stopListeningToSystemChanges();\n }\n\n // Resolve the final theme name\n const resolvedTheme: SuThemeName = theme === 'system' ? this.resolveSystemTheme() : theme;\n\n // Update internal state and signals\n this.userPreference = theme;\n this.currentThemeSignal.set(resolvedTheme);\n\n // Apply the theme to the document and manage system listeners\n document.documentElement.setAttribute('data-theme', resolvedTheme);\n this.applyThemeVariables(resolvedTheme);\n\n // Persist preference to localStorage\n if (persist) {\n localStorage.setItem(this.storageKey, theme);\n }\n\n // Start listening for system changes if the new preference is 'system'\n if (theme === 'system') {\n this.listenToSystemChanges();\n }\n }\n\n /**\n * Resolve the current system theme using prefers-color-scheme.\n * @returns 'dark' if system prefers dark mode, otherwise 'light'.\n */\n private resolveSystemTheme(): SuThemeName {\n if (typeof window !== 'undefined' && window.matchMedia('(prefers-color-scheme: dark)').matches) {\n return 'dark';\n }\n return 'light';\n }\n\n /**\n * Listen to system theme changes and automatically update the theme.\n * Only active when user preference is 'system'.\n */\n private listenToSystemChanges(): void {\n // Only set up the listener if it's not already active\n if (!this.mediaQuery) {\n this.mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');\n this.systemChangeHandler = (event: MediaQueryListEvent): void => {\n // Only react if the user preference is still 'system'\n if (this.userPreference === 'system') {\n this.currentThemeSignal.set(event.matches ? 'dark' : 'light');\n document.documentElement.setAttribute('data-theme', this.currentThemeSignal());\n this.applyThemeVariables(this.currentThemeSignal());\n }\n };\n this.mediaQuery.addEventListener('change', this.systemChangeHandler);\n }\n }\n\n /**\n * Stop listening to system theme changes.\n * Should be called when the service is destroyed or theme is no longer 'system'.\n */\n private stopListeningToSystemChanges(): void {\n if (this.mediaQuery && this.systemChangeHandler) {\n this.mediaQuery.removeEventListener('change', this.systemChangeHandler);\n this.systemChangeHandler = null;\n this.mediaQuery = undefined;\n }\n }\n\n /**\n * Apply CSS variables for the given theme.\n * This method applies default variables if they are not overridden in the config.\n * @param theme The theme whose variables should be applied.\n */\n private applyThemeVariables(theme: SuThemeName): void {\n // Map of default variables for light and dark themes\n const defaultThemes: Record<SuThemeName, ThemeCssVariables> = {\n light: {\n color: '#333',\n background: '#fff',\n 'main-accent': '#007bff',\n 'second-accent': '#6c757d',\n 'third-accent': '#28a745',\n },\n dark: {\n color: '#f0f0f0',\n background: '#1a1a1a',\n 'main-accent': '#38a8e1',\n 'second-accent': '#a8b0b5',\n 'third-accent': '#2ee057',\n },\n // You can add more default themes here\n contrast: {\n color: '#000',\n background: '#fff',\n 'main-accent': '#ff0000',\n },\n custom: {},\n system: {},\n };\n\n // Use a combination of default and user-defined variables\n const variablesToApply = {\n ...defaultThemes[theme],\n ...(this.suThemeConfig.themes?.[theme] ?? {}),\n };\n\n // Apply the variables to the root element\n for (const [key, value] of Object.entries(variablesToApply)) {\n if (value) {\n document.documentElement.style.setProperty(\n `${this.cssVarPrefix}${key}`,\n value,\n );\n }\n }\n }\n\n /** Angular lifecycle hook for service destruction */\n ngOnDestroy(): void {\n this.stopListeningToSystemChanges();\n }\n}","/*\n * Public API Surface of theme\n */\n\nexport * from './lib/theme.service';\nexport * from './lib/theme.types';\n\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;AAGA;;;;;AAKG;MAIU,cAAc,CAAA;;IAEjB,aAAa,GAAkB,EAAE;;IAGjC,YAAY,GAAG,aAAa;;IAG5B,UAAU,GAAG,UAAU;;IAGvB,cAAc,GAAgB,OAAO;;AAGrC,IAAA,kBAAkB,GAAgC,MAAM,CAAC,OAAO,8DAAC;;AAGhE,IAAA,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE;;IAG7C,mBAAmB,GAAkD,IAAI;;AAGzE,IAAA,UAAU;AAElB;;;;AAIG;AACI,IAAA,IAAI,CAAC,MAAsB,EAAA;;AAEhC,QAAA,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;AACzD,QAAA,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;AACxE,QAAA,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;;AAGlE,QAAA,IAAI,CAAC,cAAc,GAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAwB,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,IAAI,QAAQ;;QAGlI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC;IAC3C;AAEA;;;AAGG;IACI,QAAQ,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,kBAAkB,EAAE;IAClC;AAEA;;;AAGG;IACI,iBAAiB,GAAA;QACtB,OAAO,IAAI,CAAC,cAAc;IAC5B;AAEA;;;;AAIG;AACI,IAAA,QAAQ,CAAC,KAAkB,EAAE,OAAA,GAAmB,IAAI,EAAA;;AAEzD,QAAA,IAAI,KAAK,KAAK,QAAQ,EAAE;YACtB,IAAI,CAAC,4BAA4B,EAAE;QACrC;;AAGA,QAAA,MAAM,aAAa,GAAgB,KAAK,KAAK,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,GAAG,KAAK;;AAGzF,QAAA,IAAI,CAAC,cAAc,GAAG,KAAK;AAC3B,QAAA,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC;;QAG1C,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC;AAClE,QAAA,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC;;QAGvC,IAAI,OAAO,EAAE;YACX,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC;QAC9C;;AAGA,QAAA,IAAI,KAAK,KAAK,QAAQ,EAAE;YACtB,IAAI,CAAC,qBAAqB,EAAE;QAC9B;IACF;AAEA;;;AAGG;IACK,kBAAkB,GAAA;AACxB,QAAA,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC,OAAO,EAAE;AAC9F,YAAA,OAAO,MAAM;QACf;AACA,QAAA,OAAO,OAAO;IAChB;AAEA;;;AAGG;IACK,qBAAqB,GAAA;;AAE3B,QAAA,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC;AACnE,YAAA,IAAI,CAAC,mBAAmB,GAAG,CAAC,KAA0B,KAAU;;AAE9D,gBAAA,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;AACpC,oBAAA,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;AAC7D,oBAAA,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC9E,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACrD;AACF,YAAA,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC;QACtE;IACF;AAEA;;;AAGG;IACK,4BAA4B,GAAA;QAClC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC/C,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC;AACvE,YAAA,IAAI,CAAC,mBAAmB,GAAG,IAAI;AAC/B,YAAA,IAAI,CAAC,UAAU,GAAG,SAAS;QAC7B;IACF;AAEA;;;;AAIG;AACK,IAAA,mBAAmB,CAAC,KAAkB,EAAA;;AAE5C,QAAA,MAAM,aAAa,GAA2C;AAC5D,YAAA,KAAK,EAAE;AACL,gBAAA,KAAK,EAAE,MAAM;AACb,gBAAA,UAAU,EAAE,MAAM;AAClB,gBAAA,aAAa,EAAE,SAAS;AACxB,gBAAA,eAAe,EAAE,SAAS;AAC1B,gBAAA,cAAc,EAAE,SAAS;AAC1B,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,aAAa,EAAE,SAAS;AACxB,gBAAA,eAAe,EAAE,SAAS;AAC1B,gBAAA,cAAc,EAAE,SAAS;AAC1B,aAAA;;AAED,YAAA,QAAQ,EAAE;AACR,gBAAA,KAAK,EAAE,MAAM;AACb,gBAAA,UAAU,EAAE,MAAM;AAClB,gBAAA,aAAa,EAAE,SAAS;AACzB,aAAA;AACD,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,EAAE;SACX;;AAGD,QAAA,MAAM,gBAAgB,GAAG;YACvB,GAAG,aAAa,CAAC,KAAK,CAAC;AACvB,YAAA,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;SAC9C;;AAGD,QAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;YAC3D,IAAI,KAAK,EAAE;AACT,gBAAA,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,CACxC,CAAA,EAAG,IAAI,CAAC,YAAY,CAAA,EAAG,GAAG,EAAE,EAC5B,KAAK,CACN;YACH;QACF;IACF;;IAGA,WAAW,GAAA;QACT,IAAI,CAAC,4BAA4B,EAAE;IACrC;uGA3LW,cAAc,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAd,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,cAAc,cAFb,MAAM,EAAA,CAAA;;2FAEP,cAAc,EAAA,UAAA,EAAA,CAAA;kBAH1B,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACXD;;AAEG;;ACFH;;AAEG;;;;"}
|
|
1
|
+
{"version":3,"file":"su-labs-theme.mjs","names":[],"sources":["../../../../projects/su-labs/theme/src/lib/theme.service.ts"],"sourcesContent":["import { Injectable, signal, WritableSignal, OnDestroy, computed } from '@angular/core';\nimport { SuThemeConfig, SuThemeName, ThemeCssVariables } from './theme.types';\n\n/**\n * Service for managing application themes.\n *\n * Provides reactive theme state via signals and methods to set/get the theme.\n * Supports user preference, system-based themes, and custom CSS variable overrides.\n */\n@Injectable({\n providedIn: 'root',\n})\nexport class SuThemeService implements OnDestroy {\n /** Configuration for the theme, provided during initialization */\n private suThemeConfig: SuThemeConfig = {};\n\n /** CSS variable prefix, can be customized */\n private cssVarPrefix = '--su-theme-';\n\n /** localStorage key for storing user preference, can be customized */\n private storageKey = 'su:theme';\n\n /** User selected theme (can be 'system') */\n private userPreference: SuThemeName = 'light';\n\n /** Current resolved theme signal ('light' | 'dark' | 'contrast' | 'custom') */\n private currentThemeSignal: WritableSignal<SuThemeName> = signal('light');\n\n /** Read-only access to the resolved theme signal */\n readonly theme = this.currentThemeSignal.asReadonly();\n\n /** System media query listener callback */\n private systemChangeHandler: ((event: MediaQueryListEvent) => void) | null = null;\n\n /** MediaQueryList instance for system theme changes */\n private mediaQuery?: MediaQueryList;\n\n /**\n * Initialize the service with optional configuration.\n * Should be called from APP_INITIALIZER for default setup.\n * @param config Optional configuration object.\n */\n public init(config?: SuThemeConfig): void {\n // Apply configuration and defaults\n this.suThemeConfig = { ...this.suThemeConfig, ...config };\n this.cssVarPrefix = this.suThemeConfig.cssVarPrefix ?? this.cssVarPrefix;\n this.storageKey = this.suThemeConfig.storageKey ?? this.storageKey;\n\n // Set user preference from localStorage or default\n this.userPreference = (localStorage.getItem(this.storageKey) as SuThemeName | null) ?? this.suThemeConfig.defaultTheme ?? 'system';\n\n // Set the initial theme based on the resolved preference\n this.setTheme(this.userPreference, false);\n }\n\n /**\n * Get the currently active, resolved theme.\n * @returns The resolved theme name ('light', 'dark', 'contrast', 'custom').\n */\n public getTheme(): SuThemeName {\n return this.currentThemeSignal();\n }\n\n /**\n * Get the user's theme preference (may be 'system').\n * @returns The user preference ('light', 'dark', 'contrast', 'custom', 'system').\n */\n public getUserPreference(): SuThemeName {\n return this.userPreference;\n }\n\n /**\n * Set a new theme.\n * @param theme The theme to set ('light', 'dark', 'contrast', 'custom', 'system').\n * @param persist Whether to store the preference in localStorage (default: true).\n */\n public setTheme(theme: SuThemeName, persist: boolean = true): void {\n // Stop listening to system changes if we are setting a non-system theme\n if (theme !== 'system') {\n this.stopListeningToSystemChanges();\n }\n\n // Resolve the final theme name\n const resolvedTheme: SuThemeName = theme === 'system' ? this.resolveSystemTheme() : theme;\n\n // Update internal state and signals\n this.userPreference = theme;\n this.currentThemeSignal.set(resolvedTheme);\n\n // Apply the theme to the document and manage system listeners\n document.documentElement.setAttribute('data-theme', resolvedTheme);\n this.applyThemeVariables(resolvedTheme);\n\n // Persist preference to localStorage\n if (persist) {\n localStorage.setItem(this.storageKey, theme);\n }\n\n // Start listening for system changes if the new preference is 'system'\n if (theme === 'system') {\n this.listenToSystemChanges();\n }\n }\n\n /**\n * Resolve the current system theme using prefers-color-scheme.\n * @returns 'dark' if system prefers dark mode, otherwise 'light'.\n */\n private resolveSystemTheme(): SuThemeName {\n if (typeof window !== 'undefined' && window.matchMedia('(prefers-color-scheme: dark)').matches) {\n return 'dark';\n }\n return 'light';\n }\n\n /**\n * Listen to system theme changes and automatically update the theme.\n * Only active when user preference is 'system'.\n */\n private listenToSystemChanges(): void {\n // Only set up the listener if it's not already active\n if (!this.mediaQuery) {\n this.mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');\n this.systemChangeHandler = (event: MediaQueryListEvent): void => {\n // Only react if the user preference is still 'system'\n if (this.userPreference === 'system') {\n this.currentThemeSignal.set(event.matches ? 'dark' : 'light');\n document.documentElement.setAttribute('data-theme', this.currentThemeSignal());\n this.applyThemeVariables(this.currentThemeSignal());\n }\n };\n this.mediaQuery.addEventListener('change', this.systemChangeHandler);\n }\n }\n\n /**\n * Stop listening to system theme changes.\n * Should be called when the service is destroyed or theme is no longer 'system'.\n */\n private stopListeningToSystemChanges(): void {\n if (this.mediaQuery && this.systemChangeHandler) {\n this.mediaQuery.removeEventListener('change', this.systemChangeHandler);\n this.systemChangeHandler = null;\n this.mediaQuery = undefined;\n }\n }\n\n /**\n * Apply CSS variables for the given theme.\n * This method applies default variables if they are not overridden in the config.\n * @param theme The theme whose variables should be applied.\n */\n private applyThemeVariables(theme: SuThemeName): void {\n // Map of default variables for light and dark themes\n const defaultThemes: Record<SuThemeName, ThemeCssVariables> = {\n light: {\n color: '#333',\n background: '#fff',\n 'main-accent': '#007bff',\n 'second-accent': '#6c757d',\n 'third-accent': '#28a745',\n },\n dark: {\n color: '#f0f0f0',\n background: '#1a1a1a',\n 'main-accent': '#38a8e1',\n 'second-accent': '#a8b0b5',\n 'third-accent': '#2ee057',\n },\n // You can add more default themes here\n contrast: {\n color: '#000',\n background: '#fff',\n 'main-accent': '#ff0000',\n },\n custom: {},\n system: {},\n };\n\n // Use a combination of default and user-defined variables\n const variablesToApply = {\n ...defaultThemes[theme],\n ...(this.suThemeConfig.themes?.[theme] ?? {}),\n };\n\n // Apply the variables to the root element\n for (const [key, value] of Object.entries(variablesToApply)) {\n if (value) {\n document.documentElement.style.setProperty(\n `${this.cssVarPrefix}${key}`,\n value,\n );\n }\n }\n }\n\n /** Angular lifecycle hook for service destruction */\n ngOnDestroy(): void {\n this.stopListeningToSystemChanges();\n }\n}"],"mappings":";;AAYA,IAAa,iBAAb,MAAa,eAAc;CAEjB,gBAA+B,CAAA;CAG/B,eAAe;CAGf,aAAa;CAGb,iBAA8B;CAG9B,qBAAkD,OAAO,SAAQ,GAAA,YAAA,CAAA,EAAA,WAAA,qBAAA,CAAA,+BAAA,CAAA,CAAA;CAGhE,QAAQ,KAAK,mBAAmB,WAAU;CAG3C,sBAAqE;CAGrE;CAOD,KAAK,QAAsB;EAEhC,KAAK,gBAAgB;GAAE,GAAG,KAAK;GAAe,GAAG;EAAM;EACvD,KAAK,eAAe,KAAK,cAAc,gBAAgB,KAAK;EAC5D,KAAK,aAAa,KAAK,cAAc,cAAc,KAAK;EAGxD,KAAK,iBAAkB,aAAa,QAAQ,KAAK,UAAU,KAA4B,KAAK,cAAc,gBAAgB;EAG1H,KAAK,SAAS,KAAK,gBAAgB,KAAK;CAC1C;CAMO,WAAQ;EACb,OAAO,KAAK,mBAAkB;CAChC;CAMO,oBAAiB;EACtB,OAAO,KAAK;CACd;CAOO,SAAS,OAAoB,UAAmB,MAAI;EAEzD,IAAI,UAAU,UACZ,KAAK,6BAA4B;EAInC,MAAM,gBAA6B,UAAU,WAAW,KAAK,mBAAkB,IAAK;EAGpF,KAAK,iBAAiB;EACtB,KAAK,mBAAmB,IAAI,aAAa;EAGzC,SAAS,gBAAgB,aAAa,cAAc,aAAa;EACjE,KAAK,oBAAoB,aAAa;EAGtC,IAAI,SACF,aAAa,QAAQ,KAAK,YAAY,KAAK;EAI7C,IAAI,UAAU,UACZ,KAAK,sBAAqB;CAE9B;CAMQ,qBAAkB;EACxB,IAAI,OAAO,WAAW,eAAe,OAAO,WAAW,8BAA8B,CAAC,CAAC,SACrF,OAAO;EAET,OAAO;CACT;CAMQ,wBAAqB;EAE3B,IAAI,CAAC,KAAK,YAAY;GACpB,KAAK,aAAa,OAAO,WAAW,8BAA8B;GAClE,KAAK,uBAAuB,UAAoC;IAE9D,IAAI,KAAK,mBAAmB,UAAU;KACpC,KAAK,mBAAmB,IAAI,MAAM,UAAU,SAAS,OAAO;KAC5D,SAAS,gBAAgB,aAAa,cAAc,KAAK,mBAAkB,CAAE;KAC7E,KAAK,oBAAoB,KAAK,mBAAkB,CAAE;IACpD;GACF;GACA,KAAK,WAAW,iBAAiB,UAAU,KAAK,mBAAmB;EACrE;CACF;CAMQ,+BAA4B;EAClC,IAAI,KAAK,cAAc,KAAK,qBAAqB;GAC/C,KAAK,WAAW,oBAAoB,UAAU,KAAK,mBAAmB;GACtE,KAAK,sBAAsB;GAC3B,KAAK,aAAa;EACpB;CACF;CAOQ,oBAAoB,OAAkB;EA4B5C,MAAM,mBAAmB;GACvB,GAAG;IA1BH,OAAO;KACL,OAAO;KACP,YAAY;KACZ,eAAe;KACf,iBAAiB;KACjB,gBAAgB;IACjB;IACD,MAAM;KACJ,OAAO;KACP,YAAY;KACZ,eAAe;KACf,iBAAiB;KACjB,gBAAgB;IACjB;IAED,UAAU;KACR,OAAO;KACP,YAAY;KACZ,eAAe;IAChB;IACD,QAAQ,CAAA;IACR,QAAQ,CAAA;GAKL,EAAc;GACjB,GAAI,KAAK,cAAc,SAAS,UAAU,CAAA;EAC3C;EAGD,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,gBAAgB,GACxD,IAAI,OACF,SAAS,gBAAgB,MAAM,YAC7B,GAAG,KAAK,eAAe,OACvB,KAAK;CAIb;CAGA,cAAW;EACT,KAAK,6BAA4B;CACnC;CA3LW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAc,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAAd,OAAA,QAAA,GAAA,sBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAc,YAFb;CAAM,CAAA;;AAEP,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAc,YAAA,CAAA;EAH1B,MAAA;EAAW,MAAA,CAAA,EACV,YAAY,OACb,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@su-labs/theme",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "22.0.0",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"angular",
|
|
6
6
|
"theme",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"system-theme",
|
|
19
19
|
"prefers-color-scheme"
|
|
20
20
|
],
|
|
21
|
-
"homepage": "https://github.com/Greezaaa/settings-utils-lib/tree/main/projects/su-labs/
|
|
21
|
+
"homepage": "https://github.com/Greezaaa/settings-utils-lib/tree/main/projects/su-labs/theme#readme",
|
|
22
22
|
"author": {
|
|
23
23
|
"name": "Yevheniy Alekseyev",
|
|
24
24
|
"email": "yev.alekseyev@gmail.com",
|
|
@@ -27,14 +27,14 @@
|
|
|
27
27
|
"repository": {
|
|
28
28
|
"type": "git",
|
|
29
29
|
"url": "https://github.com/Greezaaa/settings-utils-lib.git",
|
|
30
|
-
"directory": "projects/su-labs/
|
|
30
|
+
"directory": "projects/su-labs/theme"
|
|
31
31
|
},
|
|
32
32
|
"bugs": {
|
|
33
33
|
"url": "https://github.com/Greezaaa/settings-utils-lib/issues"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@angular/common": "^
|
|
37
|
-
"@angular/core": "^
|
|
36
|
+
"@angular/common": "^22.0.0",
|
|
37
|
+
"@angular/core": "^22.0.0"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"tslib": "^2.3.0"
|
|
@@ -51,5 +51,6 @@
|
|
|
51
51
|
"types": "./types/su-labs-theme.d.ts",
|
|
52
52
|
"default": "./fesm2022/su-labs-theme.mjs"
|
|
53
53
|
}
|
|
54
|
-
}
|
|
54
|
+
},
|
|
55
|
+
"type": "module"
|
|
55
56
|
}
|
package/types/su-labs-theme.d.ts
CHANGED
|
@@ -1,100 +1,95 @@
|
|
|
1
|
-
import * as i0 from
|
|
2
|
-
import { OnDestroy } from
|
|
3
|
-
|
|
1
|
+
import * as i0 from "@angular/core";
|
|
2
|
+
import { OnDestroy } from "@angular/core";
|
|
4
3
|
/** Available theme names */
|
|
5
|
-
type SuThemeName = 'light' | 'dark' | 'contrast' | 'custom' | 'system';
|
|
4
|
+
export type SuThemeName = 'light' | 'dark' | 'contrast' | 'custom' | 'system';
|
|
6
5
|
/** Theme configuration */
|
|
7
|
-
interface SuThemeConfig {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
6
|
+
export interface SuThemeConfig {
|
|
7
|
+
/** localStorage key for storing selected theme */
|
|
8
|
+
storageKey?: string;
|
|
9
|
+
/** CSS variable prefix, applied to all theme variables */
|
|
10
|
+
cssVarPrefix?: string;
|
|
11
|
+
/** Default theme if nothing saved in localStorage */
|
|
12
|
+
defaultTheme?: SuThemeName;
|
|
13
|
+
/** Optional CSS variable overrides for specific themes */
|
|
14
|
+
themes?: Partial<Record<SuThemeName, ThemeCssVariables>>;
|
|
16
15
|
}
|
|
17
16
|
/** Available CSS variables for theming */
|
|
18
|
-
interface ThemeCssVariables {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
17
|
+
export interface ThemeCssVariables {
|
|
18
|
+
color?: string;
|
|
19
|
+
background?: string;
|
|
20
|
+
'main-accent'?: string;
|
|
21
|
+
'second-accent'?: string;
|
|
22
|
+
'third-accent'?: string;
|
|
23
|
+
[key: string]: string | undefined;
|
|
25
24
|
}
|
|
26
|
-
|
|
27
25
|
/**
|
|
28
26
|
* Service for managing application themes.
|
|
29
27
|
*
|
|
30
28
|
* Provides reactive theme state via signals and methods to set/get the theme.
|
|
31
29
|
* Supports user preference, system-based themes, and custom CSS variable overrides.
|
|
32
30
|
*/
|
|
33
|
-
declare class SuThemeService implements OnDestroy {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
export { SuThemeService };
|
|
100
|
-
export type { SuThemeConfig, SuThemeName, ThemeCssVariables };
|
|
31
|
+
export declare class SuThemeService implements OnDestroy {
|
|
32
|
+
/** Configuration for the theme, provided during initialization */
|
|
33
|
+
private suThemeConfig;
|
|
34
|
+
/** CSS variable prefix, can be customized */
|
|
35
|
+
private cssVarPrefix;
|
|
36
|
+
/** localStorage key for storing user preference, can be customized */
|
|
37
|
+
private storageKey;
|
|
38
|
+
/** User selected theme (can be 'system') */
|
|
39
|
+
private userPreference;
|
|
40
|
+
/** Current resolved theme signal ('light' | 'dark' | 'contrast' | 'custom') */
|
|
41
|
+
private currentThemeSignal;
|
|
42
|
+
/** Read-only access to the resolved theme signal */
|
|
43
|
+
readonly theme: import("@angular/core").Signal<SuThemeName>;
|
|
44
|
+
/** System media query listener callback */
|
|
45
|
+
private systemChangeHandler;
|
|
46
|
+
/** MediaQueryList instance for system theme changes */
|
|
47
|
+
private mediaQuery?;
|
|
48
|
+
/**
|
|
49
|
+
* Initialize the service with optional configuration.
|
|
50
|
+
* Should be called from APP_INITIALIZER for default setup.
|
|
51
|
+
* @param config Optional configuration object.
|
|
52
|
+
*/
|
|
53
|
+
init(config?: SuThemeConfig): void;
|
|
54
|
+
/**
|
|
55
|
+
* Get the currently active, resolved theme.
|
|
56
|
+
* @returns The resolved theme name ('light', 'dark', 'contrast', 'custom').
|
|
57
|
+
*/
|
|
58
|
+
getTheme(): SuThemeName;
|
|
59
|
+
/**
|
|
60
|
+
* Get the user's theme preference (may be 'system').
|
|
61
|
+
* @returns The user preference ('light', 'dark', 'contrast', 'custom', 'system').
|
|
62
|
+
*/
|
|
63
|
+
getUserPreference(): SuThemeName;
|
|
64
|
+
/**
|
|
65
|
+
* Set a new theme.
|
|
66
|
+
* @param theme The theme to set ('light', 'dark', 'contrast', 'custom', 'system').
|
|
67
|
+
* @param persist Whether to store the preference in localStorage (default: true).
|
|
68
|
+
*/
|
|
69
|
+
setTheme(theme: SuThemeName, persist?: boolean): void;
|
|
70
|
+
/**
|
|
71
|
+
* Resolve the current system theme using prefers-color-scheme.
|
|
72
|
+
* @returns 'dark' if system prefers dark mode, otherwise 'light'.
|
|
73
|
+
*/
|
|
74
|
+
private resolveSystemTheme;
|
|
75
|
+
/**
|
|
76
|
+
* Listen to system theme changes and automatically update the theme.
|
|
77
|
+
* Only active when user preference is 'system'.
|
|
78
|
+
*/
|
|
79
|
+
private listenToSystemChanges;
|
|
80
|
+
/**
|
|
81
|
+
* Stop listening to system theme changes.
|
|
82
|
+
* Should be called when the service is destroyed or theme is no longer 'system'.
|
|
83
|
+
*/
|
|
84
|
+
private stopListeningToSystemChanges;
|
|
85
|
+
/**
|
|
86
|
+
* Apply CSS variables for the given theme.
|
|
87
|
+
* This method applies default variables if they are not overridden in the config.
|
|
88
|
+
* @param theme The theme whose variables should be applied.
|
|
89
|
+
*/
|
|
90
|
+
private applyThemeVariables;
|
|
91
|
+
/** Angular lifecycle hook for service destruction */
|
|
92
|
+
ngOnDestroy(): void;
|
|
93
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SuThemeService, never>;
|
|
94
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<any>;
|
|
95
|
+
}
|