@doug-williamson/ng-rhombus 1.0.8 → 2.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/fesm2022/doug-williamson-ng-rhombus.mjs +493 -221
- package/fesm2022/doug-williamson-ng-rhombus.mjs.map +1 -1
- package/package.json +1 -1
- package/theme/_index.scss +20 -0
- package/theme/theme-colors.scss +199 -0
- package/types/doug-williamson-ng-rhombus.d.ts +205 -39
package/README.md
CHANGED
|
@@ -2,6 +2,35 @@
|
|
|
2
2
|
|
|
3
3
|
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0.
|
|
4
4
|
|
|
5
|
+
## What this package is becoming
|
|
6
|
+
|
|
7
|
+
NgRhombus is being reshaped into a **Material-extension UI library**:
|
|
8
|
+
|
|
9
|
+
- Components compose/extend **Angular Material** and assume a Material theme.
|
|
10
|
+
- The library should avoid application wiring (Firebase/AngularFire, environment configs, emulator connections, routing decisions).
|
|
11
|
+
- Apps should provide data via interfaces/tokens, and the UI library should focus on rendering + user events.
|
|
12
|
+
|
|
13
|
+
## Theming (Angular Material)
|
|
14
|
+
|
|
15
|
+
This package ships a Sass entrypoint at `@doug-williamson/ng-rhombus/theme`.
|
|
16
|
+
|
|
17
|
+
In your global stylesheet (e.g. `styles.scss`):
|
|
18
|
+
|
|
19
|
+
```scss
|
|
20
|
+
@use '@doug-williamson/ng-rhombus/theme' as rh;
|
|
21
|
+
|
|
22
|
+
@include rh.theme();
|
|
23
|
+
|
|
24
|
+
// Override palettes per-app
|
|
25
|
+
// @use './theme-colors.scss' as app-theme;
|
|
26
|
+
// @include rh.theme($primary: app-theme.$primary-palette, $tertiary: app-theme.$tertiary-palette);
|
|
27
|
+
|
|
28
|
+
// Optional: high-contrast overrides
|
|
29
|
+
// @media (prefers-contrast: more) {
|
|
30
|
+
// html { @include rh.high-contrast-overrides(color-scheme); }
|
|
31
|
+
// }
|
|
32
|
+
```
|
|
33
|
+
|
|
5
34
|
## Code scaffolding
|
|
6
35
|
|
|
7
36
|
Run `ng generate component component-name --project ngRhombus` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngRhombus`.
|