/web-components-rails

Primary LanguageRubyMIT LicenseMIT

web_components_rails

Ruby gem for using web components in Rails applications.

Usage

  1. Include the gem in your Gemfile:
gem 'web_components_rails'
  1. Add an HTML file to your project (can be just HTML or a Polymer component):
<!-- app/assets/javascripts/my_component.html -->
<h1>Hello</h1>
  1. Include a web component in one of your views:
<%= html_import_tag 'my_component' %>

Optimized JavaScript

If you'd like the scripts in your HTML bundles to be combined, minified using Uglifier, and data-src encoded for performance:

# In an initializer or somewhere on rails load
WebComponentsRails.optimize_scripts = true

Building

After adding new features or fixes, please update the version in version.rb, and then tag the repo appropriately:

git tag -a -m 'Added foo' 1.1.0
git push --tags

To release the gem (internally), use rake build, and push the gem with stickler.