vue-transition-component

Provides GreenSock transition functionality to vue.js components.

Installation

yarn add vue-transition-component

npm i -S vue-transition-component

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/vue-transition-component.git
cd vue-transition-component/example
yarn
yarn dev
Open your browser localhost:8080

or click this link to preview online

Building

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

Clone a copy of the repo:

git clone https://github.com/larsvanbraam/vue-transition-component.git

Change to the vue-transition directory:

cd vue-transition-component

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

This site is open source. Improve this page.