Vue

Introduction

System Requirements

Deployment

Browser Compatibility

API Reference

Release Notes

Getting Started

Installation and Upgrade

Upgrade

Licensing

Appearance

Common

Visual Studio Code Integration

Accordion

Accumulation Chart

AppBar

AutoComplete

Avatar

Badge

Barcode

Breadcrumb

Bullet Chart

Button

ButtonGroup

Calendar

Card

Carousel

Chart

CheckBox

Chips

Circular Gauge

Color Picker

ComboBox

ContextMenu

Dashboard Layout

DatePicker

DateRangePicker

DateTimePicker

Diagram

Dialog

DocumentEditor

DropDownButton

DropDownList

Dropdown Tree

FileManager

FloatingActionButton

Form Validator

Gantt

Grid

HeatMap Chart

ImageEditor

InPlaceEditor

Kanban

Linear Gauge

ListBox

ListView

Maps

MaskedTextBox

Mention

Menu Bar

Message

MultiSelect

NumericTextBox

Pager

PDF Viewer

Pivot Table

Predefined Dialogs

ProgressButton

ProgressBar

QueryBuilder

RadioButton

Range Navigator

Range Slider

Rating

RichTextEditor

Schedule

Sidebar

Signature

Skeleton

Smith Chart

Sparkline

SpeedDial

Spinner

SplitButton

Splitter

Spreadsheet

Stock Chart

Switch

Tabs

TextBox

TimePicker

Toast

Toolbar

Tooltip

TreeGrid

TreeMap

TreeView

Uploader

/ Getting Started / Vue 3 with TS and Composition API

Search results

Getting Started with Syncfusion Vue UI Components in TypeScript with the Composition API

20 Mar 2023 / 7 minutes to read

This section offers a step-by-step guide for setting up a Vite project with a TypeScript environment and integrating the Syncfusion Vue components with the Composition API effectively. If you need information on getting started with the Vue Options API, follow this link.

Prerequisites

System requirements for Syncfusion Vue UI components

Set up the Vite project

A recommended approach for beginning with Vue is to scaffold a project using Vite. To create a new Vite project, you can execute one of the commands that are specific to either NPM or Yarn.

npm create vite@latest

or

yarn create vite

Executing one of the above commands will lead you to set up additional configurations for the project:

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

Select Vue as the framework.

? Select a framework: » - Use arrow-keys. Return to submit.
  Vanilla
> Vue
  React
  Preact
  Lit
  Svelte
  Others

Choose TypeScript as framework variant to build this Vite project using TypeScript and Vue.

? Select a variant: » - Use arrow-keys. Return to submit.
  JavaScript
> TypeScript
  Customize with create-vue ↗
  Nuxt ↗

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 components to the project.

Add Syncfusion packages to the project

In order to proceed, install the required Syncfusion Vue component package from the public npmjs.com registry.

This article utilizes the Schedule component as an example. So, run the below command to install the Syncfusion Schedule component package.

npm install @syncfusion/ej2-vue-schedule --save

or

yarn add @syncfusion/ej2-vue-schedule

Import the Syncfusion styles

Once you have installed the Syncfusion component packages, you will need to import the necessary themes based on the components.

Syncfusion Vue component comes with built-in themes, which are available in installed packages. It is quite simple to adapt the Syncfusion Vue components based on the project style by referring to any of the built-in themes.

To add the styles, you can reference the CSS or SASS files of the Syncfusion Vue components as follows:

Import CSS styles

To import the necessary CSS styles for the Schedule component, as well as its dependent styles, into the src/App.vue file, you can use the provided code snippet within the <style> section. Let’s import the Material theme for the Schedule component.

<style>
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-calendars/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-vue-schedule/styles/material.css';
</style>

Import SASS styles

Run the below command to add the SASS package in order to use SCSS styles for the Schedule component and its dependencies in this project.

npm install sass

or

yarn add sass

Then, within the <style> section of the src/App.vue file, import the necessary styles and specify the language as SCSS using the lang attribute. Let’s import the Material theme for the Schedule component.

<style lang="scss">
  @import '../node_modules/@syncfusion/ej2-base/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-buttons/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-calendars/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-inputs/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-navigations/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-popups/styles/material.scss';
  @import '../node_modules/@syncfusion/ej2-vue-schedule/styles/material.scss';
</style>

To make use of SASS files in a Vite project, add the following configuration setup to the vite.config.js file.

export default defineConfig({
  plugins: [vue()],
  css: {
preprocessorOptions: {
  scss: {
    includePaths: ["node_modules/@syncfusion"]
  }
}
  }
})

You can checkout the themes topic to know more about built-in themes and different ways to refer themes in Vue project.

Integrate the Syncfusion Vue component to the project

Once we have finished all the essential configurations for rendering the Syncfusion Vue component with the Composition API in your Vite project, proceed with the following steps to add the Schedule component:

First, add the setup attribute to the script tag to indicate that Vue will be using the Composition API. And import the Schedule component in the script section of the src/App.vue file.

<script setup>
  import { ScheduleComponent as EjsSchedule, ViewsDirective as EViews, ViewDirective as EView, ResourcesDirective as EResources, ResourceDirective as EResource, EventSettingsModel, Day, Week, WorkWeek, Month, Agenda, DragAndDrop, Resize } from "@syncfusion/ej2-vue-schedule";
</script>

