Preview

Controls

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal

php artisan ui:add calendar

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/calendar.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS

import './calendar.js';

Registry contract

Install confidence

php artisan ui:add calendar writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.0.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/calendar.blade.php
js	resources/js/ui/calendar.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Date and time picker

Choose a date, time, or bounded contextual value.

Use when

Use when date, time, or bounded-value context helps users enter valid values faster and with fewer errors. Do not force a picker when expert users can type the value faster and validation is straightforward.

Avoid when

Avoid using calendar as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.

Task length: short
Interaction cost: medium
Interruptiveness: none
Input precision: precise
Mobile / touch risk: medium
Accessibility risk: high
Needs background context: No
Comparison needed: No

Preferred alternatives

Direct typed entry with validation

Anti-patterns

Forcing a picker when typing is faster

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
name	string\|null	null	Optional hidden input name for form submission.
value	string	''	Selected ISO date value in yyyy-mm-dd format.
locale	string\|null	null	Locale passed to Intl month and weekday formatting.
firstDay	int	1	First weekday where 0 is Sunday and 1 is Monday.
chrome	bool	true	Render the outer popover-style border and padding.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

calendar

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Arrow keys move by day or week, PageUp/PageDown changes month, Home/End jump to week edges, and Enter/Space selects.
Selection is mirrored to the hidden input and emitted through a change event.
Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.calendar.default.blade.php Blade

<x-ui.calendar name="event_date" value="" :first-day="1" />

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels

Accessibility target: wcag-2.2-aa-target.
Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
Focus-visible rings use the ring token so keyboard focus is always visible.
Disabled and invalid states are conveyed to assistive tech, not by color alone.
Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.

Calendar