Skip to content

[docs-update] Update docs for DateField firstDayOfWeek prop #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IzumiSy merged 5 commits into from
Jul 16, 2026
+16 −15
Merged

[docs-update] Update docs for DateField firstDayOfWeek prop #386

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39e90c1
docs: add firstDayOfWeek to DateFieldProps table
github-actions[bot] Jul 15, 2026
5f9a42c
Merge branch 'main' into docs/update-date-field-first-day-of-week-3b5…
IzumiSy Jul 16, 2026
6fae36e
Merge branch 'main' into docs/update-date-field-first-day-of-week-3b5…
interacsean Jul 16, 2026
685f8ab
Merge branch 'main' into docs/update-date-field-first-day-of-week-3b5…
IzumiSy Jul 16, 2026
dadca1d
fix(docs): reformat date-picker.md table to pass oxfmt check
Copilot Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions docs/components/date-picker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,21 +116,22 @@ The tables below list props this variant **actually implements** for v1 (date gr

### DateFieldProps

| Prop | Type | Description |
| ----------------------------------------- | -------------------------------- | ----------------------------------------------------------------------- |
| `label` | `LocalizedString` | Field label |
| `description` | `LocalizedString` | Helper text below the field |
| `errorMessage` | `LocalizedString` | Error text; also sets the invalid state |
| `value` / `defaultValue` | `DateValue \| null` | Controlled / uncontrolled value (`CalendarDate` at date granularity) |
| `onChange` | `(v: DateValue \| null) => void` | Fires on a complete, valid value; `null` when cleared |
| `isDisabled` / `isReadOnly` / `isInvalid` | `boolean` | State flags |
| `isRequired` | `boolean` | Sets `aria-required` on the segments (no visual required indicator yet) |
| `placeholderValue` | `DateValue` | Seeds unset segments (increment start + segment order) |
| `autoFocus` | `boolean` | Focus the first segment on mount |
| `locale` | `string` | BCP-47 locale override (defaults to the AppShell formatting locale) |
| `name` | `string` | Emits a hidden `<input>` with the ISO value for form submission |
| `aria-label` | `string` | Accessible name when there's no visible `label` (e.g. compact filters) |
| `className` | `string` | Root element class |
| Prop | Type | Description |
| ----------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `label` | `LocalizedString` | Field label |
| `description` | `LocalizedString` | Helper text below the field |
| `errorMessage` | `LocalizedString` | Error text; also sets the invalid state |
| `value` / `defaultValue` | `DateValue \| null` | Controlled / uncontrolled value (`CalendarDate` at date granularity) |
| `onChange` | `(v: DateValue \| null) => void` | Fires on a complete, valid value; `null` when cleared |
| `isDisabled` / `isReadOnly` / `isInvalid` | `boolean` | State flags |
| `isRequired` | `boolean` | Sets `aria-required` on the segments (no visual required indicator yet) |
| `placeholderValue` | `DateValue` | Seeds unset segments (increment start + segment order) |
| `autoFocus` | `boolean` | Focus the first segment on mount |
| `locale` | `string` | BCP-47 locale override (defaults to the AppShell formatting locale) |
| `name` | `string` | Emits a hidden `<input>` with the ISO value for form submission |
| `firstDayOfWeek` | `"sun" \| "mon" \| "tue" \| "wed" \| "thu" \| "fri" \| "sat"` | Override the locale's week start for the `w`/`k` keyboard shortcuts; omit to follow the locale |
| `aria-label` | `string` | Accessible name when there's no visible `label` (e.g. compact filters) |
| `className` | `string` | Root element class |

> `DateField` has no calendar, so `minValue` / `maxValue` / `isDateUnavailable` don't apply to it — they're honoured by `DatePicker` and `Calendar` below.

Expand Down
Loading