ng-original-template
Extract peices of templates from Angular components declaratively or via service
Installation
$ npm install --save ng-original-template
Usage
Import OriginalTemplateModule
module in your root module:
;
You can also import this module into your sub-modules if you need to use directive.
Just remember to import with forRoot()
method only for your root module.
Declarative usage
Now in component where you want to get it's template:
- Provide component type via
provideTemplateFrom()
function - In template mark which section of template you want to get and in what property to save it via
originalTemplate
directive
;
Programmatic usage
You can also get pieces of template in your code via OriginalTemplateService
:
- Just mark the piece of template you want with any attribute
- Pass component type and attribute regex string to match
;
Documentation
OriginalTemplateDirective
See src/original-template/original-template.directive.ts for full reference
Description: Directive to get piece of template declaratively. All calls forwarded to OriginalTemplateService
internally.
Input originalTemplate is required to tell where to store template in component instance.
Input originalTemplateInner is optional to get only inner template (skip the node where this directive was placed).
Input originalTemplatePrecise is optional to enable precise mode for getting outer template (slower).
OriginalTemplateService
See src/original-template/original-template.service.ts for full reference
Description: Get a piece of template from component by directive match regexp.
By default it will get outer template in not precise mode.
If you selecting custom element - it will be the fastest method.
For common html tags like div
it might be inacurate - so you may want to enable precise mode.
If you selecting inner template - precise mode will be used anyway.
NOTE: matchRegexp
argument is used to construct a regexp and is not escaped so you can build flexible matches.
Development
To generate all *.js
, *.js.map
, *.d.ts
and *.metadata.json
files:
$ npm run build
To lint all *.ts
files:
$ npm run lint
To run unit tests:
$ npm test
License
MIT © Alex Malkevich