Configuration

Module options are supplied through the prismic property in your Nuxt config.

nuxt.config.ts
import { defineNuxtConfig } from 'nuxt3'

export default defineNuxtConfig({
    prismic: {
        /* configuration */
    },
});
Interface
type PrismicModuleOptions = PrismicPluginOptions & {
    client?: string;
    linkResolver?: string;
    richTextSerializer?: string;
    preview?: string | false;
    toolbar?: boolean;
}
Defaults
{
    client: '~/app/prismic/client',
    linkResolver: '~/app/prismic/linkResolver',
    richTextSerializer: '~/app/prismic/richTextSerializer',
    injectComponents: true,
    preview: '/preview',
    toolbar: true
}

Overview

KeyTypeDefaultDescription
...PrismicPluginOptionsobject{}Options provided to Prismic Vue plugin, see section below for more details.
clientstring~/app/prismic/clientPath to an optional file exporting an @prismicio/client instance for the module to use.
linkResolverstring~/app/prismic/linkResolverPath to an optional file exporting a Link Resolver for the module to use.
richTextSerializerstring~/app/prismic/richTextSerializerPath to an optional file exporting a HTML Serializer for the module to use.
previewstring | false/previewThe route to use for the preview page, disable previews with false.
toolbarbooleantrueWhether or not to inject Prismic toolbar, required for previews to work properly.

...PrismicPluginOptions

This module is essentially a drop-in integration of @prismicio/vue plugin, fine-tuned for Nuxt. In that regard it inherits from most of @prismicio/vue options. Please refer to @prismicio/vue documentation to discover available options inherited from the plugin.

⚠  client, linkResolver, and richTextSerializer options are replaced, see above.
Edit this page on GitHub