Code Monkey home page Code Monkey logo

silian-rail's Introduction

SilianRail

SilianRail extends Sprockets to allow you to import Web Components into the Rails Asset Pipeline.

Installation

Add the following line to your Rails application's Gemfile:

gem 'silian-rail'

Run the bundle command:

$ bundle

And generate a manifest file by running:

$ rails generate silian_rail:install

The generator will create a components folder and manifest file at app/assets/components/application.html.

Finally, insert the following tag into your application layout:

<%= html_include_tag 'application' %>

Usage

Use the Sprockets require Directive within the components manifest file to pull in a web component and its dependencies.

When referencing a web component (i.e. the Polymer paper-card component) you must reference the actual HTML file like so:

  *= require paper-card/paper-card

The require directive will search your assets paths (app/assets, lib/assets, and vendor/assets by default) for the directory and file. Once the directory/file is found, the component, along with any dependencies defined within, is pulled into the asset pipeline.

Contributing

  1. Fork it ( http://github.com/eanlain/silian-rail/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

silian-rail's People

Watchers

James Cloos avatar Brandon Robins avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.