Options
All
  • Public
  • Public/Protected
  • All
Menu

vue-transition-collection

Travis (.com) branch David David Codecov branch GitHub type definitions npm

Easy to use transitions for your vue project.

Demo

Demo

Usage

npm i vue-transition-collection
import VueTransitionCollection from "vue-transition-collection"

Vue.use(VueTransitionCollection)
<vtc-fade mode="out-in" direction="right" duration="1000" delay="0">
  <div :key="someKey">some content</div>
</vtc-fade>

Available transitions

  • vtc-fade
  • vtc-zoom
  • vtc-bounce
  • vtc-flip
  • vtc-fade-big
  • vtc-rotate
  • vtc-slide

Available props

  • group: boolean - Use <transition-group> instead of <transition>
  • mode: "in-out"|"out-in" - The transition mode
  • direction: "right"|"left"|"up"|"down"|"toggle" - The direction of the transition
  • inverse: boolean - Switch left/right and up/down
  • delay: number - The delay until the transition starts
  • duration: number - The duration of the transition

Index

Type aliases

Directions

Directions: "toggle" | "left" | "right" | "up" | "down"

Functions

Const applyDurationAndDelay

  • applyDurationAndDelay(__namedParameters: object): (Anonymous function)
  • Parameters

    • __namedParameters: object
      • delay: string | number
      • duration: string | number

    Returns (Anonymous function)

Const createSimpleTransition

  • createSimpleTransition(vue: VueConstructor<Vue.default>, description: TransitionDescription): VueConstructor<Object & Vue>

Object literals

Const VueTransitionCollection

VueTransitionCollection: object

applyDurationAndDelay

applyDurationAndDelay: applyDurationAndDelay

generateComponents

  • generateComponents(vue: VueConstructor<Vue.default>): object
  • Parameters

    • vue: VueConstructor<Vue.default>

    Returns object

    • bounce: VueConstructor<Object & Vue>
    • fade: VueConstructor<Object & Vue>
    • fadeBig: VueConstructor<Object & Vue>
    • flip: VueConstructor<Object & Vue>
    • rotate: VueConstructor<Object & Vue>
    • slide: VueConstructor<Object & Vue>
    • zoom: VueConstructor<Object & Vue>

install

  • install(vue: VueConstructor<Vue>, args: undefined | PluginOptions): void

Const transitionDescriptions

transitionDescriptions: object

bounce

bounce: object

displayName

displayName: string = "Bounce"

down

down: object

enter

enter: string = "bounceInUp"

leave

leave: string = "bounceOutUp"

left

left: object

enter

enter: string = "bounceInLeft"

leave

leave: string = "bounceOutRight"

right

right: object

enter

enter: string = "bounceInRight"

leave

leave: string = "bounceOutLeft"

toggle

toggle: object

enter

enter: string = "bounceIn"

leave

leave: string = "bounceOut"

up

up: object

enter

enter: string = "bounceInDown"

leave

leave: string = "bounceOutDown"

fade

fade: object

displayName

displayName: string = "Fade"

down

down: object

enter

enter: string = "fadeInUp"

leave

leave: string = "fadeOutUp"

left

left: object

enter

enter: string = "fadeInLeft"

leave

leave: string = "fadeOutRight"

right

right: object

enter

enter: string = "fadeInRight"

leave

leave: string = "fadeOutLeft"

toggle

toggle: object

enter

enter: string = "fadeIn"

leave

leave: string = "fadeOut"

up

up: object

enter

enter: string = "fadeInDown"

leave

leave: string = "fadeOutDown"

fadeBig

fadeBig: object

displayName

displayName: string = "Fade"

down

down: object

enter

enter: string = "fadeInUpBig"

leave

leave: string = "fadeOutUpBig"

left

left: object

enter

enter: string = "fadeInLeftBig"

leave

leave: string = "fadeOutRightBig"

right

right: object

enter

enter: string = "fadeInRightBig"

leave

leave: string = "fadeOutLeftBig"

toggle

toggle: object

enter

enter: string = "fadeIn"

leave

leave: string = "fadeOut"

up

up: object

enter

enter: string = "fadeInDownBig"

leave

leave: string = "fadeOutDownBig"

flip

flip: object

displayName

displayName: string = "Flip"

down

down: object

enter

enter: string = "flipInX"

leave

leave: string = "flipOutX"

left

left: object

enter

enter: string = "flipInY"

leave

leave: string = "flipOutY"

right

right: object

enter

enter: string = "flipInY"

leave

leave: string = "flipOutY"

toggle

toggle: object

enter

enter: string = "flip"

leave

leave: string = "flip"

up

up: object

enter

enter: string = "flipInX"

leave

leave: string = "flipOutX"

rotate

rotate: object

displayName

displayName: string = "Rotate"

down

down: object

enter

enter: string = "rotateInUpRight"

leave

leave: string = "rotateOutUpRight"

left

left: object

enter

enter: string = "rotateInDownLeft"

leave

leave: string = "rotateOutDownRight"

right

right: object

enter

enter: string = "rotateInDownRight"

leave

leave: string = "rotateOutDownLeft"

toggle

toggle: object

enter

enter: string = "rotateIn"

leave

leave: string = "rotateOut"

up

up: object

enter

enter: string = "rotateInDownLeft"

leave

leave: string = "rotateOutDownLeft"

slide

slide: object

displayName

displayName: string = "Slide"

down

down: object

enter

enter: string = "slideInUp"

leave

leave: string = "slideOutUp"

left

left: object

enter

enter: string = "slideInLeft"

leave

leave: string = "slideOutRight"

right

right: object

enter

enter: string = "slideInRight"

leave

leave: string = "slideOutLeft"

toggle

toggle: object

enter

enter: string = "fadeIn"

leave

leave: string = "fadeOut"

up

up: object

enter

enter: string = "slideInDown"

leave

leave: string = "slideOutDown"

zoom

zoom: object

displayName

displayName: string = "Zoom"

down

down: object

enter

enter: string = "zoomInUp"

leave

leave: string = "zoomOutUp"

left

left: object

enter

enter: string = "zoomInLeft"

leave

leave: string = "zoomOutRight"

right

right: object

enter

enter: string = "zoomInRight"

leave

leave: string = "zoomOutLeft"

toggle

toggle: object

enter

enter: string = "zoomIn"

leave

leave: string = "zoomOut"

up

up: object

enter

enter: string = "zoomInDown"

leave

leave: string = "zoomOutDown"

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc