feat: add nuxtify config

Author: davidstackio

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "defu",
     "nuxtify",
     "nuxtifydev"
   ]

package-lock.json

@@ -31,6 +31,7 @@
   "dependencies": {
     "@mdi/js": "^7.4.47",
     "@nuxt/kit": "^3.16.1",
+    "defu": "^6.1.4",
     "vuetify-nuxt-module": "^0.18.4"
   },
   "devDependencies": {

package.json

@@ -1,11 +1,17 @@
+<script setup lang="ts">
+const nuxtifyConfig = useAppConfig().nuxtify
+</script>
+
 <template>
   <div>
     nuxtify-pages module playground!
     <v-btn>
       Test
     </v-btn>
   </div>
-</template>
 
-<script setup lang="ts">
-</script>
+  <h2>nuxtifyConfig</h2>
+  <pre>
+    {{ nuxtifyConfig }}
+  </pre>
+</template>

playground/app.vue

@@ -2,5 +2,9 @@ export default defineNuxtConfig({
   modules: ['../src/module'],
   devtools: { enabled: true },
   compatibilityDate: '2025-03-22',
-  myModule: {},
+  nuxtify: {
+    brand: {
+      name: 'nuxtify-pages-playground',
+    },
+  },
 })

playground/nuxt.config.ts

@@ -4,20 +4,33 @@ import {
   createResolver,
   installModule,
 } from '@nuxt/kit'
+import { defu } from 'defu'
 
-// Module options TypeScript interface definition
-export interface ModuleOptions {}
+// Types
+import type { ModuleOptions } from '../src/runtime/types'
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: 'nuxtify-pages',
     configKey: 'nuxtify',
     compatibility: {
       nuxt: '>=3.16.0',
+      bridge: false,
+    },
+  },
+  defaults: {
+    brand: {
+      name: 'nuxtify-pages',
+      domain: '',
+      tagline: '',
+      logo: {
+        lightUrl: '',
+        darkUrl: '',
+        width: 200,
+        mobileWidth: 150,
+      },
     },
   },
-  // Default configuration options of the Nuxt module
-  defaults: {},
   async setup(_options, _nuxt) {
     const resolver = createResolver(import.meta.url)
 
@@ -26,6 +39,11 @@ export default defineNuxtModule<ModuleOptions>({
       vuetifyOptions: resolver.resolve('./runtime/vuetify.config.ts'),
     })
 
+    // Expose module options to app config
+    _nuxt.options.appConfig.nuxtify = defu(_nuxt.options.appConfig.nuxtify, {
+      ..._options,
+    })
+
     // Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
     addPlugin(resolver.resolve('./runtime/plugin'))
   },

src/module.ts

@@ -0,0 +1,56 @@
+interface BrandOptions {
+  /**
+   * The name of the brand.
+   *
+   * @default "nuxtify-pages"
+   */
+  name?: string
+  /**
+   * The domain of the brand.
+   *
+   * @default ""
+   */
+  domain?: string
+  /**
+   * The tagline of the brand.
+   *
+   * @default ""
+   */
+  tagline?: string
+  /**
+   * The logo of the brand.
+   */
+  logo?: {
+    /**
+     * The URL of the light logo. Recommended 5:1 aspect ratio (e.g. 400 x 80 px).
+     *
+     * @default ""
+     */
+    lightUrl?: string
+    /**
+     * The URL of the dark logo. Recommended 5:1 aspect ratio (e.g. 400 x 80 px).
+     *
+     * @default ""
+     */
+    darkUrl?: string
+    /**
+     * The width of the logo.
+     *
+     * @default 200
+     */
+    width?: number
+    /**
+     * The width of the logo on mobile.
+     *
+     * @default 150
+     */
+    mobileWidth?: number
+  }
+}
+
+export interface ModuleOptions {
+  /**
+   * Brand options
+   */
+  brand?: BrandOptions
+}