Giter Club home page Giter Club logo

v-aos's Introduction

v-aos

Vue plugin for AOS (animate on scroll library)

Using

1. Unpkg

<script src="https://unpkg.com/v-aos"></script>

2. Package manager

npm i v-aos --save

3. Plug-in

import Vue from 'vue'
import VAos from 'v-aos'

Vue.use(VAos);

With AOS init settings :

Vue.use(VAos, {
  startEvent: 'DOMContentLoaded',
  duration: 400,
  delay: 100
})

4. Use in your components

<template>
  <div v-aos:fade-up>Hello world</div>
</template>

List of available animations

With flags:

<template>
  <div v-aos:fade-up.once>Hello world</div>
</template>

With parameters:

<template>
  <div v-aos:fade-up="{ delay: 100, offset: 200 }">Hello world</div>
</template>

List of available options

5. Use with Nuxt

plugins/v-aos.js:

import Vue from 'vue'
import VAos from 'v-aos'

Vue.use(VAos);

nuxt.config.js:

plugins: [
  { src: '~/plugins/v-aos', mode: 'client' },
]

6. Access AOS object

AOS object can be accessed through $aos property in components or through window.AOS

export default {
  mounted() {
    this.$nextTick(() => this.$aos.refreshHard())
  }
}

7. AOS events

<div v-aos:fade-up @aos:in="handleAosIn"></div>

List of available events

License

MIT

v-aos's People

Contributors

mikhailsidorov avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.