duner / x-juxtapose

A proof of concept to try to get JuxtaposeJS working inside of a web component

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

<x-juxtapose>

A proof of concept to try to get JuxtaposeJS working inside of a web component

Install

Install the component using Bower:

$ bower install x-juxtapose --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/x-juxtapose/dist/x-juxtapose.html">
  3. Start using it!

    <x-juxtapose>
        <jx-image src="">
        <jx-image src="">
    </x-juxtapose>

Options

**I'll get to this at some point; check the main Juxtapose page for now."

Attribute Options Default Description
foo string bar Lorem ipsum dolor.

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  • Install local dependencies:

    $ bower install && npm install
  • To test your project, start the development server and open http://localhost:8000.

    $ grunt server
  • To build the distribution files before releasing a new version.

    $ grunt build
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License

About

A proof of concept to try to get JuxtaposeJS working inside of a web component


Languages

Language:JavaScript 100.0%