usePeriod

Creates a reactive period that automatically updates based on the temporal instance's browsing state.

Signature

function usePeriod(
  temporal: Temporal, 
  unit: Unit | Ref<Unit>
): ComputedRef<Period>

Parameters

• temporal - Temporal - The temporal instance
• unit - Unit | Ref<Unit> - Time unit ('year', 'month', 'week', 'day', etc.)

Returns

ComputedRef<Period> - Reactive period that updates when browsing changes

Description

Creates a computed period based on the current browsing date and specified unit. The period automatically updates when temporal.browsing changes.

Example

const month = usePeriod(temporal, 'month')
const year = usePeriod(temporal, 'year')

// Access current values
console.log(month.value.start)
console.log(year.value.date)

See Also

• Reactive Time Units - How reactivity works
• Period Type - Period interface
• period - Non-reactive alternative