https://github.com/rubyonworld/haml-js
Precompiles the HAML-JS templates into a function.
https://github.com/rubyonworld/haml-js
function html js precompile template
Last synced: 3 months ago
JSON representation
Precompiles the HAML-JS templates into a function.
- Host: GitHub
- URL: https://github.com/rubyonworld/haml-js
- Owner: RubyOnWorld
- License: mit
- Created: 2022-09-27T15:39:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-28T00:57:26.000Z (over 2 years ago)
- Last Synced: 2024-12-28T14:26:09.291Z (5 months ago)
- Topics: function, html, js, precompile, template
- Language: Ruby
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Ruby HAML-JS
Precompiles the HAML-JS templates into a function.
This can be used as a standalone template or as part of Rails 3.1 assets pipeline.
For example, if you have a file `app/assets/javascripts/templates/comment.jst.hamljs` with the following content:
```haml
.comment
.author= author
.text= text
```
Then it will be *compiled* on the server side into a plain JavaScript function.
It doesn't require you to do anything on the client side.
And the result will look like this:
```javascript
(function() {
this.JST || (this.JST = {});
this.JST["templates/comment"] = function (locals) { function html_escape(text) {
return (text + "").
replace(/&/g, "&").
replace(//g, ">").
replace(/\"/g, """);
}
with(locals || {}) {
try {
var _$output="
return _$output; } catch (e) {
return "\n" + html_escape(e.stack) + "
\n";
}
}
};
}).call(this);
```
Then you access that template like so:
```javascript
var commentView = JST['templates/comment'];
// ...
// Somewhere in your code later:
var html = commentView({author: 'Dima', text: 'Looks nice'});
```
# Installation
```ruby
# Gemfile
gem 'ruby-haml-js'
```
```bash
# Then install it
bundle
```
# Usage - with Rails 3.1 assets pipeline
1. Put your template unders `app/assets/javascripts` (or other path where Rails can find it).
2. Use the naming `my-template.jst.hamljs`.
3. Serve the template to browser by `require my-template` from `application.js` or link to it as `my-template.js`
4. Use the template from the JavaScript: `JST['my-template']({your: 'local', variables: 'go here'})`
# Configuration
## Custom HTML escape
You can change the escape function from the built-in, autogenerated to your own:
```ruby
# Set it somewhere, before generating the template.
# Good place can be a Rails initializer.
RubyHamlJs::Template.custom_escape = "App.escape_html"
```
This will use the given function and will not generate custom escape code inside each template.
But you need to make sure that the function is defined before using the templates in JavaScript.
## Custom haml.js
If you need a custom version of haml.js library you may specify it using the haml_path
```ruby
RubyHamlJs::Template.haml_path = "path/to/haml.js"
```
# Development
- Source hosted at [GitHub](https://github.com/dnagir/ruby-haml-js)
- Report issues and feature requests to [GitHub Issues](https://github.com/dnagir/ruby-haml-js/issues)
Pull requests are very welcome! But please write the specs.
To start, clone the repo and then:
```shell
bundle install
bundle exec rspec spec/
```
html_escape(author) +
"
html_escape(text) +
"