Composables

useLuxon

The useLuxon composable provides convenient access to Luxon's date-time functionality with the configured options for your Nuxt application.

Parameters

• value (optional): The date-time input to be formatted. Can be a string, Date object, or other valid input that Luxon can parse.
• outputFormat (optional): The format to output the date-time in. Can be a predefined format string or a custom format.
• inputFormat (optional): Format options to use when parsing the input value.

Return Value

The return value depends on how you call the composable:

• When called with a value: Returns the formatted date-time string
• When called without arguments: Returns an object containing:
  • $luxon: The formatting function
  • $lf: Alias for the formatting function
  • $lp: The parsing function

Basic Usage

// Format a date directly
const formattedDate = useLuxon('2023-01-01', 'date_short')

// Get formatting and parsing functions
const { $luxon, $lf, $lp } = useLuxon()

// Format a date with the formatting function
const date = $luxon('2023-01-01', 'date_med')

// Alias for formatting
const sameDate = $lf('2023-01-01', 'date_med')

// Parse a date string
const dateObject = $lp('January 1, 2023', 'MMMM d, yyyy')

Advanced Usage

You can use the composable with custom format options:

// Custom output format
const customFormat = useLuxon(new Date(), 'yyyy-MM-dd HH:mm:ss')

// With input format specified
const specificFormat = useLuxon('01/02/2023', 'date_med', { format: 'MM/dd/yyyy' })

// With timezone handling
const timezoned = useLuxon('2023-01-01T12:00:00Z', { format: 'date_med', zone: 'America/New_York' })