InlineViewComponent
This gem allows your ViewComponents to define template strings within the class definition. You should be able to use any templating language your rails app supports (ERB, HAML, Slim...). There's also custom syntax highlighting for heredoc templates for Sublime Text.
Usage
Include the InlineViewComponent
mixin and then specify your template string with template(string)
. Be sure to delete your component's external template file or ViewComponent will raise an error.
Examples
class ErbComponent < ViewComponent::Base
include InlineViewComponent
def message
"Hello World!"
end
template <<~ERB
<p> <%= message %> </p>
ERB
end
class HamlComponent < ViewComponent::Base
include InlineViewComponent
def message
"Hello HAML!"
end
template <<~HAML, :haml
%p= message
HAML
end
You can provide any template format you have installed as an optional second argument to the template method
template <<~SLIM, :slim
h1 Hello World!
SLIM
Installation
Add this line to your application's Gemfile:
gem 'inline_view_component'
And then execute:
$ bundle
Or install it yourself as:
$ gem install inline_view_component
Syntax Highlighting
Syntax highlighting for Sublime Text is available. Download this file and add it to your Sublime User package. Then open your ruby files in the Ruby (Custom)
syntax (or choose View -> Syntax -> Open All with current extention as...
to use it automatically).
To get syntax highlighting to work use ERB
, HAML
, or SLIM
as the delimiter for your heredoc string e.g.
template <<~HAML, :haml
%h1 A really great template
HAML
TODO
This is an early release. Contributions are welcome!
- add syntax highlighting for more editors (VS Code, vim, ...)
Contributing
Send a pull request.
License
The gem is available as open source under the terms of the MIT License.