angularjs-templates-brunch
v1.0.0
Published
Places templates in an AngularJS module via a Brunch.io plugin
Downloads
432
Readme
Compile templates in an AngularJS module as a Brunch plugin
For each template, wrap around in a shared AngularJS module called
templates
by default with each template file's path as the template URL.
See $templateCache for more
information.
Installation
npm install --save angularjs-templates-brunch
Usage
- Set
joinTo
attribute fortemplates
inconfig.coffee
, e.g.
```coffee
templates:
joinTo:
'templates.js': /^app/
```
- In your markup, include
templates.js
:
```html
<script type="text/javascript" src="/templates.js"></script>
```
- Your app module must require the module your templates were placed in:
```coffee
angular.module('MyApp', [
...
'templates'
...
]);
```
- Get a particular template by its path.
```coffee
$routeProvider.when('/home', { templateUrl: 'app/home/home.html' });
```
- Run Brunch (e.g.
brunch build
)
Options
module
Specify the module to place the templates in
Default: templates
plugins:
angular_templates:
module: 'MyModule'
path_transform
Specify a transform function for the template path. This callback function will be invoked with the brunch path to each template file (e.g. 'app/home/home.html') and must return a new path for that template (e.g. '/partials/home/home.html'). This new path will be used when inserting into the template cache. This allows the template files to be served from an arbitrary location regardless of their source.
Default: no-op (returns input path)
Example: if your template is in app/scripts/somedir/myTemplate.html buy you'd prefer to reference the templates as 'somedir/myTemplate.html', you could use this path transform:
plugins:
angular_templates:
path_transform: (path) -> path.replace('app/scripts/', '')
Credit
Inspiration from the following projects:
- https://github.com/aberman/html2js-brunch
- https://github.com/nathanredblur/html-angularjs-brunch
- https://github.com/kenhkan/angular-templates-brunch/
- https://github.com/jupl/aang-template-brunch