# DatePicker

> Organism — orn-ui

> ⚠️ Requires <UIProvider>: This component (like every orn-ui component) must render inside a <UIProvider> ancestor, or it throws at runtime. See https://orn-ui-docs.vercel.app/getting-started.md

> Runs on Expo SDK 54, 55, 56 and 57, and on bare React Native >=0.81 with react >=19.1. No native modules — works in Expo Go, no prebuild.

## Installation

Install just this component (copies the source into your project, no npm dependency)
```bash
npx orn-ui add date-picker
```

Or install the whole package and import it
```tsx
pnpm add orn-ui
import { DatePicker } from 'orn-ui/date-picker';
```

Depends on: core (theme + icons), icon-button, pressable-scale

## Variants

### Inline calendar

```tsx
<DatePicker value={date} onChange={setDate} />
```

### mode="range" — tap start, then end

```tsx
<View style={{ gap: 8 }}>
  <DatePicker mode="range" range={range} onRangeChange={setRange} />
  <Caption>
    {range?.start
      ? `${range.start.toDateString()} → ${range.end ? range.end.toDateString() : '…'}`
      : 'No range selected'}
  </Caption>
</View>
```

### mode="range" + minDate/maxDate

```tsx
<DatePicker mode="range" range={range} onRangeChange={setRange} minDate={today} maxDate={inAMonth} />
```

### minDate / maxDate (next 7 days only)

```tsx
<DatePicker value={ranged} onChange={setRanged} minDate={today} maxDate={inAWeek} />
```

### Week starts on Monday

```tsx
<DatePicker value={date} onChange={setDate} firstDayOfWeek={1} />
```

### Localized month/weekday names

```tsx
<DatePicker
  value={date}
  onChange={setDate}
  monthNames={SPANISH_MONTHS}
  weekdayNames={SPANISH_WEEKDAYS}
  firstDayOfWeek={1}
/>
```

## Full demo source

```tsx
const variants: VariantDef[] = [
  {
    label: 'Inline calendar',
    content: <DatePicker value={date} onChange={setDate} />,
  },
  {
    label: 'mode="range" — tap start, then end',
    content: (
      <View style={{ gap: 8 }}>
        <DatePicker mode="range" range={range} onRangeChange={setRange} />
        <Caption>
          {range?.start
            ? `${range.start.toDateString()} → ${range.end ? range.end.toDateString() : '…'}`
            : 'No range selected'}
        </Caption>
      </View>
    ),
  },
  {
    label: 'mode="range" + minDate/maxDate',
    content: <DatePicker mode="range" range={range} onRangeChange={setRange} minDate={today} maxDate={inAMonth} />,
  },
  {
    label: 'minDate / maxDate (next 7 days only)',
    content: <DatePicker value={ranged} onChange={setRanged} minDate={today} maxDate={inAWeek} />,
  },
  {
    label: 'Week starts on Monday',
    content: <DatePicker value={date} onChange={setDate} firstDayOfWeek={1} />,
  },
  {
    label: 'Localized month/weekday names',
    content: (
      <DatePicker
        value={date}
        onChange={setDate}
        monthNames={SPANISH_MONTHS}
        weekdayNames={SPANISH_WEEKDAYS}
        firstDayOfWeek={1}
      />
    ),
  },
  {
    label: 'DateField — input that opens the calendar',
    content: <DateField label="Due date" value={fieldDate} onChange={setFieldDate} maxDate={inAMonth} />,
  },
  {
    label: 'DateField — custom format',
    content: (
      <DateField
        label="ISO format"
        value={fieldDate}
        onChange={setFieldDate}
        format={(d) => d.toISOString().slice(0, 10)}
      />
    ),
  },
  {
    label: 'DateField — onClear renders the clear button',
    content: (
      <DateField
        label="Due date"
        value={fieldDate}
        onChange={setFieldDate}
        onClear={() => setFieldDate(undefined)}
      />
    ),
  },
  {
    label: 'DateField — mode="range", closes when the range closes',
    content: <DateField label="Stay" mode="range" range={fieldRange} onRangeChange={setFieldRange} />,
  },
  {
    label: 'DateField — required + error',
    content: <DateField label="Due date" required onChange={() => {}} error="Pick a date to continue" />,
  },
  {
    label: 'DateField — disabled',
    content: <DateField label="Locked" value={today} onChange={() => {}} disabled />,
  },
];
return <VariantList variants={variants} />;
```

## Props

| Name | Type | Default | Description |
|---|---|---|---|
| `mode?` | `'single' \| 'range'` | single | 'single' picks one date; 'range' picks an interval with two taps. |
| `value?` | `Date` | — | Date picked in mode="single". |
| `onChange?` | `(date: Date) => void` | — | Called in mode="single". |
| `range?` | `DateRange` | — | Range picked in mode="range". |
| `onRangeChange?` | `(range: DateRange) => void` | — | Called in mode="range", both when setting the start and when closing the range. |
| `minDate?` | `Date` | — | — |
| `maxDate?` | `Date` | — | — |
| `defaultMonth?` | `Date` | today | Month shown on open when there is no `value`. |
| `monthNames?` | `string[]` | those from `useLabels()` | Month names. |
| `weekdayNames?` | `string[]` | those from `useLabels()` | Day initials, index 0 = Sunday. |
| `firstDayOfWeek?` | `0 \| 1` | 0 | 0 = Sunday, 1 = Monday. |
| `onVisibleMonthChange?` | `(month: Date) => void` | — | Reports which month became visible when navigating with the arrows. |
| `style?` | `StyleProp<ViewStyle>` | — | — |