Nuxt Nation 大会即将到来。加入我们,时间为 11 月 12 日至 13 日。

aos
nuxt-aos

一个为 Nuxt 添加滚动动画的模块

Nuxt Aos

npm versionnpm downloadsLicenseNuxt

一个用于为您的应用程序添加滚动动画的 Nuxt 模块。

特性

  • ⛰  轻松地将滚动动画库添加到您的 Nuxt 应用程序中

快速设置

  1. nuxt-aos 依赖项添加到您的项目中
npx nuxi@latest module add aos
  1. (可选) 将 aos 配置添加到 nuxt.config.js 中,向下滚动以获取更多信息。

That's it! You can now use Aos in your Nuxt app on every page 🚀

For example:

```html
<div data-aos="fade-up"></div>

可在 https://michalsnik.github.io/aos/ 找到可用动画列表。

开发

# Install dependencies
yarn install

# Generate type stubs
yarn run dev:prepare

# Develop with the playground
yarn run dev

# Build the playground
yarn run dev:build

# Run ESLint
yarn run lint

# Run Vitest
yarn run test
yarn run test:watch

# Release new version
yarn run release

配置

您可以在 nuxt.config.js 中使用 aos 配置 nuxt-aos

export default defineNuxtConfig({
  aos: {
    // Global settings:
    disable: false, // accepts following values: 'phone', 'tablet', 'mobile', boolean, expression or function
    startEvent: 'DOMContentLoaded', // name of the event dispatched on the document, that AOS should initialize on
    initClassName: 'aos-init', // class applied after initialization
    animatedClassName: 'aos-animate', // class applied on animation
    useClassNames: false, // if true, will add content of `data-aos` as classes on scroll
    disableMutationObserver: false, // disables automatic mutations' detections (advanced)
    debounceDelay: 50, // the delay on debounce used while resizing window (advanced)
    throttleDelay: 99, // the delay on throttle used while scrolling the page (advanced)

    // Settings that can be overridden on per-element basis, by `data-aos-*` attributes:
    offset: 120, // offset (in px) from the original trigger point
    delay: 0, // values from 0 to 3000, with step 50ms
    duration: 400, // values from 0 to 3000, with step 50ms
    easing: 'ease', // default easing for AOS animations
    once: false, // whether animation should happen only once - while scrolling down
    mirror: false, // whether elements should animate out while scrolling past them
    anchorPlacement: 'top-bottom', // defines which position of the element regarding to window should trigger the animation
  }
})

API

您还可以使用 AOS API,目前有两种方法可用

const { $refreshAos, $refreshHardAos } = useNuxtApp()

$refreshAos()

$refreshHardAos()

详情请参考 AOS API