useDate API

API reference 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.

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)