diff --git a/Document-Processing/Excel/Spreadsheet/Vue/images/syncfusion-cli.png b/Document-Processing/Excel/Spreadsheet/Vue/images/syncfusion-cli.png new file mode 100644 index 0000000000..c5b98c5795 Binary files /dev/null and b/Document-Processing/Excel/Spreadsheet/Vue/images/syncfusion-cli.png differ diff --git a/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md b/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md index e3b7f3368c..a7e86ea4b1 100644 --- a/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md +++ b/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md @@ -11,6 +11,92 @@ documentation: ug This article provides a step-by-step guide for setting up a [Vite](https://vitejs.dev/) project with a JavaScript environment and integrating the [Vue Spreadsheet Editor](https://www.syncfusion.com/spreadsheet-editor-sdk/vue-spreadsheet-editor) component using the [Composition API](https://vuejs.org/guide/introduction.html#composition-api) / [Options API](https://vuejs.org/guide/introduction.html#options-api). +{% tabcontents %} +{% tabcontent Syncfusion CLI %} + +## Prerequisites + +- [Node.js 24+](https://nodejs.org/en) (LTS recommended). +- Syncfusion CLI. + +## Install the Syncfusion CLI + +Install the Syncfusion CLI globally using the following command: + +{% tabs %} +{% highlight bash tabtitle="npm" %} +npm install -g @syncfusion/syncfusion-cli +{% endhighlight %} +{% endtabs %} + +## Set up the Vite project using Syncfusion CLI + +You can create a Vue application with [Vite](https://vite.dev/) using the Syncfusion CLI. The CLI provides two ways to create a project: + +### Non-interactive mode + +Non-interactive mode allows you to create a project directly using a single command with the required command-line arguments. + +{% tabs %} +{% highlight bash tabtitle="CMD" %} +sf new my-project --framework vue --template spreadsheet-editor +{% endhighlight %} +{% endtabs %} + +In this mode, the project configuration is passed directly in the command. The above command creates a `Vue` application with Vite and configured it with the Syncfusion® `Spreadsheet Editor` component. The generated project uses the TypeScript and the Composition API. + +### Interactive mode + +Interactive mode guides you through the project creation process with step-by-step prompts. + +{% tabs %} +{% highlight bash tabtitle="CMD" %} +sf +{% endhighlight %} +{% endtabs %} + +When you run the `sf` command, the CLI prompts you to select the required project configuration options. To create a Vue application with Vite and the Syncfusion® `Spreadsheet Editor` component, select the following options: + +{% tabs %} +{% highlight bash tabtitle="CMD" %} + +√ Project name? ... my-project +√ Choose Framework: » Vue +√ Choose Language: » TypeScript +√ Choose Template: » Spreadsheet Editor +√ Choose Theme: » Material3 +√ Choose Style Format: » CSS +√ Would you like to integrate the Syncfusion MCP Server (AI Assistant) into this project? ... no +√ Would you like to install Syncfusion Component Skills for AI-powered development? ... no +√ Install dependencies and start app now? ... no + +{% endhighlight %} +{% endtabs %} + +The above selections generate a `Vue` application with Vite and configure it with the Syncfusion® `Spreadsheet Editor` component. You can choose different values for language, theme, style format, MCP setup, and skills installation based on your project requirements. + +The Syncfusion® CLI creates the project with a predefined template. After the project is generated, you can customize or replace the component code based on your application requirements. + +## Run the project + +Once the project is created, navigate to the project directory and run the following commands in your terminal. + +{% tabs %} +{% highlight bash tabtitle="CMD" %} +cd my-project +npm install +npm run dev +{% endhighlight %} +{% endtabs %} + +The output will appear as follows: + +![Spreadsheet Editor](./images/syncfusion-cli.png) + +{% endtabcontent %} + +{% tabcontent Vite CLI %} + ## Prerequisites [System requirements for Vue components](https://ej2.syncfusion.com/vue/documentation/system-requirements) @@ -120,6 +206,10 @@ After the application starts, open the localhost URL shown in the terminal to vi ![Output](images/vue3-spreadsheet.png) +{% endtabcontent %} + +{% endtabcontents %} + > [View Sample in GitHub](https://github.com/SyncfusionExamples/getting-started-with-the-vue-spreadsheet-component). N> Looking for the full Vue Spreadsheet component overview, features, pricing, and documentation? Visit the [Vue Spreadsheet Editor](https://www.syncfusion.com/spreadsheet-editor-sdk/vue-spreadsheet-editor) page.