Vue

You can perform the following steps to add the SpreadJS Designer Component to a Vue application:

Vue 3

1. Create a Vue project by typing the following command in Command Prompt.

   npm init vue@latest

   The command will present prompts for the project name and other optional features that can be added to the Vue project.

2. Import the following SpreadJS and SpreadJS Designer Vue modules in the project.

   npm install @mescius/spread-sheets-designer
   npm install @mescius/spread-sheets-designer-resources-en
   npm install @mescius/spread-sheets-designer-vue
   npm install @mescius/spread-sheets
   npm install @mescius/spread-excelio
   npm install @mescius/spread-sheets-barcode
   npm install @mescius/spread-sheets-charts
   npm install @mescius/spread-sheets-languagepackages
   npm install @mescius/spread-sheets-print
   npm install @mescius/spread-sheets-pdf
   npm install @mescius/spread-sheets-shapes
   npm install @mescius/spread-sheets-pivot-addon
   npm install @mescius/spread-sheets-tablesheet

3. Register SpreadJS Designer Vue Component to the application in the main.js file.

   import { createApp } from 'vue'
   import App from './App.vue'
   import Designer from "@mescius/spread-sheets-designer-vue"
   let app = createApp(App);
   app.component("gc-spread-sheets-designer", Designer);
   app.mount('#app');

4. Add the SpreadJS Designer Vue Component to the application by modifying the App.vue file.

   <script setup>
   import '@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css';
   import "@mescius/spread-sheets-designer/styles/gc.spread.sheets.designer.min.css";
   import * as GC from "@mescius/spread-sheets";
   import "@mescius/spread-sheets-print";
   import "@mescius/spread-sheets-shapes";
   import "@mescius/spread-sheets-pivot-addon";
   import "@mescius/spread-sheets-tablesheet";
   import "@mescius/spread-sheets-designer-resources-en";
   import "@mescius/spread-sheets-designer";
   </script>
   <script>
   export default {
     name: "App",
     data: function () {
       return {
         styleInfo: { height: "98vh", width: "100%" },
         config: config,
         spreadOptions: {
           sheetCount: 2,
         },
         designer: null,
       };
     },
     methods: {
       designerInitialized(value) {
         this.designer = value;
       },
     },
   };
   </script>
   <template>
     <div id="gc-designer-container">
       <gc-spread-sheets-designer
         :styleInfo="styleInfo"
         :config="config"
         :spreadOptions="spreadOptions"
         @designerInitialized="designerInitialized"/>
     </div>
   </template>
   <style>
   </style>

5. Run the application.

   npm run dev

Vue 2

1. Create a Vue project by typing the following commands in Command Prompt.

   npm install -g @vue/cli
   npm i -g @vue/cli-init
   vue init webpack designercomponent
   cd designercomponent
   npm run dev

2. Import the following SpreadJS Vue modules in the project.

   npm install @mescius/spread-excelio
   npm install @mescius/spread-sheets
   npm install @mescius/spread-sheets-barcode
   npm install @mescius/spread-sheets-charts
   npm install @mescius/spread-sheets-languagepackages
   npm install @mescius/spread-sheets-pdf
   npm install @mescius/spread-sheets-print
   npm install @mescius/spread-sheets-shapes
   npm install @mescius/spread-sheets-tablesheet
   npm install @mescius/spread-sheets-pivot-addon
   npm install @mescius/spread-sheets-designer
   npm install @mescius/spread-sheets-designer-resources-en
   npm install @mescius/spread-sheets-vue
   npm install @mescius/spread-sheets-designer-vue

3. Import the required modules and add the designer tag into the template using the following code snippet in App.vue.

   <!--Add designer tag into the template-->
   <template>
     <div id="app">
       <gc-spread-sheets-designer :styleInfo='styleInfo'
                                  :config='config'
                                  @designerInitialized="designerInitialized">
       </gc-spread-sheets-designer>
     </div>
   </template>
   <script>
   // import the required modules
   import '@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css'
   import '@mescius/spread-sheets-designer/styles/gc.spread.sheets.designer.min.css'
   import '@mescius/spread-sheets-designer-resources-en'
   import '@mescius/spread-sheets-designer-vue'
   export default {
     name: 'App',
     data: function () {
       return {
         styleInfo: { height: '800px', width: '1200px', border: 'solid black 1px' },
         config: null,
         designer: null
       }
     },
     methods: {
       designerInitialized (value) {
         this.designer = value
       }
     }
   }
   </script>

4. Run the application.

   npm run dev

Apply License

The licensed version allows you to use all features of the SpreadJS Designer Component. You need to set the license key for SpreadJS, ExcelIO, and the Designer Component which can be done by using the following code snippet.

import '@mescius/spread-sheets-designer-resources-en'
import { Designer } from '@mescius/spread-sheets-designer-vue'
import * as GC from '@mescius/spread-sheets'
import * as ExcelIO from '@mescius/spread-excelio'
// license keys
var sjsLicense = 'sjs-distribution-key'
GC.Spread.Sheets.LicenseKey = sjsLicense
ExcelIO.LicenseKey = sjsLicense
GC.Spread.Sheets.Designer.LicenseKey = 'designer-component-distribution-key'