# vue-router-md-transition

> Vue component with material design transition effect

Latest version **2.4.1** (published 2020-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-router-md-transition
pnpm add vue-router-md-transition
yarn add vue-router-md-transition
bun add vue-router-md-transition
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.1 |
| Published | 2020-09-20 |
| First published | 2019-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 585.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | 1isten |
| Maintainers | 1isten |
| Keywords | material design, transition, vue, vue router, vue component |

## Links

- npm: https://www.npmjs.com/package/vue-router-md-transition
- Repository: https://github.com/1isten/vue-router-md-transition
- Homepage: https://www.npmjs.com/package/vue-router-md-transition
- Issues: https://github.com/1isten/vue-router-md-transition/issues
- npm.io page: https://npm.io/package/vue-router-md-transition

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 2.4.1 (latest) — 2020-09-20
- 2.4.0 — 2020-09-20
- 2.3.4 — 2020-07-21
- 2.3.3 — 2020-07-20
- 2.3.2 — 2020-07-20
- 2.3.1 — 2020-07-20
- 2.3.0 — 2020-07-20
- 2.2.3 — 2020-07-19
- 2.2.2 — 2020-07-19
- 2.2.1 — 2020-07-19
- 2.2.0 — 2020-07-19
- 2.1.1 — 2020-07-19
- 2.1.0 — 2020-07-19
- 2.0.9 — 2020-07-18
- 2.0.8 — 2020-07-18
- … 27 more at https://npm.io/package/vue-router-md-transition/versions

## README

# vue-router-md-transition [![Version](https://img.shields.io/npm/v/vue-router-md-transition)](https://www.npmjs.com/package/vue-router-md-transition)

A simple transparent wrapper component for Vue's built-in [`<transition>` component](https://vuejs.org/v2/guide/transitions.html#Transitioning-Single-Elements-Components) with [Material Design transition effect](https://material.io/design/navigation/navigation-transitions.html#hierarchical-transitions) baked in.

> 🔔 v1 is outdated, consider upgrading to v2!

### Demo

- [Codepen (CDN)](https://codepen.io/1isten/pen/mdJqQJm)
- [Vuetify SPA (ES module)](https://1isten.github.io/vue-router-md-transition)

### Usage

```html
<md-transition>
  <router-view></router-view>
</md-transition>
```

### Install

##### Direct Download / CDN

Include the UMD build after `vue` and `vue-router`, the component will be registered automatically:

```html
<script src="/path/to/vue.js"></script>
<script src="/path/to/vue-router.js"></script>
<script src="/path/to/vue-router-md-transition.umd.min.js"></script>
```

📦 This package is available on [unpkg](https://unpkg.com/vue-router-md-transition), [jsdelivr](https://cdn.jsdelivr.net/npm/vue-router-md-transition), [bundle.run](https://bundle.run/vue-router-md-transition), and so on.

##### ES module

Install via npm:

```sh
npm install vue-router-md-transition
```

Import into your application:

```js
import MaterialDesignTransition from 'vue-router-md-transition';
```

Register the component:

```js
// globally in the entry file such as "main.js"
Vue.component('md-transition', MaterialDesignTransition);

// or, locally in specific components
export default {
  components: {
    'md-transition': MaterialDesignTransition,
  },
};
```

### Props

##### `offsetTop` (Type: `number` | Default: `64`)

Used to fine tune the `translate3d` CSS function to match the height of the [top app bar](https://material.io/components/app-bars-top#specs) in Material Design spec.

##### `duration` (Type: `number` | Default: `250`)

Transition duration in milliseconds.

##### `reverse` (Type: `boolean` | Default: `false`)

Reverse transition direction.

##### `disabled` (Type: `boolean` | Default: `false`)

Do not apply any transition.

... For other props, please refer to Vue's [official api doc](https://vuejs.org/v2/api/#transition) of the built-in `<transition>` component.

### Example

```html
<template>
  <div id="app">
    <div id="nav">
      <router-link to="/">Home</router-link> |
      <router-link to="/about">About</router-link>
    </div>

    <md-transition
      :offset-top="56"
      :duration="300"
      :reverse="isRouteBack"
      :disabled="transitionDisabled"
    >
      <router-view></router-view>
    </md-transition>
  </div>
</template>

<script>
import MaterialDesignTransition from 'vue-router-md-transition';

export default {
  components: {
    'md-transition': MaterialDesignTransition,
  },
  data: () => ({
    isRouteBack: false,
    transitionDisabled: false,
  }),
  watch: {
    $route(to, from) {
      // disabled when refreshing browser
      this.transitionDisabled = !from.name;
      // reverse direction when routing back
      if (to.path === '/') {
        this.isRouteBack = true;
      } else if (from.path === '/') {
        this.isRouteBack = false;
      } else {
        const toDepth = to.path.split('/').length;
        const fromDepth = from.path.split('/').length;
        this.isRouteBack = toDepth < fromDepth;
      }
    },
  },
};
</script>
```

### Not Only for Vue Router

You can also use it in regular transitions, just like the built-in `<transition>`:

```html
<md-transition>
  <div key="foo" v-if="show">Foo</div>
  <div key="bar" v-else>Bar</div>
</md-transition>
```

---
_Source: https://npm.io/package/vue-router-md-transition · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._