YearPicker

YearPicker is the year-selection subsystem of the calendar family.

Root Props

Prop	Type	Default
`year`	`string`	—
Controls the currently visible year, given as a `YYYY-MM-DD` string of any day in it. This prop defines what year is currently in view, not just which year is selected. Updating it may cause the picker to: Scroll to the corresponding year grid; Recompute the visible window of years; Update navigation controls (previous / next)
`calendar`	`CalendarSystem`	`gregorianCalendar`
Calendar system the years belong to, including eras. Defaults to the Gregorian calendar.
`locale`	`string`	`getDefaultLocale()`
BCP 47 locale of the year labels (and eras), e.g. `ja-JP`. Defaults to the locale of the runtime, like `Intl`.
`size`	`DataGridPickerSize`	`'xs'`
Controls the item’s visual size. Useful for adapting the picker to compact or large layouts.
`variant`	`DataGridPickerVariant`	—
Visual appearance preset for the picker.
`selection`	`S`	`'single'`
Selection mode. `'single'` — only one cell can be selected at a time; `'multiple'` — independent multi-selection (toggle per cell); `'range'` — range selection between two points (Shift + arrows or pointer drag)
`disabled`	`DataGridDisabled<string>`	—
Predicate or map of disabled cells. Can be: a function `(key) => boolean`; an array of disabled keys; a single key. Disabled cells cannot be selected or focused.
`excludeDisabled`	`boolean`	—
—
`expandable`	`boolean`	`true`
Enables expanding selection ranges (Shift + Arrow or mouse drag).
`defaultActive`	`string`	—
Uncontrolled initial active cell.
`active`	`string`	—
Controlled active cell.
`selected`	`S extends "single" ? string \| null : string[]`	—
Controlled selected cells. In `'single'` mode `null` means controlled with nothing selected.
`defaultSelected`	`S extends "single" ? string : string[]`	—
Uncontrolled initially selected cells.
`from`	`string`	—
Range boundaries. If provided, limits selection to cells between `from` and `to` based on the `compare` function.
`to`	`string`	—
—
`resolveRange`	`(start: DataGridResolveValue<K>, end: DataGridResolveValue<K>, grid: Grid<HTMLElement, K>) => K[]`	—
Custom range resolution logic for `selection="range"`. Given start and end values, returns the list of keys forming the range.
`equals`	`(start: K \| undefined, end: K \| undefined) => boolean`	—
Custom equality comparator for comparing two cell keys. Defaults to strict equality (`===`).
`compare`	`(a: K, b: K) => -1 \| 0 \| 1`	—
Custom ordering comparator for comparing two cell keys. Should return `-1`, `0`, or `1`.
`onSelectCell`	`(value: S extends 'single' ? K : K[]) => void`	—
Fires when the user selects cell. Receives the list of selected cell keys.
`onChangeActive`	`(active: K) => void`	—
Fires when the active (focused) cell changes.
`ref`	`Ref<HTMLDivElement>`	—
Ref to the grid’s root element.
`apiRef`	`Ref<DataGridApiRef<string>>`	—
Ref to the grid’s imperative API. Exposes low-level structures for advanced scenarios: `grid` — matrix navigation helper; `keyMap` — Map`<K, [row, col]>` for fast lookups
`wrap`	`DataGridWrap`	—
Navigation wrap mode. 'horizontal' — wrap across columns within the same row; 'vertical' — wrap across rows within the same column; 'both' — enable both behaviors; undefined — no wrapping
`exclude`	`DataGridExclude<string>`	—
Exclude cells from focus traversal. Can be: a single key; an array of keys; a predicate `(key) => boolean`
`rowDelta`	`number`	—
Page navigation row step for PageUp/PageDown. `undefined` — jump to the first/last row; `number` — move by N rows relative to the current row
`onArrow`	`(e: KeyboardEvent<HTMLDivElement>, node: MatrixNode<HTMLElement, K>, prevNode: MatrixNode<HTMLElement, K>) => void`	—
Fires on each Arrow navigation step after focus changes

Also accepts all <div> attributes.

Child Parts

YearPickerLayout
YearPickerRowGroup
YearPickerRow
YearPickerItem
YearPickerCell
YearPickerScroller
YearPickerScrollerContent
YearPickerScrollerLayout

`YearPickerItem`

