ngx-theme
v0.0.6
Published
An Angular module for creating functional, type-safe design systems, build on top of Typestyle
Downloads
3
Readme
ngx-theme
Demo
https://phillipcurl.github.io/ngx-theme/demo/
Table of contents
About
An Angular module for creating functional, type-safe design systems, build on top of Typestyle
Installation
Install through npm:
npm install --save ngx-theme
Then include in your apps module:
import { Component, NgModule } from '@angular/core';
import { NgxThemeModule } from 'ngx-theme';
@NgModule({
imports: [
NgxThemeModule.forRoot()
]
})
export class MyModule {}
Finally use in one of your apps components:
import { Component } from '@angular/core';
@Component({
template: '<hello-world></hello-world>'
})
export class MyComponent {}
You may also find it useful to view the demo source.
Usage without a module bundler
<script src="node_modules/dist/umd/ngx-theme/ngx-theme.js"></script>
<script>
// everything is exported ngxTheme namespace
</script>
Documentation
All documentation is auto-generated from the source via typedoc and can be viewed here: https://phillipcurl.github.io/ngx-theme/docs/
Development
Prepare your environment
- Install Node.js and NPM (should come with)
- Install local dev dependencies:
npm install
while current directory is this repo
Development server
Run npm start
to start a development server on port 8000 with auto reload + tests.
Testing
Run npm test
to run tests once or npm run test:watch
to continually run tests.
Release
- Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release
License
MIT