Merge pull request #3 from surveyjs/nuxt3-migration

Migrate to Nuxt 3

Author: RomanTsukanov

.editorconfig

@@ -1,69 +1,37 @@
-# Y
+# SurveyJS Form Builder + Nuxt Demo Example
 
-## Build Setup
+This demo shows how to add [SurveyJS Form Builder / Survey Creator](https://surveyjs.io/survey-creator/documentation/overview) to a Nuxt application.
 
-```bash
-# install dependencies
-$ npm install
-
-# serve with hot reload at localhost:3000
-$ npm run dev
-
-# build for production and launch server
-$ npm run build
-$ npm run start
+## Run the Application
 
-# generate static project
-$ npm run generate
+```bash
+git clone https://github.com/surveyjs/surveyjs-nuxtjs.git
+cd surveyjs-nuxtjs
+npm i
+npm run dev
 ```
 
-For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org).
-
-## Special Directories
-
-You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality.
-
-### `assets`
-
-The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).
-
-### `components`
-
-The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).
-
-### `layouts`
-
-Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).
-
-
-### `pages`
-
-This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).
-
-### `plugins`
-
-The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).
-
-### `static`
+Open http://localhost:3000 in your web browser.
 
-This directory contains your static files. Each file inside this directory is mapped to `/`.
+## How to add SurveyJS Form Builder to your Nuxt application 
 
-Example: `/static/robots.txt` is mapped as `/robots.txt`.
 
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).
+1. Install the `survey-creator-vue` npm package:
+   
+    ```bash
+    npm install survey-creator-vue --save
+    ```
 
-### `store`
+2. Create a file in the [`plugins`](./plugins/) directory and install SurveyJS Vue plugins in this file using the `nuxtApp.vueApp.use()` method.
+3. Open the [`next.config.ts`](./nuxt.config.ts) file and do the following in it:
+   1. List the plugin file in the `plugins` array.
+   2. List SurveyJS style sheets in the `css` array.
+4. Create a component and configure Survey Creator in it (see the [`components/SurveyCreator.vue`](./components/SurveyCreator.vue) file).
+5. Add the component to a page (see the [`app.vue`](./app.vue) file). In this example, the component is wrapped in the `<ClientOnly>` tag because Survey Creator uses `localStorage` to save and restore survey JSON schemas. If your application doesn't use this functionality, you can render Survey Creator on the server.
 
-This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.
+## SurveyJS Resources
 
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).
+- [Website](https://surveyjs.io/)
+- [Documentation](https://surveyjs.io/survey-creator/documentation/overview)
+- [Starter Demos](https://surveyjs.io/survey-creator/examples/free-nps-survey-template/reactjs)
+- [What's New](https://surveyjs.io/stay-updated/major-updates/2023)

README.md

@@ -0,0 +1,18 @@
+<template>
+  <div id="surveyCreator">
+    <ClientOnly fallback-tag="div" fallback="Loading Survey Creator...">
+      <SurveyCreator />
+    </ClientOnly>
+  </div>
+</template>
+
+<style>
+#surveyCreator {
+  height: 100vh;
+  width: 100vw;
+}
+
+body {
+  margin: 0;
+}
+</style>

app.vue

@@ -1,40 +1,35 @@
-<template>
-  <div id="surveyCreator"></div>
-</template>
-
-<script>
-import { SurveyCreator } from "survey-creator-knockout";
-import "survey-core/defaultV2.min.css";
-import "survey-creator-core/survey-creator-core.min.css";
-
-import { Serializer } from "survey-core";
+<script setup lang="ts">
+import type { ICreatorOptions } from "survey-creator-core";
+import { SurveyCreatorModel } from "survey-creator-core";
 
-Serializer.addProperty("question", "tag:number");
+const creatorOptions: ICreatorOptions = {
+  showLogicTab: true,
+  isAutoSave: true
+};
 
-export default {
-  name: "survey-creator",
-  data() {
-    return {};
-  },
-  mounted() {
-    const creatorOptions = {
-      showLogicTab: true,
-      isAutoSave: true
-    };
-    const creator = new SurveyCreator(creatorOptions);
+const defaultJson = {
+  pages: [{
+    name: "Name",
+    elements: [{
+      name: "FirstName",
+      title: "Enter your first name:",
+      type: "text"
+    }, {
+      name: "LastName",
+      title: "Enter your last name:",
+      type: "text"
+    }]
+  }]
+};
 
-    creator.saveSurveyFunc = function() {
-      console.log(JSON.stringify(this.text));
-    };
-    creator.render("surveyCreator");
-  }
-  
+const creator = new SurveyCreatorModel(creatorOptions);
+creator.text = window.localStorage.getItem("survey-json") || JSON.stringify(defaultJson);
+creator.saveSurveyFunc = (saveNo: number, callback: Function) => { 
+  window.localStorage.setItem("survey-json", creator.text);
+  callback(saveNo, true);
 };
 </script>
 
-<style scoped>
-#surveyCreator {
-  height: 100vh;
-  width: 100vw;
-}
-</style>
+<template>
+  <SurveyCreatorComponent :model="creator" />
+</template>

components/NuxtLogo.vue

@@ -0,0 +1,10 @@
+// https://nuxt.com/docs/api/configuration/nuxt-config
+export default defineNuxtConfig({
+  compatibilityDate: '2024-04-03',
+  devtools: { enabled: true },
+  css: [
+    'survey-core/defaultV2.min.css',
+    'survey-creator-core/survey-creator-core.min.css'
+  ],
+  plugins: ['~/plugins/surveyjs-form-builder.client.ts']
+})