Skip to content

README.md

Latest commit

 

History

History
49 lines (37 loc) · 3.15 KB

README.md

File metadata and controls

49 lines (37 loc) · 3.15 KB
Raw

Component Reference

Updated for 1.4.x. Props tables are literal mirrors of src/index.d.ts.

Components

Component Summary Props page
Calendar Bare calendar month view; single-date or range selection calendar.md
DateRange Two-input date range with onChange(rangesByKey) date-range.md
DateRangePicker DateRange + DefinedRange preset sidebar + preview date-range-picker.md
DefinedRange Preset ranges + custom input ranges sidebar defined-range.md
DatePickerInput Single-date popover trigger date-picker-input.md
DateRangeInput Range popover trigger with DateRangeInputRef date-range-input.md

Shared types

Types used across multiple components live on a single page — link there instead of duplicating:

Type Used by Definition
Range All components types.md
RangeKeyDict DateRange, DateRangePicker, DateRangeInput, DefinedRange types.md
RangeFocus Calendar, DateRange, DateRangePicker, DefinedRange types.md
Preview Calendar, DateRangePicker types.md
ClassNames All components types.md
AriaLabelsShape Calendar, DateRangePicker types.md
ScrollOptions Calendar types.md
StaticRange DefinedRange types.md
InputRange DefinedRange types.md
DateInputProps Calendar (internal DateDisplay contract) types.md

DateInput (DateInputProps) is a type-only export. The DateInput function itself is not in the runtime barrel — it is used internally by DateDisplay for the editable-date-input feature. Do not import it at runtime.

Maintenance checklist

When a component prop is added, removed, or renamed in src/index.d.ts:

  1. Find the corresponding [Component]Props interface in src/index.d.ts (line numbers are annotated in each props page).
  2. Mirror every row exactly: Prop name, Type (signature verbatim), Default (from default: JSDoc tag), Required (no unless the prop has no default and no ? in the type).
  3. Do not add, remove, or rephrase prop descriptions — copy the JSDoc verbatim.
  4. Run git diff --check before committing to catch trailing whitespace.

See also