Skip to content

octavioturra/paper-canvas

Repository files navigation

<paper-canvas>

Paper.js and canvas element wrapper.

Demo

Check it live.

Install

Install the component using Bower:

$ bower install paper-canvas --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

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

    <paper-canvas></paper-canvas>

Options

Attribute Options Default Description
width string 800px Specifies entire element width.
height string 600px Specifies entire element height.
background string #FFF Specifies the background color of the layer.

See Paper.js official documentation.

Access Paper.js API

	var myCanvas = document.querySelector('myCanvas');
	myCanvas.paper.[...]

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 @.@

License

MIT License © Octavio Turra. Documentation style and package structure based in voice-elements from Zeno Rocha.

Releases

No releases published

Packages

No packages published