Prop	Type	Default
`range`	`DataGridPickerItemRangePosition`	—
Optional visual indicator of the cell’s position within a range. One of: `"start" \| "between" \| "end"`. If not provided, the component automatically derives it based on selection context.
`size`	`DataGridPickerSize`	—
Controls the item’s visual size. Useful for adapting the picker to compact or large layouts.
`value`	`DataGridCellKey`	—
Logical value associated with this grid cell. Used as the cell’s unique selection key.
`variant`	`DataGridPickerVariant`	—
Visual appearance preset for the picker.
`disabled`	`boolean`	—
Disables click and keyboard selection. Overrides value from root DataGrid
`ref`	`Ref<HTMLDivElement>`	—
External ref to the cell root element. Will be merged with the internal `itemRef([row, col], key)` registration when the cell is not excluded.
`col`required	`number`	—
Column index of the cell (0-based). Used together with row index from the row context to form grid coordinates: `[row, col]`.
`asChild`	`boolean`	`false`
When `true`, renders children via `Slot` and forwards props/refs to the child element instead of using a native `<div>`.
`excluded`	`boolean`	—
Exclude cells from focus traversal. Overrides value from root DataGrid

Also accepts all <div> attributes.

`YearPickerCell`

Prop	Type	Default
`size`	`DataGridPickerSize`	—
Controls the item’s visual size. Useful for adapting the picker to compact or large layouts.
`range`	`DataGridPickerItemRangePosition`	—
Optional visual indicator of the cell’s position within a range. One of: `"start" \| "between" \| "end"`. If not provided, the component automatically derives it based on selection context.
`variant`	`DataGridPickerVariant`	—
Visual appearance preset for the picker.
`disabled`	`boolean`	—
Disables click and keyboard selection. Overrides value from root DataGrid
`ref`	`Ref<HTMLDivElement>`	—
External ref to the cell root element. Will be merged with the internal `itemRef([row, col], key)` registration when the cell is not excluded.
`asChild`	`boolean`	`false`
When `true`, renders children via `Slot` and forwards props/refs to the child element instead of using a native `<div>`.
`excluded`	`boolean`	—
Exclude cells from focus traversal. Overrides value from root DataGrid

Also accepts all <div> attributes.

`YearPickerRow`

Prop	Type	Default
`row`required	`number`	—
Zero-based row index for all descendant cells. Provided to descendants via context.

Also accepts all <div> attributes.

`YearPickerRowGroup`

Prop	Type	Default
`scope`	`DataGridScope`	—
The `scope` prop is required and identifies the logical group of cells rendered by this row group. When used with `DataGridIndexedSnapScroller`, the scope usually matches the current index or page. Providing a scope allows the DataGrid to restore focus to the first available cell when the index changes and new cells are rendered.

Also accepts all <div> attributes.

`YearPickerLayout`

Prop	Type	Default
`children`required	`ReactNode`	—
Template of a year cell, rendered once for every year of the page. Read the year with `useYearPickerCellContext()`; usually `<YearPickerCell />`.
`rows`	`number`	`4`
Number of grid rows to render. Controls vertical density of the year matrix.
`cols`	`number`	`3`
Number of grid columns to render. Controls horizontal density of the year matrix.
`start`	`string`	—
First year of page `0`, given as a `YYYY-MM-DD` string of any day in it. Pages are aligned to it. Defaults to the visible year of the YearPicker.
`offset`	`number`	—
Page index relative to `start`. Defaults to the page containing the visible year of the YearPicker.
`locale`	`string`	—
Locale used for formatting years. Defaults to the locale of the picker.
`format`	`Intl.DateTimeFormatOptions['year']`	`'numeric'`
Year display format (from `Intl.DateTimeFormatOptions`).
`scope`	`DataGridScope`	—
The `scope` prop is required and identifies the logical group of cells rendered by this row group. When used with `DataGridIndexedSnapScroller`, the scope usually matches the current index or page. Providing a scope allows the DataGrid to restore focus to the first available cell when the index changes and new cells are rendered.

Also accepts all <div> attributes.

`YearPickerScroller`

