vue-datetime3

Vue3-datetime

Mobile friendly datetime picker for Vue. Supports date, datetime and time modes, i18n and more.

This is a fork and port of Vue 2 vue-datetime by mariomka to support Vue 3 and typescript. For older versions of Vue refer to aforementioned project.

Demo

Go to demo.

Installation

Bundler

yarn add luxon vue-datetime3 weekstart

Or

npm install --save luxon vue-datetime3 weekstart

weekstart is optional, is used to get the first day of the week.

Register

import createApp from 'vue'
import createDatetime from 'vue-datetime'
// You need a specific loader for CSS files
import 'vue-datetime/dist/style.css'

const app = createApp();

app.use(createDatetime());

Usage

Minimal

<datetime v-model="date"></datetime>

Setup

Parameters

Parameter	Type	Default	Description
v-model (required)	ISO 8601 String	-	Datetime.
type	String	date	Picker type: date, datetime or time.
input-id	String	''	Id for the input.
input-class	String, Array or Object	''	Class for the input.
input-style	String, Array or Object	''	Style for the input.
hidden-name	String	null	Name for hidden input with raw value. See #51.
value-zone	String	UTC	Time zone for the value.
zone	String	local	Time zone for the picker.
format	Object or String	DateTime.DATE_MED, DateTime.DATETIME_MED or DateTime.TIME_24_SIMPLE	Input date format. Luxon presets or tokens.
phrases	Object	{ok: 'Ok', cancel: 'Cancel'}	Phrases.
use12-hour	Boolean	false	Display 12 hour (AM/PM) mode
hour-step	Number	1	Hour step.
minute-step	Number	1	Minute step.
min-datetime	ISO 8601 String	null	Minimum datetime.
max-datetime	ISO 8601 String	null	Maximum datetime.
auto	Boolean	false	Auto continue/close on select.
week-start	Number	auto from locale if weekstart is available or 1	First day of the week. 1 is Monday and 7 is Sunday.
flow	Array	Depends of type	Customize steps flow, steps available: time, date, month, year. Example: ['year', 'date', 'time']
title	String	''	Popup title.
hide-backdrop	Boolean	false	Show/Hide backdrop.
backdrop-click	Boolean	true	Enable/Disable backdrop click to cancel (outside click).

Input inherits all props not defined above but style and class will be inherited by root element. See inheritAttrs option

The component is based on Luxon, check out documentation to set time zones and format.

Internationalization

Date internationalization depends on luxon. Set the default locale.

import { Settings } from 'luxon'

Settings.defaultLocale = 'es'

Events

Component emits the input event to work with v-model. More info.

close event is emitted when the popup closes.

Also, input text inherits all component events.

Slots

You can customize the component using named slots.

Available slots: before, after, button-cancel and button-confirm

Button customization example:

<datetime v-model="date" input-id="startDate">
  <label for="startDate" slot="before">Field Label</label>
  <span class="description" slot="after">The field description</span>
  <template slot="button-cancel">
    <fa :icon="['far', 'times']"></fa>
    Cancel
  </template>
  <template slot="button-confirm">
    <fa :icon="['fas', 'check-circle']"></fa>
    Confirm
  </template>
</datetime>

You can also use slot-scope to determine which view is currently active:

<template slot="button-confirm" slot-scope="scope">
  <span v-if='scope.step === "date"'>Next <i class='fas fa-arrow-right' /></span>
  <span v-else><i class='fas fa-check-circle' /> Publish</span>
</template>

Theming

Theming is supported by overwriting CSS classes.

Development

Launch lint and tests

npm run test

Note: Currently not working. Tests need to be rewritten to ViTest.

Launch visual tests

npm run demo

Build

Bundle the js and css to the dist folder:

npm run build

License

The MIT License

Changelog

v1.0.1

7 March 2023

• Remove unneeded files 0d13c28
• Use datetime plugin in demo app 2f3ade7
• Remove stale building utils 5af5d47
• Introduce vite 3a23c90
• Rework Popup to composition API, ts and velis styling ab22b91
• Rework DateTime to composition API, ts and velis styling 4b0d05b
• Rework time picker to composition API, ts and velis styling eed9b6e
• Refactor plugin to vue3 syntax af257cb
• Fix veu style into plain css bcf1a83
• Rework DatetimeCalendar to composition API, ts and velis eslint rules 49c1f87
• Cleanup package.json b35563c
• Fix example page c5a97d9
• Rework YearPicker to composition API, ts and velis styling 10096f7
• Rework MonthPicker to composition API, ts and velis styling 6551465
• Add packaging utilities 38f8c22
• Fix time picker, DRY scrolling concept 52eae4f
• Fix v-model reactivity ebab314
• Prepare package building utilities 21e7d78
• Remove auto moving on 12 hour time picker when touching all 3 params 5534287
• Added new props for backdrop-click 8af46c1
• preparing to publish 9d33af5
• Added new props for and hide backdrop d6770a1
• Update gitignore 40ceddf
• Fix month picker 4a5a59b
• Fix last commit bug 15dd190
• Fix build warnings 324725f
• Add unmaintained notice 1286b6c