Scheduler - Locale and Calendars

Render localized labels, alternate calendar display, and numbering systems.

#Usage

import { Scheduler } from '@primeui/vue-scheduler';
<Scheduler.Root :locale="locale" :calendar="calendar" :numbering-system="numberingSystem" :text="schedulerText">
    <!-- Scheduler parts -->
</Scheduler.Root>

Locale, calendar, numbering, and translated text are root display props. Set them once on Scheduler.Root so every active view formats dates and labels consistently.

#Locale Options

locale is a BCP 47 locale string. calendar and numberingSystem accept Intl calendar and numbering system identifiers, or locale to use the locale default.

import type { SchedulerCalendarMode, SchedulerNumberingSystem, SchedulerProps } from '@primeui/vue-scheduler';

const locale: NonNullable<SchedulerProps['locale']> = 'en-GB';
const calendar: SchedulerCalendarMode = 'gregory';
const numberingSystem: SchedulerNumberingSystem = 'latn';
const schedulerText: NonNullable<SchedulerProps['text']> = {
    today: 'Today',
    allDay: 'All day',
    moreEvents: (count: number) => `+${count} more`
};

schedulerText is a partial text override for Scheduler labels that are not produced by date formatting.

#Locale

Locale settings change visible labels, dates, and numbering.

Loading Demo...

#Arabic Calendar

Locale and calendar props can render translated labels and alternate numbering while controlled date values still drive calendar math, date ownership, and interaction behavior.

Loading Demo...

#API

Key props are locale, calendar, numberingSystem, dateDisplay, timeFormat, and date-related event payloads.