Transform text files into strings on a global JavaScript object.
Why do this? Your Rails application might serve up a single-page web application, which requires text assets (like SVGs). You need these assets to render your application, and you don't want to fetch them via AJAX (to avoid lag), nor embed them in the returned HTML (to keep the HTML response small).
Especially in the case of SVGs, their contents are needed so they can be inserted into the document inline, so they can be styled with CSS.
Support is currently available for the following text file types:
- ".svg" files
If you'd like more, please submit a PR.
Add this line to your application's Gemfile:
gem 'js-text-rails'And then execute:
$ bundle
Or install it yourself as:
$ gem install js-text-rails
After adding the gem to your Gemfile, clear your cache:
rake tmp:clearNormally, text file contents are stored in a global object named TEXT or SVG
(for ".svg" files). You may customize the namespace used by all text files by
setting config.js_text_rails.namespace. e.g., in app/config/application.rb:
module App
class Application < Rails::Application
config.js_text_rails.namespace = 'App.Text'
end
endThen all text file contents would instead be stored in the global object App
on a property called Text.
To disable the gem, just remove transformer:
JsTextRails.uninstall(Rails.application.assets)If you use Sinatra or other non-Rails frameworks with Sprockets, just connect your Sprockets environment with it:
assets = Sprockets::Environment.new do |env|
# Your assets settings
end
require 'js-text-rails'
JsTextRails.install(assets, namespace: 'App.Text')require your files, e.g. in app/assets/javascripts/application.js:
//= require_tree ../images/iconsWhere app/assets/images/icons contains the file envelope.svg.
Anywhere in your application's JavaScript code, access the text file contents
via the global SVG variable:
var envelopeIcon =
799E
SVG['icons/envelope'];
// Do something with `envelopeIcon`...Here is a practical example of inserting an SVG inline:
document.querySelector('#email-icon').innerHTML = SVG['icons/envelope'];Or, in a JST template:
<span id="email-icon"><%- SVG['icons/envelope'] %></span> Email me at <%= @email %>!After checking out the repo, run bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run bin/console for an interactive
prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To
release a new version, update the version number in version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push
git commits and tags, and push the .gem file
to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/cloversites/js-text-rails.
The gem is available as open source under the terms of the MIT License.