pixelhandler / ember-off-canvas-components

A micro library containing a group of Ember.js Components that interact to create an Off-Canvas user interface.
http://pixelhandler.github.io/ember-off-canvas-components/
MIT License
41 stars 4 forks source link

Ember Off Canvas Components

A micro library packaged as and Ember CLI Addon - a group of Ember.js Components that interact to create an Off-Canvas user interface.

Build Status

Installation

As an Ember CLI addon

Use this addon in you ember-cli application...

ember install ember-off-canvas-components

As a Standalone Library

Download a release.

Copy to your vendor directory and link up the .js and .css files

View a demo

Contributing

Installation

git clone git@github.com:pixelhandler/ember-off-canvas-components.git
cd ember-off-canvas-components
npm install
bower install
npm run sass

Running

  1. ember server
  2. Visit your app at http://localhost:4200.

Running Tests

Building

For more information on using ember-cli, visit http://www.ember-cli.com/.

Also see the packaging readme file for a non Ember CLI release.

Test the addon as a dependency

The dummy app is used for the demo on the gh-pages branch. Test out the addon in an ember-cli by copying some of the source code of the dummy app.

Test with local clone of this repo using npm link

cd ember-off-canvas-components
npm link
cd ../
ember new test-app
cd test-app
npm link ember-off-canvas-components

Or, test with a github repo

ember new test-app
cd test-app
npm install pixelhandler/ember-off-canvas-components --save-dev

Copy the dummy app files and run the test-app

cp node_modules/ember-off-canvas-components/tests/dummy/app/templates/application.hbs app/templates/application.hbs
cp node_modules/ember-off-canvas-components/tests/dummy/app/templates/index.hbs app/templates/index.hbs
cp node_modules/ember-off-canvas-components/tests/dummy/app/templates/off-canvas.hbs app/templates/off-canvas.hbs
cp node_modules/ember-off-canvas-components/tests/dummy/app/controllers/index.js app/controllers/index.js
cp node_modules/ember-off-canvas-components/tests/dummy/app/routes/index.js app/routes/index.js
cp node_modules/ember-off-canvas-components/tests/dummy/app/styles/app.css app/styles/app.css
ember server