@coolms/ui-angular
v2.0.0-alpha.2
Published
The CoolMS UI kit for Angular: the data grid, server-declared forms, page scaffolding, dialogs, pickers and the chrome an admin surface is built from.
Readme
@coolms/ui-angular
The CoolMS UI kit for Angular: the data grid, server-declared forms, page scaffolding, dialogs, pickers, and the chrome an administrative surface is built from.
It sits above @coolms/core-angular,
which owns the session, the boot manifest, theming and the wire types. The kit
draws; core knows.
Install
npm install @coolms/ui-angular @coolms/core-angularAngular, NGXS, RxJS and @angular/cdk are peers; the supported ranges are declared in package.json, which is what an install actually checks. The CodeMirror
packages and centrifuge are optional peers: install them only if you use
the code editor or the realtime notification client.
Use
Everything public is exported from the package root. There is no deep import
path, and that is enforced rather than encouraged — the barrel at
src/public-api.ts is the whole API.
import { CmsListPageComponent, DataGridComponent, ToastService } from '@coolms/ui-angular';101 of the package's 146 modules are exported, chosen from the symbols a real
application names. The remaining 45 are internal: exported so their
neighbours can reach them, which is not the same as being public. If something
you need is missing, exporting it is a deliberate decision about the API rather
than an import detail — open an issue.
Building it
npm --prefix ../core-angular run build # the kit compiles against core's built types
npm run buildCore is consumed as a built peer, not as sources. Source-consuming it would
put core's files outside this package's rootDir and, worse, compile core into
this bundle — two copies of one runtime in any application that installs both.
Status
A pre-release: the shape is still moving and it carries no compatibility promise. Two dynamic-form fields import CoolmsEditorComponent from @coolms/editor-angular, which is a peer -- install it alongside this kit if you use those fields.
Licence
MIT.
