Setup

This module is plug-and-play with sensible defaults. Just install the package to get started.

Installation

1. Install the nuxt-builderio package:

pnpm add -D nuxt-builderio

yarn add -D nuxt-builderio

npm install --save-dev nuxt-builderio

2. Add the nuxt-builderio package to the modules array in your nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    // ...
    'nuxt-builderio'
  ],
  // ...
})

Options

You may configure the nuxt-builderio module by adding a builderIO property to your nuxt.config.ts:

export default defineNuxtConfig({
  // Defaults
  builderIO: {
    autoImports: [
      'fetchEntries',
      'fetchOneEntry',
      'fetchBuilderProps',
      'isEditing',
      'isPreviewing',
      'setEditorSettings',
      'getBuilderSearchParams',
      'createRegisterComponentMessage'
    ],
    defaultModel: 'page',
    injectCss: true,
    components: {
      enabled: true,
      dir: 'builder/components',
      prefix: 'BuilderCustom'
    }
  }
  // ...
})

Learn more about the available options in the Configuration section.