@doug-williamson/ng-rhombus
v2.0.0-beta.4
Published
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0.
Readme
NgRhombus
This library was generated with Angular CLI version 17.0.0.
What this package is becoming
NgRhombus is being reshaped into a Material-extension UI library:
- Components compose/extend Angular Material and assume a Material theme.
- The library should avoid application wiring (Firebase/AngularFire, environment configs, emulator connections, routing decisions).
- Apps should provide data via interfaces/tokens, and the UI library should focus on rendering + user events.
Theming (Angular Material)
This package ships a Sass entrypoint at @doug-williamson/ng-rhombus/theme.
In your global stylesheet (e.g. styles.scss):
@use '@doug-williamson/ng-rhombus/theme' as rh;
@include rh.theme();
// Override palettes per-app
// @use './theme-colors.scss' as app-theme;
// @include rh.theme($primary: app-theme.$primary-palette, $tertiary: app-theme.$tertiary-palette);
// Optional: high-contrast overrides
// @media (prefers-contrast: more) {
// html { @include rh.high-contrast-overrides(color-scheme); }
// }Code scaffolding
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.
Note: Don't forget to add
--project ngRhombusor else it will be added to the default project in yourangular.jsonfile.
Build
Run ng build ngRhombus to build the project. The build artifacts will be stored in the dist/ directory.
Publishing
After building your library with ng build ngRhombus, go to the dist folder cd dist/ng-rhombus and run npm publish.
Running unit tests
Run ng test ngRhombus to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
