@redis-ui/components 46.1.2 → 47.0.0

package/skills/redis-ui-components/references/DatePicker.md

@@ -1,52 +0,0 @@
-# DatePicker
-
-Calendar date pickers built on top of `react-day-picker`. Two components are exported: `DatePicker` for selecting a single day and `RangeDatePicker` for selecting a date range.
-
-> **Deprecated:** `DatePicker` is annotated as deprecated and will be removed in a future version. Prefer the standard application date input or a newer replacement when one becomes available.
-
-## Import
-
-```tsx
-import { DatePicker, RangeDatePicker } from '@redis-ui/components';
-import type { DateRange } from '@redis-ui/components';
-```
-
-## DatePicker Props
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| fromYear | `number` | internal default | Earliest year shown in the year dropdown. |
-| toYear | `number` | internal default | Latest year shown in the year dropdown. |
-| onSingleSelect | `DayPickerSingleProps['onSelect']` | - | Callback fired when a day is selected. Receives the `react-day-picker` single-select payload. |
-| selectedDay | `Date` | - | Currently selected day. |
-| showSelected | `boolean` | - | When `true`, the calendar opens on the month containing `selectedDay`. |
-
-The props above are the typed `DatePickerProps` surface. At runtime, any additional props are spread onto the underlying `react-day-picker` `DayPicker` (single mode), but they are not part of the exported TypeScript type.
-
-## RangeDatePicker Props
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| fromYear | `number` | internal default | Earliest year shown in the year dropdown. |
-| toYear | `number` | internal default | Latest year shown in the year dropdown. |
-| onRangeSelect | `DayPickerRangeProps['onSelect']` | - | Callback fired when the range changes. Receives the `react-day-picker` range payload. |
-| selectedRange | `DateRange` (`{ from?: Date; to?: Date }`) | - | Currently selected range. |
-| numberOfMonths | `number` | `2` | Number of months rendered side-by-side. |
-| showSelected | `boolean` | - | When `true`, the calendar opens on the month containing `selectedRange.from` (or `selectedRange.to`). |
-
-The props above are the typed `RangeDatePickerProps` surface. At runtime, any additional props are spread onto the underlying `react-day-picker` `DayPicker` (range mode), but they are not part of the exported TypeScript type.
-
-## Types
-
-- `DateRange` re-exports `react-day-picker`'s `DateRange` type.
-
-## Examples
-
-> The `DatePicker` package does not ship Storybook stories, so no canonical usage examples are documented here. Refer to the [`react-day-picker` documentation](https://react-day-picker.js.org/) for general calendar behavior; the props above are the only Redis-specific surface.
-
-## Notes
-
-- Both components hard-code `captionLayout="dropdown-buttons"`, `fixedWeeks`, and `weekStartsOn={1}` (Monday) on the underlying day picker.
-- Custom navigation arrows and the year/month dropdown are provided internally and use design-system tokens; consumers cannot override them.
-- Selection state is fully controlled through `selectedDay` / `selectedRange` and the corresponding `on*Select` callbacks.
-- `showSelected` only affects the initial visible month; it does not change the selection.