diff --git a/README.md b/README.md index 865524d..79f5049 100644 --- a/README.md +++ b/README.md @@ -51,25 +51,54 @@ pnpm add nuxt-swiper import { defineNuxtModule } from 'nuxt' export default defineNuxtConfig({ - modules: ['nuxt-swiper'], + modules: ['nuxt-swiper'] swiper: { - modules: ['navigation', 'pagination'] + // Swiper options + //---------------------- + // prefix: 'Swiper', + // styleLang: 'css', + // modules: ['navigation', 'pagination'], } }) // or inline config export default defineNuxtConfig({ - modules: [ - [ - 'nuxt-swiper', - { - modules: ['navigation', 'pagination'] - } - ] - ] + modules: [['nuxt-swiper', { + // Swiper options + }]] }) ``` +## Usage + +```vue + +``` + ## Module Config Options ```ts @@ -126,7 +155,7 @@ interface SwiperModuleOptions { * '*' - imports all modules * '['autoplay', 'effect-cards', 'thumbs', 'lazy']' - imports only these modules to keep bundle size small * - * @default [] + * @default '*' */ modules?: SwiperModulesType[] | '*' } diff --git a/playground/app.vue b/playground/app.vue index a3c6fe8..26a1ffa 100644 --- a/playground/app.vue +++ b/playground/app.vue @@ -1,4 +1,6 @@