Installation

This guide covers how to install useTemporal in your project.

Quick Install

The fastest way to get started is to install the main package which includes the core library and native adapter:

npm

npm install @allystudio/usetemporal

yarn

yarn add @allystudio/usetemporal

pnpm

pnpm add @allystudio/usetemporal

bun

bun add @allystudio/usetemporal

What's Included

The @allystudio/usetemporal package includes:

• Core library with all functionality
• Native JavaScript Date adapter (zero dependencies)
• Optional adapter integrations for date-fns, Luxon, and Temporal API
• Calendar units (stableMonth)

Optional Dependencies

If you want to use a specific date library adapter, install it as an optional dependency:

With date-fns

npm install @allystudio/usetemporal date-fns

With Luxon

npm install @allystudio/usetemporal luxon

With Temporal API

npm install @allystudio/usetemporal @js-temporal/polyfill

Calendar Units

The package includes specialized calendar units like stableMonth for consistent calendar grids. These are automatically available when you import the library:

import { createTemporal, period } from '@allystudio/usetemporal'
import { createNativeAdapter } from '@allystudio/usetemporal/native'

const temporal = createTemporal({ adapter: createNativeAdapter() })
const stableMonth = temporal.period( 'stableMonth', temporal.browsing.value)

Calendar units provide:

• 6-week (42-day) stable calendar grids
• Calendar-specific time units
• Consistent layouts for calendar UIs

See Calendar Units for more information.

Requirements

• Node.js: 16.0 or higher
• ESM Support: All packages are ESM-only
• TypeScript: 4.5+ (optional but recommended)

Verify Installation

Create a simple test file to verify everything is working:

import { createTemporal } from '@allystudio/usetemporal'

const temporal = createTemporal()
console.log('useTemporal installed successfully!')
console.log('Current date:', temporal.now.value.date)

Next Steps

• Continue to First App to build something
• Learn about Core Concepts
• Explore Date Adapters