
Day.js Nuxt Module
Fast 2kB alternative to Moment.js with the same modern API
Day.js Nuxt Module supporting v3
Features
- ⛰ Nuxt 3 ready
- 🚠 Activate any plugin or locale available
- 🌲 Specify default locales and timezones
Quick Setup
- Add
dayjs-nuxt
dependency to your project
# Using pnpmpnpm add -D dayjs-nuxt# Using yarnyarn add --dev dayjs-nuxt# Using npmnpm install --save-dev dayjs-nuxt
- Add
dayjs-nuxt
to themodules
section ofnuxt.config.ts
export default defineNuxtConfig({ modules: [ 'dayjs-nuxt' ]})
Basic Usage
You can use the provided composables to access Day.js anywhere.
<script lang="ts" setup>const dayjs = useDayjs()const date = dayjs('2023-01-01')</script><template> <div> <time :datetime="date.utc()"> {{ date }}</p> </div> </template>
Configuration
You can specify any amount of locales, plugins, set a default locale, and set a default timezone
export default defineNuxtConfig({ modules: ['dayjs-nuxt'], dayjs: { locales: ['en', 'fr'], plugins: ['relativeTime', 'utc', 'timezone'], defaultLocale: 'en', defaultTimezone: 'America/New_York', }})
By default we include the relativeTime and utc plugins
Development
# Install dependenciesnpm install# Generate type stubsnpm run dev:prepare# Develop with the playgroundnpm run dev# Build the playgroundnpm run dev:build# Run ESLintnpm run lint# Run Vitestnpm run testnpm run test:watch# Release new versionnpm run release