useDate API

API reference for the useDate composable.

Explore these related pages for additional context and usage patterns.

Functions

(options: DateOptions<Z>) => E

Creates a new date context.

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

Creates a new date context trinity.

(options: DatePluginOptions<Z>) => import("/home/runner/work/0/0/packages/0/src/composables/index").Plugin

Creates a new date plugin.

(namespace?: string) => E

Returns the current date context. Requires `createDatePlugin` to be installed with an adapter.

DateAdapter<Z>

Date adapter instance.

string | undefined

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

Record<string, string> | undefined

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

number | undefined

First day of week override. 0=Sun, 1=Mon, ... 6=Sat. Derived from locale if not set.

DateAdapter<Z>

The date adapter instance

ComputedRef<string | undefined>

Current locale (reactive, synced with useLocale if available)

ComputedRef<number>

First day of week, derived from locale or explicit override