- Prerequisites
- Setup the Vite project
- Adding Syncfusion Vue packages
- Import Syncfusion CSS styles
- Adding Syncfusion Vue Tab component in the application
- Run the project
- See also
Contact Support
Getting Started with Syncfusion Vue Tab Component in Vue 3
11 Jun 202414 minutes to read
This article provides a step-by-step guide for setting up a Vite project with a JavaScript environment and integrating the Syncfusion Vue Tab component using the Composition API / Options API.
The Composition API
is a new feature introduced in Vue.js 3 that provides an alternative way to organize and reuse component logic. It allows developers to write components as functions that use smaller, reusable functions called composition functions to manage their properties and behavior.
The Options API
is the traditional way of writing Vue.js components, where the component logic is organized into a series of options that define the component’s properties and behavior. These options include data, methods, computed properties, watchers, lifecycle hooks, and more.
Prerequisites
System requirements for Syncfusion Vue UI components
Setup the Vite project
A recommended approach for beginning with Vue is to scaffold a project using Vite. To create a new Vite project, use one of the commands that are specific to either NPM or Yarn.
npm create vite@latest
or
yarn create vite
Using one of the above commands will lead you to set up additional configurations for the project as below:
1.Define the project name: We can specify the name of the project directly. Let’s specify the name of the project as my-project
for this article.
? Project name: » my-project
2.Select Vue
as the framework. It will creates a Vue 3 project.
? Select a framework: » - Use arrow-keys. Return to submit.
Vanilla
> Vue
React
Preact
Lit
Svelte
Others
3.Choose JavaScript
as framework variant to build this Vite project using JavaScript and Vue.
? Select a variant: » - Use arrow-keys. Return to submit.
> JavaScript
TypeScript
Customize with create-vue ↗
Nuxt ↗
4.Upon completing the aforementioned steps to create the my-project
, run the following command to install its dependencies:
cd my-project
npm install
or
cd my-project
yarn install
Now that my-project
is ready to run with default settings, let’s add Syncfusion Vue Tab component to the project.
Adding Syncfusion Vue packages
Syncfusion Vue component packages are available at npmjs.com. To use Syncfusion Vue components in the project, install the corresponding npm package.
This article uses the Vue Tab component as an example. To use the Vue Tab
component in the project, the @syncfusion/ej2-vue-navigations
package needs to be installed using the following command.
npm install @syncfusion/ej2-vue-navigations --save
or
yarn add @syncfusion/ej2-vue-navigations
Import Syncfusion CSS styles
You can import themes for the Syncfusion Vue component in various ways, such as using CSS or SASS styles from npm packages, CDN, CRG and Theme Studio. Refer to themes topic to know more about built-in themes and different ways to refer to themes in a Vue project.
In this article, Material
theme is applied using CSS styles, which are available in installed packages. The necessary Material
CSS styles for the Tab component and its dependents were imported into the <style>
section of the src/App.vue file.
<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-navigations/styles/material.css";
</style>
Adding Syncfusion Vue Tab component in the application
Follow the below steps to add the Vue Tab component using Composition API
:
1.First, import and register the Tab component and its child directives in the script
section of the src/App.vue file. If you are using the Composition API
, you should add the setup
attribute to the script
tag to indicate that Vue will be using the Composition API
.
<script setup>
import {
TabComponent as EjsTab, TabItemsDirective as ETabitems, TabItemDirective as ETabitem
} from "@syncfusion/ej2-vue-navigations";
</script>
<script>
import {
TabComponent,
TabItemDirective,
TabItemsDirective
} from "@syncfusion/ej2-vue-navigations";
export default {
name: "App",
components: {
"ejs-tab": TabComponent,
"e-tabitem": TabItemDirective,
"e-tabitems": TabItemsDirective
}
}
</script>
2.Add the component definition in template section.
<template>
<ejs-tab id="tab">
<e-tabitems>
<e-tabitem :header="headerText0" :content="content0"></e-tabitem>
<e-tabitem :header="headerText1" :content="content1"></e-tabitem>
<e-tabitem :header="headerText2" :content="content2"></e-tabitem>
</e-tabitems>
</ejs-tab>
</template>
3.Declare the properties for Tab component.
<script setup>
const headerText0 = { text: "ASP.NET" };
const headerText1 = { text: "ASP.NET MVC" };
const headerText2 = { text: "JavaScript" };
const content0 =
"ASP.NET is an open-source server-side web application framework designed for web development to produce " +
"dynamic web pages. It was developed by Microsoft to allow programmers to build dynamic web sites, web applications " +
"and web services. It was first released in January 2002 with version 1.0 of the .NET Framework, and is the successor " +
"to Microsoft's Active Server Pages (ASP) technology. ASP.NET is built on the Common Language Runtime (CLR), allowing " +
"programmers to write ASP.NET code using any supported .NET language. The ASP.NET SOAP extension framework allows " +
"ASP.NET components to process SOAP messages.";
const content1 =
"The ASP.NET MVC is a web application framework developed by Microsoft, which implements the " +
"model–view–controller (MVC) pattern. It is open-source software, apart from the ASP.NET Web Forms component which is " +
"proprietary. In the later versions of ASP.NET, ASP.NET MVC, ASP.NET Web API, and ASP.NET Web Pages (a platform using " +
"only Razor pages) will merge into a unified MVC 6.The project is called ASP.NET vNext.";
const content2 =
"JavaScript (JS) is an interpreted computer programming language. It was originally implemented as " +
"part of web browsers so that client-side scripts could interact with the user, control the browser, communicate " +
"asynchronously, and alter the document content that was displayed.[5] More recently, however, it has become common in " +
"both game development and the creation of desktop applications.";
</script>
<script>
data: function() {
return {
headerText0: { text: "ASP.NET" },
headerText1: { text: "ASP.NET MVC" },
headerText2: { text: "JavaScript" },
content0: "ASP.NET is an open-source server-side web application framework designed for web development to produce " +
"dynamic web pages. It was developed by Microsoft to allow programmers to build dynamic web sites, web applications " +
"and web services. It was first released in January 2002 with version 1.0 of the .NET Framework, and is the successor " +
"to Microsoft's Active Server Pages (ASP) technology. ASP.NET is built on the Common Language Runtime (CLR), allowing " +
"programmers to write ASP.NET code using any supported .NET language. The ASP.NET SOAP extension framework allows " +
"ASP.NET components to process SOAP messages.",
content1: "The ASP.NET MVC is a web application framework developed by Microsoft, which implements the " +
"model–view–controller (MVC) pattern. It is open-source software, apart from the ASP.NET Web Forms component which is " +
"proprietary. In the later versions of ASP.NET, ASP.NET MVC, ASP.NET Web API, and ASP.NET Web Pages (a platform using " +
"only Razor pages) will merge into a unified MVC 6.The project is called ASP.NET vNext.",
content2: "JavaScript (JS) is an interpreted computer programming language. It was originally implemented as " +
"part of web browsers so that client-side scripts could interact with the user, control the browser, communicate " +
"asynchronously, and alter the document content that was displayed.[5] More recently, however, it has become common in " +
"both game development and the creation of desktop applications."
}
}
</script>
Here is the summarized code for the above steps in the src/App.vue file:
<template>
<ejs-tab id="tab">
<e-tabitems>
<e-tabitem :header="headerText0" :content="content0"></e-tabitem>
<e-tabitem :header="headerText1" :content="content1"></e-tabitem>
<e-tabitem :header="headerText2" :content="content2"></e-tabitem>
</e-tabitems>
</ejs-tab>
</template>
<script setup>
import {
TabComponent as EjsTab, TabItemsDirective as ETabitems, TabItemDirective as ETabitem
} from "@syncfusion/ej2-vue-navigations";
const headerText0 = { text: "ASP.NET" };
const headerText1 = { text: "ASP.NET MVC" };
const headerText2 = { text: "JavaScript" };
const content0 =
"ASP.NET is an open-source server-side web application framework designed for web development to produce " +
"dynamic web pages. It was developed by Microsoft to allow programmers to build dynamic web sites, web applications " +
"and web services. It was first released in January 2002 with version 1.0 of the .NET Framework, and is the successor " +
"to Microsoft's Active Server Pages (ASP) technology. ASP.NET is built on the Common Language Runtime (CLR), allowing " +
"programmers to write ASP.NET code using any supported .NET language. The ASP.NET SOAP extension framework allows " +
"ASP.NET components to process SOAP messages.";
const content1 =
"The ASP.NET MVC is a web application framework developed by Microsoft, which implements the " +
"model–view–controller (MVC) pattern. It is open-source software, apart from the ASP.NET Web Forms component which is " +
"proprietary. In the later versions of ASP.NET, ASP.NET MVC, ASP.NET Web API, and ASP.NET Web Pages (a platform using " +
"only Razor pages) will merge into a unified MVC 6.The project is called ASP.NET vNext.";
const content2 =
"JavaScript (JS) is an interpreted computer programming language. It was originally implemented as " +
"part of web browsers so that client-side scripts could interact with the user, control the browser, communicate " +
"asynchronously, and alter the document content that was displayed.[5] More recently, however, it has become common in " +
"both game development and the creation of desktop applications.";
</script>
<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-navigations/styles/material.css";
</style>
<template>
<ejs-tab id="tab">
<e-tabitems>
<e-tabitem :header="headerText0" :content="content0"></e-tabitem>
<e-tabitem :header="headerText1" :content="content1"></e-tabitem>
<e-tabitem :header="headerText2" :content="content2"></e-tabitem>
</e-tabitems>
</ejs-tab>
</template>
<script>
import {
TabComponent,
TabItemDirective,
TabItemsDirective,
} from "@syncfusion/ej2-vue-navigations";
export default {
name: "App",
components: {
"ejs-tab": TabComponent,
"e-tabitem": TabItemDirective,
"e-tabitems": TabItemsDirective
},
data: function () {
return {
headerText0: { text: "ASP.NET" },
headerText1: { text: "ASP.NET MVC" },
headerText2: { text: "JavaScript" },
content0: "ASP.NET is an open-source server-side web application framework designed for web development to produce " +
"dynamic web pages. It was developed by Microsoft to allow programmers to build dynamic web sites, web applications " +
"and web services. It was first released in January 2002 with version 1.0 of the .NET Framework, and is the successor " +
"to Microsoft's Active Server Pages (ASP) technology. ASP.NET is built on the Common Language Runtime (CLR), allowing " +
"programmers to write ASP.NET code using any supported .NET language. The ASP.NET SOAP extension framework allows " +
"ASP.NET components to process SOAP messages.",
content1: "The ASP.NET MVC is a web application framework developed by Microsoft, which implements the " +
"model–view–controller (MVC) pattern. It is open-source software, apart from the ASP.NET Web Forms component which is " +
"proprietary. In the later versions of ASP.NET, ASP.NET MVC, ASP.NET Web API, and ASP.NET Web Pages (a platform using " +
"only Razor pages) will merge into a unified MVC 6.The project is called ASP.NET vNext.",
content2: "JavaScript (JS) is an interpreted computer programming language. It was originally implemented as " +
"part of web browsers so that client-side scripts could interact with the user, control the browser, communicate " +
"asynchronously, and alter the document content that was displayed.[5] More recently, however, it has become common in " +
"both game development and the creation of desktop applications."
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-navigations/styles/material.css";
</style>
Run the project
To run the project, use the following command:
npm run dev
or
yarn run dev
The output will appear as follows:
Refer the sample Vue 3 using Composition API Tab getting started
For migrating from Vue 2 to Vue 3, refer to the migration
documentation.