feat(module): pass options to init method of aos

package.json

@@ -37,10 +37,11 @@
     "@nuxt/module-builder": "^0.4.0",
     "@nuxt/schema": "^3.6.5",
     "@nuxt/test-utils": "^3.6.5",
+    "@types/aos": "^3.0.4",
     "@types/node": "^18.17.3",
     "changelogen": "^0.5.4",
     "eslint": "^8.46.0",
     "nuxt": "^3.6.5",
     "vitest": "^0.34.1"
   }
-}
+}

src/module.ts

@@ -1,15 +1,27 @@
-import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit'
+import { defineNuxtModule, addPlugin, createResolver } from "@nuxt/kit";
+import { name, version } from "../package.json";
+import { AosOptions } from "aos";
 
-export interface ModuleOptions {}
+export interface ModuleOptions {
+  options?: AosOptions;
+}
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
-    name: 'nuxt-aos',
+    name,
+    version,
+    configKey: "aos",
   },
-  defaults: {},
-  setup () {
-    const resolver = createResolver(import.meta.url)
+  defaults: {
+    options: {},
+  },
+  setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+
+    // Get runtimeConfig & add aos to it so we can access it in plugin
+    const config = useRuntimeConfig();
+    config.public.aos = options.options;
 
-    addPlugin(resolver.resolve('./runtime/plugin'))
-  }
-})
+    addPlugin(resolver.resolve("./runtime/plugin"));
+  },
+});

src/runtime/plugin.ts

@@ -1,10 +1,11 @@
-import { defineNuxtPlugin } from '#app'
+import { defineNuxtPlugin } from "#app";
 
-import AOS from "aos"
-import "aos/dist/aos.css"
+import AOS from "aos";
+import "aos/dist/aos.css";
 
 export default defineNuxtPlugin((nuxtApp) => {
+  const config = useRuntimeConfig();
   if (typeof window !== "undefined") {
-    nuxtApp.AOS = AOS.init()
+    nuxtApp.AOS = AOS.init(config.public?.aos || {});
   }
-})
+});

yarn.lock

@@ -1169,6 +1169,11 @@
     "@tufjs/canonical-json" "1.0.0"
     minimatch "^9.0.0"
 
+"@types/aos@^3.0.4":
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/@types/aos/-/aos-3.0.4.tgz#fd0dce430f18d118081aaced2c79c30617b15818"
+  integrity sha512-mna6Jd6bdK1NpwarLopGvXOgUoCfj0470IwLxuVOFDElTGI0JTd7xSGQ0AjbAEnHErC/b3fA9t2uB3IXVKmckA==
+
 "@types/chai-subset@^1.3.3":
   version "1.3.3"
   resolved "https://registry.yarnpkg.com/@types/chai-subset/-/chai-subset-1.3.3.tgz#97893814e92abd2c534de422cb377e0e0bdaac94"