Builder.io Vue SDK

This is Builder's Gen2 Vue SDK.

Minimum supported version

The peerDependencies permit Vue >=3; Vue 2 is outside the installation range. The E2E-tested minimum is Vue 3.3.9; see the framework version matrix.

Getting Started

npm install @builder.io/sdk-vue

NOTE: if you are using Nuxt, you will need to add the SDK's Nuxt module in nuxt.config.js:

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  modules: ['@builder.io/sdk-vue/nuxt'],
});

CSS

If you are using a SSR framework other than Nuxt, you will need to manually import the CSS by adding the following to your entrypoint, before rendering Builder Content:

<script>
  import '@builder.io/sdk-vue/css';
</script>

Mitosis

This SDK is generated by Mitosis. To see the Mitosis source-code, go here.

Feature Support

To check the status of the SDK, look at these tables.

Fetch

This Package uses fetch. See these docs for more information.

Version Support

This SDK supports standalone Vue 3, or using Nuxt 3.

Usage

You can see examples of using Builder.io:

• with Vue 3 here
• with Nuxt 3 here
• with Nuxt 3 (using a catch-all route) here