Getting Started with the Vue Timepicker Component in Vue 2
25 Apr 202511 minutes to read
This article provides a step-by-step guide for setting up a Vue 2 project usingVue-CLI and integrating the Syncfusion® Vue Timepicker component using theComposition API /Options API.
Prerequisites
System requirements for Syncfusion® Vue UI components
Dependencies
The list of dependencies required to use the Vue TimePicker component in your application is given below:
|--@syncfusion/ej2-vue-calendars|--@syncfusion/ej2-base|--@syncfusion/ej2-data|--@syncfusion/ej2-vue-base|--@syncfusion/ej2-calendars|--@syncfusion/ej2-inputs|--@syncfusion/ej2-splitbuttons|--@syncfusion/ej2-lists|--@syncfusion/ej2-popups|--@syncfusion/ej2-buttonsSetting up the Vue 2 project
To generate a Vue 2 project using Vue-CLI, use thevue create command. Follow these steps to install Vue CLI and create a new project:
npm install -g @vue/clivue create quickstartcd quickstartnpm run serveor
yarn global add @vue/clivue create quickstartcd quickstartyarn run serveWhen creating a new project, choose the optionDefault ([Vue 2] babel, eslint) from the menu.
Once thequickstart project is set up with default settings, proceed to add Syncfusion® components to the project.
Add Syncfusion® Vue packages
Syncfusion® packages are available atnpmjs.com. To use Vue components, install the required npm package.
This article uses theVue Timepicker component as an example. Install the@syncfusion/ej2-vue-calendars package by running the following command:
npm install @syncfusion/ej2-vue-calendars --saveor
yarn add @syncfusion/ej2-vue-calendarsImport 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 andTheme Studio. Refer tothemes topic to know more about built-in themes and different ways to refer to themes in a Vue project.
In this article, theMaterial theme is applied using CSS styles, which are available in installed packages. The necessaryMaterial CSS styles for the Timepicker component and its dependents were imported into the<style> section ofsrc/App.vue file.
<style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";</style>Note: If you want to refer the combined component styles, please make use of our
CRG(Custom Resource Generator) in your application.
Add Syncfusion® Vue component
Follow the below steps to add the Vue Timepicker component usingComposition API orOptions API:
1. First, import and register the Timepicker component in thescript section of thesrc/App.vue file. If you are using theComposition API, you should add thesetup attribute to thescript tag to indicate that Vue will be using theComposition API.
<scriptsetup>import{TimePickerComponentasEjsTimepicker}from'@syncfusion/ej2-vue-calendars';</script><script>import{TimePickerComponent}from'@syncfusion/ej2-vue-calendars';exportdefault{components:{'ejs-timepicker':TimePickerComponent}}</script>2. In thetemplate section, define the Timepicker component with theplaceholder property.
<template><divid="app"><divclass='wrapper'><ejs-timepicker:placeholder="waterMark"></ejs-timepicker></div></div></template>3. Declare the value for theplaceholder property in thescript section.
<scriptsetup>import{TimePickerComponentasEjsTimepicker}from'@syncfusion/ej2-vue-calendars';</script><script>data(){return{waterMark:'Select a time'}}</script>Here is the summarized code for the above steps in thesrc/App.vue file:
<template><divid="app"><divclass='wrapper'><ejs-timepicker:placeholder="waterMark"></ejs-timepicker></div></div></template><scriptsetup>import{TimePickerComponentasEjsTimepicker}from'@syncfusion/ej2-vue-calendars';constwaterMark='Select a time';</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style><template><divid="app"><divclass='wrapper'><ejs-timepicker:placeholder="waterMark"></ejs-timepicker></div></div></template><script>import{TimePickerComponent}from'@syncfusion/ej2-vue-calendars';exportdefault{name:"App",components:{'ejs-timepicker':TimePickerComponent},data(){return{waterMark:'Select a time'}}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style>Run the project
To run the project, use the following command:
npm run serveor
yarn run serveSetting the value, min, and max time
The following example demonstrates how to set the value, min, and max time on initializing the TimePicker. The Vue TimePicker allows you to select the time value within a range from7:00 AM to4:00 PM.
<template><divid="app"><divclass='wrapper'><ejs-timepicker:min="minDate":max="maxDate":value="timeVal"></ejs-timepicker></div></div></template><scriptsetup>import{TimePickerComponentasEjsTimepicker}from'@syncfusion/ej2-vue-calendars';constminDate=newDate("05/07/2017 7:00 AM");constmaxDate=newDate("05/07/2017 4:00 PM");consttimeVal=newDate("05/27/2017 1:00 PM");</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style><template><divid="app"><divclass='wrapper'><ejs-timepicker:min="minDate":max="maxDate":value="timeVal"></ejs-timepicker></div></div></template><script>import{TimePickerComponent}from'@syncfusion/ej2-vue-calendars';exportdefault{name:"App",components:{'ejs-timepicker':TimePickerComponent},data(){return{minDate:newDate("05/07/2017 7:00 AM"),maxDate:newDate("05/07/2017 4:00 PM"),timeVal:newDate("05/27/2017 1:00 PM")}}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style>Setting the time format
Time formats is a way of representing the time value in different string format in textbox and popup list. By default, the TimePicker’s format is based on the culture. You can also customize the format by using theformat property. To know more about the time format standards, refer to theDate and Time Format section.
The following example demonstrates the TimePicker component in 24 hours format with 60 minutes interval. The time interval is set to 60 minutes by using thestep property.
<template><divid="app"><divclass='wrapper'><ejs-timepicker:step="timeStep":format="timeFormat":value="timeVal"></ejs-timepicker></div></div></template><scriptsetup>import{TimePickerComponentasEjsTimepicker}from'@syncfusion/ej2-vue-calendars';consttimeStep=60;consttimeFormat='HH:mm';consttimeVal=newDate();</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style><template><divid="app"><divclass='wrapper'><ejs-timepicker:step="timeStep":format="timeFormat":value="timeVal"></ejs-timepicker></div></div></template><script>import{TimePickerComponent}from'@syncfusion/ej2-vue-calendars';exportdefault{name:"App",components:{'ejs-timepicker':TimePickerComponent},data(){return{timeStep:60,timeFormat:'HH:mm',timeVal:newDate()}}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-inputs/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-lists/styles/material.css';@import"../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";.wrapper{max-width:250px;margin:0auto;}</style>Once the time format property is defined, it will be applicable to all the cultures.
See Also
[8]ページ先頭