Calendar
Month grid with date selection and optional built-in month and year navigation.
Preview
A live, theme-aware example rendered with the published component.
Loading preview…
Import
Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.
tsximport { Calendar } from "@tavojs/ui/calendar";The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/calendar.
When to use
Use it when
Choose something else when
Examples
These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.
Selectable month and year
tsximport { createTavo } from "@tavojs/core";
import { Calendar } from "@tavojs/ui/calendar";
import { Text } from "@tavojs/ui";
type State = { year: number; month: number; selected: string };
export const CalendarExample1 = createTavo<Record<string, never>, State>({
model: () => ({ year: 2026, month: 8, selected: "2026-09-07" }),
view: ({ state, model }) => (
<>
<Calendar
year={state.year}
month={state.month}
selected={state.selected}
yearRange={{ start: 2020, end: 2030 }}
onMonthChange={(year, month) => model.patch({ year, month })}
onSelect={(selected) => model.set("selected", selected)}
/>
<Text>Selected date: {state.selected}</Text>
</>
)
});Common props and defaults
A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
size | Size | md | Control scale: sm, md, or lg when supported. Applies to Calendar. |
disabled | boolean | false | Disables the control when supported. Applies to Calendar. |
aria-* | unknown | — | ARIA attributes are passed through for accessible labeling and state. Applies to Calendar. |
year | number | — | Displayed year. |
month | number | — | Displayed zero-based month. |
yearRange | { start: number; end: number } | — | Inclusive year options shown by the year selector. |
onMonthChange | (year: number, month: number) => void | — | Makes the month and year in the top heading selectable and requests a controlled visible-month change. |
onSelect | (value: string) => void | — | Runs when an enabled date is selected. |
Complete TypeScript API
Import from @tavojs/ui/calendar. Published exports: Calendar, CalendarProps.
CalendarProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by Calendar. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by Calendar. |
id | string | No | Inherited id attribute accepted by Calendar. |
role | string | No | Inherited role attribute accepted by Calendar. |
style | Record<string, unknown> | No | Inherited style attribute accepted by Calendar. |
title | string | No | Inherited title attribute accepted by Calendar. |
tabIndex | number | No | Inherited tabIndex attribute accepted by Calendar. |
hidden | boolean | No | Inherited hidden attribute accepted by Calendar. |
disabled | boolean | No | Disables the control when supported. Applies to Calendar. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by Calendar. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by Calendar. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by Calendar. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by Calendar. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by Calendar. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by Calendar. |
year | number | No | Displayed year. |
month | number | No | Displayed zero-based month. |
yearRange | { start: number; end: number; } | No | Inclusive year options shown by the year selector. |
selected | string | No | Inherited selected attribute accepted by Calendar. |
min | string | No | Inherited min attribute accepted by Calendar. |
max | string | No | Inherited max attribute accepted by Calendar. |
locale | string | No | Inherited locale attribute accepted by Calendar. |
onSelect | (value: string) => void | No | Runs when an enabled date is selected. |
onMonthChange | (year: number, month: number) => void | No | Makes the month and year in the top heading selectable and requests a controlled visible-month change. |
State ownership and DOM target
| Concern | Contract |
|---|---|
| State | Update selected in onSelect. Supply year, month, and onMonthChange to enable and control the built-in month and year navigation. |
| DOM target | Native input attributes target the owned form control; wrapper-specific props stay on the documented component root. |
Anatomy and related components
This component exposes one public component root rather than a compound member API.
Limitations
Use DatePicker for a native date input with a floating calendar. Calendar navigation appears when onMonthChange is supplied; the application must update year and month after the callback.
Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.
Accessibility
Form components pass through native attributes and should be paired with visible labels or accessible names.
Use Field, FormLabel, FormControlLabel, or aria-label for labeling.
Preserve native input semantics whenever possible.
Expose validation with error text and aria-invalid where relevant.
Component status
| Contract | Current value |
|---|---|
| Maturity | stable |
| Category | forms |
| Component import | @tavojs/ui/calendar |
| Explicit CSS import | @tavojs/ui/css/calendar |
| Preview | Interactive preview available on this page |