Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pitr/angular-rails-templates
Use your angular templates with rails' asset pipeline
https://github.com/pitr/angular-rails-templates
angular angular-rails-templates angular-template rails rails-asset-pipeline
Last synced: 3 months ago
JSON representation
Use your angular templates with rails' asset pipeline
- Host: GitHub
- URL: https://github.com/pitr/angular-rails-templates
- Owner: pitr
- License: mit
- Created: 2013-07-16T14:22:05.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T02:39:34.000Z (about 1 year ago)
- Last Synced: 2024-04-15T09:05:40.699Z (7 months ago)
- Topics: angular, angular-rails-templates, angular-template, rails, rails-asset-pipeline
- Language: Ruby
- Homepage: https://rubygems.org/gems/angular-rails-templates
- Size: 364 KB
- Stars: 565
- Watchers: 15
- Forks: 170
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-projects-boilerplates - AngularJS Rails Templates
README
# Angular Rails Templates
[](http://badge.fury.io/rb/angular-rails-templates)
[](https://coveralls.io/github/pitr/angular-rails-templates?branch=master)
[](https://codeclimate.com/github/pitr/angular-rails-templates)
[](http://issuestats.com/github/pitr/angular-rails-templates)
[](http://issuestats.com/github/pitr/angular-rails-templates)
[](https://waffle.io/pitr/angular-rails-templates)
Adds your HTML templates into Angular's `$templateCache` using Rails asset pipeline.
**IMPORTANT**: for Rails 4.2+ use version 1.0+ of this gem. For Rails 3 - 4.1 use version 0.x
Branch | Build Status
------------|---------
master | [](https://github.com/pitr/angular-rails-templates)
0-x-stable | [](https://travis-ci.org/pitr/angular-rails-templates)
It removes the need for AJAX calls to retrieve the templates (or for you to manually set them into the DOM).
## Usage
### 1. Add the Gem
In Gemfile
```ruby
gem 'angular-rails-templates'
```
### 2. Include Templates in Rails Asset Pipeline
Then, in your `application.js` file, require `angular-rails-templates` and your templates:
```javascript
//= require angularjs
// ...
//= require angular-rails-templates
//
// Templates in app/assets/javascript/templates
//= require_tree ./templates
// OR
// Templates in app/assets/templates (but see step 5)
//= require_tree ../templates
```
Make sure to `require angular-rails-templates` **before** you require your templates.
Name your templates like you would name any other Rails view. **The `.html` part is required.** If it is not present your views will not be added to angular's template cache.
```
foo.html
foo.html.erb
foo.html.haml
foo.html.slim
```
Angular Rails Templates will try to load support for the following markups if their gems are present:
| Extension | Required gem |
|---------- |----------------------------------------------------------|
| .erb | - |
| .str | - |
| .haml | haml |
| .slim | slim |
| .md | liquid, rdiscount, redcarpet, bluecloth, kramdown, maruku |
See [Advanced](#advanced-configuration) if you would like to use other markup languages.
### 3. Add a Dependency in your Angular Application Module
Your Angular module needs to depend on the `templates` module. (configurable, see [Advanced Configuration](#configuration-option-module_name))
```javascript
angular.module('myApplication', ['templates']);
```
### 4. Use your Templates
No matter what the source file extension is, your template's url will be `#{base_name}.html`
For example:
```ruby
main.html => main.html
widget.html.haml => widget.html
modals/confirm.html.slim => modals/confirm.html
modals/dialog.html.slim.erb.str => modals/dialog.html # don't do this
```
The templates can then be accessed via `templateUrl` as expected:
```javascript
// Template: app/assets/templates/yourTemplate.html.haml
{
templateUrl: 'yourTemplate.html'
}
```
Or anything else that uses `$templateCache` or `$templateRequest`
```html
```
### 5. Avoid name collisions
If you have `app/assets/javascript/user.js` and `app/assets/templates/user.html`, the former one will actually hide the latter. This is due to how Rails asset pipeline sees asset files, both are served under `/assets/user.js`. Please use namespacing to combat this issue.
## Advanced Configuration
Angular Rails Templates has some configuration options that can be set inside `config/application.rb`
Here are their default values:
```ruby
# config/application.rb
config.angular_templates.module_name = 'templates'
config.angular_templates.ignore_prefix = %w(templates/)
config.angular_templates.inside_paths = ['app/assets']
config.angular_templates.markups = %w(erb str haml slim md)
config.angular_templates.extension = 'html'
```
### Configuration Option: `module_name`
This configures the module name that your templates will be placed into.
It is used to generate javascript like:
```javascipt
angular.module("<%= module_name %>")...
```
Although it is not recommended, you can set `module_name` to the name of your main application module and remove `require angular-rails-templates` from your javascript manifest to have your templates directly injected into your app.
### Configuration Option: `ignore_prefix`
*If you place your templates in `app/assets/templates` this option is mostly useless.*
`ignore_prefix` will be stripped from the beginning of the `templateUrl` it reports to angularjs.
Since the default ignore_prefix is [`templates/`], any templates placed under `app/assets/javascripts/templates` will automatically have short names. If your templates are not in this location, you will need to use the full path to the template.
You can set `config.angular_templates.ignore_prefix` to change the default ignore prefix. Default is [`templates/`].
``` javascript
// Templates in: app/assets/javascripts/templates (default)
// ignore_prefix: templates/ (default)
{
templateUrl: 'yourTemplate.html'
}
// This won't work:
{
templateUrl: 'templates/yourTemplate.html'
}
```
``` javascript
// Templates in: app/assets/javascripts/my_app/templates (custom)
// ignore_prefix: templates/ (default)
{
templateUrl: 'my_app/templates/yourTemplate.html'
}
// ignore_prefix: my_app/templates/ (custom)
{
templateUrl: 'yourTemplate.html'
}
```
### Configuration Option: `inside_paths`
Templates only from paths matched by `inside_paths` will be used. By default anything under app/assets can be templates. This option is useful if you are using this gem inside an engine. Also useful if you DON'T want some files to be processed by this gem (see issue #88)
### Configuration Option: `markups`
Any markup that Tilt supports can be used, but you may need to add a gem to your Gemfile. See [Tilt](https://github.com/rtomayko/tilt) for a list of the supported markups and required libraries.
```ruby
# Gemfile
gem "asciidoctor"
gem "radius"
gem "creole"
gem "tilt-handlebars"
# config/application.rb
config.angular_templates.markups.push 'asciidoc', 'radius', 'wiki', 'hbs'
```
If you would like to use a non-standard extension or you would like to use a custom template, you just need to tell Tilt about it.
```ruby
# config/initializers/angular_rails_templates.rb
Tilt.register Tilt::HamlTemplate, 'nghaml'
# config/application.rb
config.angular_templates.markups.push 'nghaml'
```
Note: You would still need to use `foo`**`.html`**`.nghaml`
### Configuration Option: `extension`
By default this gem looks only at templates with `.html` suffix, eg. `foo.html` or `foo.html.haml`. This extension allows you to change that to another extension
## License
MIT License. Copyright 2017 pitr
## Authors & contributors
* Damien Mathieu <[email protected]>
* pitr
* Jeremy Ebler
* Chris Nelson