In the template section, define the Schedule component with appointments. To populate the empty Scheduler with appointments, define either the local JSON data or remote data through the dataSource property available within the eventSettings option. Additionally, it is necessary to include the start and end time fields to define any appointments.

<template>
  <div id='app'>
<ejs-schedule height='550px' width='100%' :selectedDate='selectedDate' :eventSettings='eventSettings'>
  <e-views>
    <e-view option='Day'></e-view>
    <e-view option='Week' startHour='07:00' endHour='15:00'></e-view>
    <e-view option='WorkWeek' startHour='10:00' endHour='18:00'></e-view>
    <e-view option='Month' showWeekend=false></e-view>
    <e-view option='Agenda'></e-view>
  </e-views>
  <e-resources>
    <e-resource field="OwnerId" title="Owner" name="Owners" :dataSource="ownerDataSource" textField="OwnerText"
      idField="Id" colorField="OwnerColor">
    </e-resource>
  </e-resources>
</ejs-schedule>
  </div>
</template>

Declare the values for the dataSource property in the script section.

<script setup>
const eventSettings: EventSettingsModel = {
  dataSource: [
{
  Id: 1,
  Subject: 'Surgery - Andrew',
  EventType: 'Confirmed',
  StartTime: new Date(2021, 7, 10, 9, 0),
  EndTime: new Date(2021, 7, 10, 10, 0),
  OwnerId: 2
},
{
  Id: 2,
  Subject: 'Consulting - John',
  EventType: 'Confirmed',
  StartTime: new Date(2021, 7, 11, 10, 0),
  EndTime: new Date(2021, 7, 11, 11, 30),
  OwnerId: 3
},
{
  Id: 3,
  Subject: 'Therapy - Robert',
  EventType: 'Requested',
  StartTime: new Date(2021, 7, 12, 11, 30),
  EndTime: new Date(2021, 7, 12, 12, 30),
  OwnerId: 1
}
  ]
};
</script>

To generate a Schedule with particular views, need to inject the relevant modules into the Schedule. This can be accomplished by utilizing the provide method within the src/App.vue file.

<script setup lang="ts">
  import { provide } from "vue";
  provide('schedule', [Day, Week, WorkWeek, Month, Agenda, DragAndDrop, Resize]);
</script>

The src/App.vue file contains the summarized code for the above steps.

<template>
  <div id='app'>
<ejs-schedule height='550px' width='100%' :selectedDate='selectedDate' :eventSettings='eventSettings'>
  <e-views>
    <e-view option='Day'></e-view>
    <e-view option='Week' startHour='07:00' endHour='15:00'></e-view>
    <e-view option='WorkWeek' startHour='10:00' endHour='18:00'></e-view>
    <e-view option='Month' showWeekend=false></e-view>
    <e-view option='Agenda'></e-view>
  </e-views>
  <e-resources>
    <e-resource field="OwnerId" title="Owner" name="Owners" :dataSource="ownerDataSource" textField="OwnerText"
      idField="Id" colorField="OwnerColor">
    </e-resource>
  </e-resources>
</ejs-schedule>
  </div>
</template>

<script setup lang="ts">
import { ScheduleComponent as EjsSchedule, Day, Week, WorkWeek, Month, Agenda, DragAndDrop, Resize, ViewsDirective as EViews, ViewDirective as EView, ResourcesDirective as EResources, ResourceDirective as EResource } from "@syncfusion/ej2-vue-schedule";
import { provide } from "vue";

provide('schedule', [Day, Week, WorkWeek, Month, Agenda, DragAndDrop, Resize]);

const selectedDate: Date = new Date(2021, 7, 12);
const allowMultiple: boolean = true;
const ownerDataSource: Record<string, any>[] = [
  { OwnerText: 'Nancy', Id: 1, OwnerColor: '#ffaa00' },
  { OwnerText: 'Steven', Id: 2, OwnerColor: '#f8a398' },
  { OwnerText: 'Michael', Id: 3, OwnerColor: '#7499e1' }];
const eventSettings: EventSettingsModel = {
  dataSource: [
{
  Id: 1,
  Subject: 'Surgery - Andrew',
  EventType: 'Confirmed',
  StartTime: new Date(2021, 7, 10, 9, 0),
  EndTime: new Date(2021, 7, 10, 10, 0),
  OwnerId: 2
},
{
  Id: 2,
  Subject: 'Consulting - John',
  EventType: 'Confirmed',
  StartTime: new Date(2021, 7, 11, 10, 0),
  EndTime: new Date(2021, 7, 11, 11, 30),
  OwnerId: 3
},
{
  Id: 3,
  Subject: 'Therapy - Robert',
  EventType: 'Requested',
  StartTime: new Date(2021, 7, 12, 11, 30),
  EndTime: new Date(2021, 7, 12, 12, 30),
  OwnerId: 1
}
  ]
};
</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-calendars/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-vue-schedule/styles/material.css';
</style>

Run the project

To run the project, execute the following command:

npm run dev

or

yarn run dev

The output will appear as follows:

vue3-ts-composition

Getting Started / Vue 3 with JS and Composition API

Getting Started / Vue 3 with JS and Options API

Contents

Prerequisites
Set up the Vite project
Add Syncfusion packages to the project
Import the Syncfusion styles
Import CSS styles
Import SASS styles
Integrate the Syncfusion Vue component to the project
Run the project