Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gi/tilt-handlebars
A Tilt interface to the official JavaScript version of Handlebars.
https://github.com/gi/tilt-handlebars
handlebars ruby tilt
Last synced: about 1 month ago
JSON representation
A Tilt interface to the official JavaScript version of Handlebars.
- Host: GitHub
- URL: https://github.com/gi/tilt-handlebars
- Owner: gi
- License: mit
- Created: 2013-07-05T23:07:02.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-03T08:53:54.000Z (almost 3 years ago)
- Last Synced: 2024-10-10T00:52:11.209Z (about 1 month ago)
- Topics: handlebars, ruby, tilt
- Language: Ruby
- Homepage:
- Size: 83 KB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Tilt::Handlebars
[](https://rubygems.org/gems/tilt-handlebars)
[](https://github.com/gi/tilt-handlebars/actions/workflows/ci.yml)
[](https://codeclimate.com/github/gi/tilt-handlebars/test_coverage)
[](https://codeclimate.com/github/gi/tilt-handlebars/maintainability)
[](LICENSE.txt)
A [Tilt](https://github.com/rtomayko/tilt) interface for the official JavaScript
implementation of the [Handlebars.js](https://handlebarsjs.com) template engine.
[Handlebars::Engine](https://github.com/gi/handlebars-ruby) provides the API
wrapper. [MiniRacer](https://github.com/rubyjs/mini_racer) provides the
JavaScript execution environment.
See [Handlebars.js](http://handlebarsjs.com) for template syntax.
See [Handlebars::Engine](https://github.com/gi/handlebars-ruby) for API syntax.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'tilt-handlebars'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install tilt-handlebars
## Usage
Create a Handlebars template file with either a `.hbs` or `.handlebars` extension.
Example, in `hello.hbs`:
```
Hello, {{name}}. I'm {{emotion}} to meet you.
```
Then, render the template with Ruby:
```ruby
require 'tilt/handlebars'
template = Tilt.new('hello.hbs')
puts template.render(nil, name: "Joe", emotion: "happy")
```
Output:
Hello, Joe. I'm happy to meet you.
### Partials
Partials are a file that can be loaded into another. For example, you may define a web page with
a master layout (`layout.hbs`), which includes a header (`header.hbs`) and footer (`footer.hbs`).
In this case, `header.hbs` and `footer.hbs` would be partials; `layout.hbs` includes these partials.
`layout.hbs`:
```html
...
{{> header }}
{{ content }}
{{> footer }}
```
Notice that you do not include the `.hbs` file extension in the partial name. Tilt Handlebars
will look for the partial relative to the enclosing file (`layout.hbs` in this example) with
either a `.hbs` or `.handlebars` extension.
#### Sinatra
Handlebars can be used with Sintra:
```ruby
require 'sinatra/handlebars'
class MyApp < Sinatra::Base
helpers Sinatra::Handlebars
get "/hello" do
handlebars :hello, locals: {name: 'Joe'}
end
end
```
This will use the template file named `views/hello.hbs`.
Partials can also be used with Sinatra. As described previously, partials will be loaded
relative to the enclosing template (e.g., in the `views` directory).
## Changelog
See [RELEASE_NOTES.md](RELEASE_NOTES.md) for more details.
## Contributing
Bug reports and pull requests are welcome on GitHub:
https://github.com/gi/tilt-handlebars.
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).