useDateFormat

v0.0.15testeddemo

Reactively format a `Date`, timestamp, or date string against a token string (`YYYY MM DD HH mm ss SSS dddd A` etc.). Recomputes when the date, format, or locale changes.

Source Tests

Examples

const formatted = useDateFormat(useNow(), 'YYYY-MM-DD HH:mm:ss');

// Localized weekday + month, reactive locale
const locale = ref('fr-FR');
const label = useDateFormat(date, 'dddd, MMMM D', { locales: locale });

// Custom meridiem
const t = useDateFormat(date, 'hh:mm a', {
  customMeridiem: (h) => (h < 12 ? 'morning' : 'evening'),
});

Demo

Loading demo…

Signature

export function useDateFormat(
  date: MaybeRefOrGetter<DateLike>,
  formatStr: MaybeRefOrGetter<string> = 'HH:mm:ss',
  options: UseDateFormatOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`date`	`MaybeRefOrGetter<DateLike>`	—	The date to format
`formatStr`?	`MaybeRefOrGetter<string>`	`'HH:mm:ss'`	The token string
`options`?	`UseDateFormatOptions`	`{}`	Locale and meridiem options

Returns

UseDateFormatReturnThe reactive formatted string