@mediamonks/muban-transition-component-legacy

⚠️ This package is compatible with the legacy version of Muban, please use @mediamonks/muban-transition-component for newer versions of Muban

Provides GreenSock transition functionality to muban components.

Table of contents

1. Installation
2. Demo
3. Usage
4. Building
5. Authors
6. Contribute
7. License

Installation

yarn / npm

yarn add @mediamonks/muban-transition-component-legacy

npm i -S @mediamonks/muban-transition-component-legacy

Online Demo

Checkout the online demo.

Demo

Demo can be found in /example. Install dev dependencies:

  yarn

Run the example:

  yarn dev

Usage

Detailed documentation and examples are located in the wiki!

Check the wiki!

Building

In order to build muban-transition-component, ensure that you have Git and [Node.js] (http://nodejs.org/) installed.

Clone a copy of the repo:

git clone https://github.com/riccoarntz/muban-transition-component.git

Change to the vue-transition directory:

cd muban-transition-component

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build           # build this project
yarn dev             # run dev-watch mode, serving example/index.html in the browser
yarn generate        # generate all artifacts (compiles ts, webpack, docs and coverage)
yarn test:unit       # run the unit tests
yarn validate        # runs validation scripts, including test, lint and coverage check
yarn lint            # run tslint on this project
yarn doc             # generate typedoc documentation

When installing this module, it adds a pre-push hook, that runs the validate script before committing, so you can be sure that everything checks out.

Authors

View AUTHORS.md

Contribute

View CONTRIBUTING.md

License

MIT © Ricco Arntz