Prop	Type	Default
`onChangePeriod`	`(year: string) => void`	—
Called when a page of years is scrolled into view, with the first day of the first year of that page as a `YYYY-MM-DD` string in the YearPicker's calendar system.
`defaultYear`	`string`	—
Initial year for uncontrolled usage outside a YearPicker, given as a `YYYY-MM-DD` string of any day in it. Defaults to the current year.
`period`	`number`	`12`
Number of years on a page; must match the page size of the layout.
`start`	`number`	`-2`
Starting index used to generate the initial sequence of pages. Acts as the logical origin for the sliding index window.
`startDir`	`-1 \| 1`	`1`
Direction in which the initial index sequence expands. `1` — indexes increase to the right (0, 1, 2…); `-1` — indexes decrease to the right (0, -1, -2…). Controls the growth pattern of the initial index array.
`size`	`number`	`5`
Number of index segments rendered at once. Defines the size of the virtual “window” that the scroller slides over when navigating left or right.
`shift`	`number`	`2`
Number of pages appended when a scroll reaches the end of the window, so a fast swipe keeps going. Once the scroll settles, the window is re-centered on the snapped page.
`index`	`number`	—
Controls the currently active logical index. When provided, the scroller keeps the given index in view, scrolling to it if possible or rebuilding the window if needed.
`preserveScroll`	`boolean`	`true`
Preserve the currently snapped item after content changes (e.g., when pages are prepended/appended). If `true`, the scroller will restore the same snapped index using an immediate `scrollIntoView`.
`apiRef`	`Ref<IndexedSnapScrollerApiRef>`	—
Exposes the imperative API of the scroller. Allows programmatic control such as scrolling to an index or resetting the virtual window.
`onOffset`	`(value: number) => void`	—
Fires when the window grows at an edge. `-1` — the scroll settled on the first page (left/top edge); `+1` — the scroll reached the end (right/bottom edge). Useful for infinite loading: append/prepend pages based on the direction.
`ref`	`Ref<HTMLDivElement>`	—
Ref to the scroller’s element.
`defaultIndex`	`number`	—
Initial index of the item to snap to on mount.
`onScrollSnapChange`	`(element: HTMLElement, index: number) => void`	—
Fired when a scroll snap operation has fully completed and the scroller has settled on a new snap index. This callback is invoked after all scrolling and snapping animations have finished and the active snap position is considered stable.
`onScrollSnapChanging`	`(element: HTMLElement, index: number) => void`	—
Fired while a scroll snap operation is in progress and the active snap index is still changing. This callback may be invoked multiple times during a single scroll or swipe interaction as the scroller approaches its final snap position. Useful for optimistic UI updates, previews, or synchronizing transient state during scrolling.

Also accepts all <div> attributes.

`YearPickerScrollerContent`

Prop	Type	Default
`ref`	`Ref<HTMLDivElement>`	—
External ref to the item's root element. Will be merged with internal `itemRef(index)` to participate in snapping logic.
`asChild`	`boolean`	—
Render the content as a child (via `Slot`) instead of a native `<div>`. Keeps attributes/refs bound to the passed child element.

Also accepts all <div> attributes.

`YearPickerScrollerLayout`

Prop	Type	Default
`children`required	`ReactNode`	—
Template of a year cell, rendered once for every year of the page. Read the year with `useYearPickerCellContext()`; usually `<YearPickerCell />`.
`start`	`string`	—
First year of page `0`, given as a `YYYY-MM-DD` string of any day in it. Pages are aligned to it. Defaults to the visible year of the YearPicker.
`locale`	`string`	—
Locale used for formatting years. Defaults to the locale of the picker.
`rows`	`number`	`4`
Number of grid rows to render. Controls vertical density of the year matrix.
`format`	`Intl.DateTimeFormatOptions['year']`	`"numeric"`
Year display format (from `Intl.DateTimeFormatOptions`).
`scope`	`DataGridScope`	—
The `scope` prop is required and identifies the logical group of cells rendered by this row group. When used with `DataGridIndexedSnapScroller`, the scope usually matches the current index or page. Providing a scope allows the DataGrid to restore focus to the first available cell when the index changes and new cells are rendered.
`cols`	`number`	`3`
Number of grid columns to render. Controls horizontal density of the year matrix.

Also accepts all <div> attributes.

Types

YearPickerProps
YearPickerLayoutProps
YearPickerRowGroupProps
YearPickerRowProps
YearPickerItemProps
YearPickerCellProps
YearPickerCellContextData
YearPickerScrollerProps
YearPickerScrollerContentProps
YearPickerScrollerLayoutProps

State Model

Selection and bounds behavior are inherited from DataGridPicker.
Years are keyed by their first day as a YYYY-MM-DD string; selected, from, to, and disabled use the same strings.
The root shares the visible year (its first day) and calendar through useYearPickerContext.
createYearPickerGrid({ rows, cols, start, offset, calendar }) returns a page of rows × cols consecutive years from the ISO start.
Scroller pages hold period years (default 12) counted from referenceYear (useYearPickerScrollerContext); keep period equal to the layout's rows × cols. onChangePeriod receives the first day of the first year of the page scrolled into view.
Children of YearPickerLayout and YearPickerScrollerLayout are the template of a cell, rendered once per year inside a cell context. The children are required, usually <YearPickerCell />, which shows the formatted label.
useYearPickerCellContext() returns { col, date, fields, label }; date is the first day of the year. Take year numbers from label or fields, never from the ISO date string.
locale and calendar are root props; the layouts accept their own locale override.