Skip to main content
You are viewing Pre-Alpha documentation.
Vuetify0 Logo

useDate

The useDate composable provides comprehensive date manipulation capabilities using the adapter pattern. The default adapter uses the Temporal API↗ for modern, immutable date operations with locale-aware formatting via Intl.DateTimeFormat. Integrates with useLocale for automatic locale synchronization.

Intermediate98.8% coverageJan 10, 2026

Installation

The default adapter requires the @js-temporal/polyfill package:

pnpm
pnpm add @js-temporal/polyfill
Tip

The Temporal API is a Stage 3 TC39 proposal↗. Once browsers ship native support, the polyfill will no longer be required.

Then install the date plugin in your application:

src/plugins/zero.ts
import { createDatePlugin } from '@vuetify/v0'

app.use(
  createDatePlugin({
    locale: 'en-US',
  })
)

Usage

Once the plugin is installed, use the useDate composable in any component:

Locale:en-USFull date:Thursday, January 1, 1970Short date:1/1/70Weekday:ThursdayTime:12:00:00 AMCustom format:1970-01-01 00:00

API Reference

The following API details are for the useDate composable.

Functions

createDate

(options?: DateOptions<Z>) => E

Creates a new date context.

createDateFallback

() => DateContext<Temporal.PlainDateTime>

Creates a fallback date context for when useDate is called outside of a Vue component.

createDateContext

(options?: DateContextOptions<Z>) => ContextTrinity<E>

Creates a new date context trinity.

createDatePlugin

(options?: DatePluginOptions<Z>) => any

Creates a new date plugin.

useDate

(namespace?: string) => E

Returns the current date context. When called inside a component with a provided date context (via plugin or provider), returns that context. Otherwise, returns a fallback context with Vuetify0DateAdapter.

Options

adapter

DateAdapter<Z>

Custom date adapter instance (defaults to Vuetify0DateAdapter)

locale

string

