ngx-content-loader
v0.0.1
Published
A collection of Angular components to use as placeholders when loading content
Downloads
11
Readme
ngx-content-loader
Demo
https://phillipcurl.github.io/ngx-content-loader/
Table of contents
About
A collection of Angular components to use as placeholders when loading content
Installation
Install through npm:
npm install --save ngx-content-loader
Then include in your apps module:
import { Component, NgModule } from '@angular/core';
import { ContentLoaderModule } from 'ngx-content-loader';
@NgModule({
imports: [
ContentLoaderModule.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/ngx-content-loader/bundles/ngx-content-loader.umd.js"></script>
<script>
// everything is exported ngxContentLoader namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://phillipcurl.github.io/ngx-content-loader/docs/
Development
Prepare your environment
- Install Node.js and <% if (isYarnAvailable) { %>yarn<% } else { %>NPM<% } %>
- Install local dev dependencies:
<% if (isYarnAvailable) { %>yarn<% } else { %>npm install<% } %>
while current directory is this repo
Development server
Run <% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> start
to start a development server on port 8000 with auto reload + tests.
Testing
Run <% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> test
to run tests once or <% if (isYarnAvailable) { %>yarn<% } else { %>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)
<% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> run release
License
MIT