Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.4 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.4 KB
Raw

Travis npm GitHub issues

AbstractTransitionController

An abstract transition controller that can be used for transitioning elements

Installation

yarn add transition-controller
npm i -S transition-controller

Documentation

Example

I've included an example setup where you can see the transition controller in action, to run the project follow these steps:

  • git clone https://github.com/larsvanbraam/transition-controller.git
  • cd transition-controller/example
  • yarn
  • yarn dev
  • Open your browser localhost:8080

or click this link to preview online

Building

In order to build transition-controller, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/larsvanbraam/transition-controller.git

Change to the transition-controller directory:

cd transition-controller

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build            # build this project
yarn dev              # run compilers in watch mode, both for babel and typescript
yarn test             # run the unit tests incl coverage
yarn test:dev         # run the unit tests in watch mode
yarn lint             # run eslint and tslint on this project
yarn doc              # generate typedoc documentation

When installing this module, it adds a pre-commit hook, that runs lint and prettier commands before committing, so you can be sure that everything checks out.

Authors

View AUTHORS.md

Contribute

View CONTRIBUTING.md

License

MIT © Lars van Braam