Locale for formatting (defaults to useLocale's selected locale or 'en-US')

locales

Record<string, string>

Short locale codes mapped to full Intl locale strings (e.g., { en: 'en-US' })

Properties

adapter

DateAdapter<Z>

The date adapter instance

locale

ComputedRef<string>

Current locale (reactive, synced with useLocale if available)

DateAdapter Interface

The adapter provides a comprehensive API compatible with date-io↗:

ts
interface DateAdapter<T> {
  locale?: string

  // Construction & Conversion
  date (value?: unknown): T | null
  toJsDate (value: T): Date
  parseISO (dateString: string): T
  toISO (date: T): string
  parse (value: string, format: string): T | null
  isValid (date: unknown): date is T  // Type predicate
  isNull (value: T | null): value is null  // Type predicate

  // Formatting
  format (date: T, formatString: string): string
  formatByString (date: T, formatString: string): string
  formatNumber (numberToFormat: string): string
  getFormatHelperText (format: string): string
  getMeridiemText (ampm: 'am' | 'pm'): string

  // Navigation
  startOfDay (date: T): T
  endOfDay (date: T): T
  startOfWeek (date: T, firstDayOfWeek?: number): T
  endOfWeek (date: T, firstDayOfWeek?: number): T
  startOfMonth (date: T): T
  endOfMonth (date: T): T
  startOfYear (date: T): T
  endOfYear (date: T): T

  // Arithmetic
  addSeconds (date: T, amount: number): T
  addMinutes (date: T, amount: number): T
  addHours (date: T, amount: number): T
  addDays (date: T, amount: number): T
  addWeeks (date: T, amount: number): T
  addMonths (date: T, amount: number): T
  addYears (date: T, amount: number): T

  // Comparison
  isAfter (date: T, comparing: T): boolean
  isAfterDay (date: T, comparing: T): boolean
  isAfterMonth (date: T, comparing: T): boolean
  isAfterYear (date: T, comparing: T): boolean
  isBefore (date: T, comparing: T): boolean
  isBeforeDay (date: T, comparing: T): boolean
  isBeforeMonth (date: T, comparing: T): boolean
  isBeforeYear (date: T, comparing: T): boolean
  isEqual (date: T, comparing: T): boolean
  isSameDay (date: T, comparing: T): boolean
  isSameHour (date: T, comparing: T): boolean
  isSameMonth (date: T, comparing: T): boolean
  isSameYear (date: T, comparing: T): boolean
  isWithinRange (date: T, range: [T, T]): boolean

  // Getters
  getYear (date: T): number
  getMonth (date: T): number  // 0-indexed
  getDate (date: T): number
  getHours (date: T): number
  getMinutes (date: T): number
  getSeconds (date: T): number
  getDiff (date: T, comparing: T | string, unit?: string): number
  getWeek (date: T, firstDayOfWeek?: number, minimalDays?: number): number
  getDaysInMonth (date: T): number

  // Setters (immutable - returns new instance)
  setYear (date: T, year: number): T
  setMonth (date: T, month: number): T  // 0-indexed
  setDate (date: T, day: number): T
  setHours (date: T, hours: number): T
  setMinutes (date: T, minutes: number): T
  setSeconds (date: T, seconds: number): T

  // Calendar Utilities
  getWeekdays (firstDayOfWeek?: number, format?: 'long' | 'short' | 'narrow'): string[]
  getWeekArray (date: T, firstDayOfWeek?: number): T[][]
  getMonthArray (date: T): T[]
  getYearRange (start: T, end: T): T[]
  getNextMonth (date: T): T
  getPreviousMonth (date: T): T

  // Utility
  mergeDateAndTime (date: T, time: T): T
  getCurrentLocaleCode (): string
  is12HourCycleInCurrentLocale (): boolean
}

Format Presets

The format() method accepts these preset format strings:

PresetExample Output
fullDateSaturday, June 15, 2024
fullDateWithWeekdaySaturday, June 15, 2024
normalDateJun 15, 2024
shortDate6/15/24
year2024
monthJune
monthShortJun
monthAndYearJune 2024
monthAndDateJune 15
weekdaySaturday
weekdayShortSat
dayOfMonth15
hours12h10 AM
hours24h10
minutes30
seconds45
fullTime10:30:45 AM
fullTime12h10:30:45 AM
fullTime24h10:30:45
fullDateTimeSaturday, June 15, 2024 at 10:30 AM
keyboardDate06/15/2024
keyboardDateTime06/15/2024 10:30 AM

Format Tokens

The formatByString() method supports these tokens:

TokenOutputExample
YYYY4-digit year2024
YY2-digit year24
MMMMFull month nameJune
MMMShort month nameJun
MMMonth (zero-padded)06
MMonth6
ddddFull weekday nameSaturday
dddShort weekday nameSat
DDDay (zero-padded)15
DDay15
HH24-hour (zero-padded)10
H24-hour10
hh12-hour (zero-padded)10
h12-hour10
mmMinutes (zero-padded)30
mMinutes30
ssSeconds (zero-padded)45
sSeconds45
AAM/PMAM
aam/pmam

Examples

The following examples demonstrate common date operations using the default Temporal adapter:

Mini Calendar

The mini calendar example shows how to render a simple month view calendar using useDate for date calculations and formatting.

January 1970
S
M
T
W
T
F
S
28
29
30
31
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

Locale Integration

When useLocale is available, useDate automatically syncs with the selected locale:

src/main.ts
import { createApp } from 'vue'
import { createLocalePlugin, createDatePlugin } from '@vuetify/v0'

const app = createApp(App)

// Install locale plugin first
app.use(
  createLocalePlugin({
    default: 'en',
    messages: {
      en: { /* ... */ },
      de: { /* ... */ },
    }
  })
)

// Date plugin will auto-sync with locale
app.use(
  createDatePlugin({
    locales: {
      en: 'en-US',  // Map short codes to Intl locales
      de: 'de-DE',
    }
  })
)

When switching locales via useLocale, the date adapter automatically updates its formatting locale.

Custom Adapters

The adapter pattern decouples date operations from the underlying library. When you call adapter.format(), the request flows through the provided adapter to its underlying date library:

Adapter Pattern Flow

Use controls to zoom and pan. Click outside or press Escape to close.

Adapter Pattern Flow

Create custom adapters for different date libraries (date-fns, luxon, dayjs):

src/adapters/date-fns-adapter.ts
import type { DateAdapter } from '@vuetify/v0'
import { isValid as dateFnsIsValid, parseISO, format as dateFnsFormat } from 'date-fns'

class DateFnsAdapter implements DateAdapter<Date> {
  locale = 'en-US'

  date (value?: unknown): Date | null {
    if (value == null) return new Date()
    if (value instanceof Date) return value
    if (typeof value === 'string') return parseISO(value)
    if (typeof value === 'number') return new Date(value)
    return null
  }

  // Type predicate - enables TypeScript narrowing
  isValid (date: unknown): date is Date {
    return date instanceof Date && dateFnsIsValid(date)
  }

  // Type predicate - enables TypeScript narrowing
  isNull (value: Date | null): value is null {
    return value === null
  }

  format (date: Date, formatString: string): string {
    return dateFnsFormat(date, this.getDateFnsFormat(formatString))
  }

  // Implement remaining methods...
}

// Use with plugin
app.use(
  createDatePlugin({
    adapter: new DateFnsAdapter(),
  })
)
Tip

The isValid and isNull methods are type predicates. This enables TypeScript to narrow types after validation:

ts
const date = adapter.date(input)
if (!adapter.isNull(date) && adapter.isValid(date)) {
  // TypeScript knows `date` is Date here
  adapter.format(date, 'fullDate')
}

Known Limitations

  • parse() format parameter: The parse() method’s format parameter is currently ignored. The Temporal API doesn’t provide built-in format parsing. The method delegates to date() which handles ISO 8601 strings. For custom format parsing, use a library like date-fns or luxon with a custom adapter.

SSR and Hydration

Warning

Date formatting can cause hydration mismatches in SSR applications. Server and client environments may produce different formatted output due to timezone differences.

SSR Behavior for adapter.date():

  • Browser: Returns current time via Temporal.Now.plainDateTimeISO()
  • Server: Returns epoch (1970-01-01T00:00:00) for deterministic rendering

This is intentional to prevent hydration mismatches. For SSR apps needing current time, pass Date.now() explicitly.

Timezone-dependent formatting: Intl.DateTimeFormat uses the system timezone. Server environments (often UTC) and client browsers (user’s local timezone) produce different formatted strings.

Solutions:

  1. Nuxt/SSR: Wrap formatted dates in <ClientOnly>:

    vue
    <template>
      <ClientOnly>
       <span>{{ adapter.format(date, 'fullDate') }}</span>
     </ClientOnly>
    </template>
  2. Vue SSR: Defer formatting until after hydration:

    vue
    <script setup lang="ts">
      import { useDate } from '@vuetify/v0'
      import { shallowRef, onMounted, computed } from 'vue'
    
      const { adapter } = useDate()
      const isMounted = shallowRef(false)
      const date = adapter.date('2024-06-15T10:30:00')
    
      onMounted(() => { isMounted.value = true })
    
      const formatted = computed(() =>
        isMounted.value ? adapter.format(date, 'fullDate') : date?.toString()
      ))
    </script>
  3. Server timezone: Set TZ=UTC environment variable on your server for consistent baseline


© 2016-2026 Vuetify, LLC
Ctrl+/