diff --git a/docs/datefield.md b/docs/datefield.md index ac47b1fe3..fd975e0c9 100644 --- a/docs/datefield.md +++ b/docs/datefield.md @@ -95,7 +95,7 @@ export default DateFieldBasic; | Name | Type | Description | | :------------ | :-------------------------- | :--------------------------------------------------- | -| **`segment`** | DateSegment | | +| **`segment`** | DateSegment | Current segment state return from `state.segments`. | | **`state`** | DateFieldState | Object returned by the `useDateFieldBaseState` hook. | ### `DateFieldOptions` diff --git a/docs/timefield.md b/docs/timefield.md index 7b5a85a9b..9b59d160a 100644 --- a/docs/timefield.md +++ b/docs/timefield.md @@ -94,7 +94,7 @@ export default TimeFieldBasic; | Name | Type | Description | | :------------ | :-------------------------- | :--------------------------------------------------- | -| **`segment`** | DateSegment | | +| **`segment`** | DateSegment | Current segment state return from `state.segments`. | | **`state`** | DateFieldState | Object returned by the `useTimeFieldBaseState` hook. | ### `TimeFieldOptions` diff --git a/src/datefield/date-segment.ts b/src/datefield/date-segment.ts index eb387dc57..8af8a15d7 100644 --- a/src/datefield/date-segment.ts +++ b/src/datefield/date-segment.ts @@ -31,6 +31,9 @@ export const DateSegment = createComponent(props => { }); export type DateSegmentOptions = Options & { + /** + * Current segment state return from `state.segments`. + */ segment: DateSegmentState; /** * Object returned by the `useDateFieldBaseState` hook. diff --git a/src/timefield/time-segment.ts b/src/timefield/time-segment.ts index 3ffe2f1af..e20974ce6 100644 --- a/src/timefield/time-segment.ts +++ b/src/timefield/time-segment.ts @@ -31,6 +31,9 @@ export const TimeSegment = createComponent(props => { }); export type TimeSegmentOptions = Options & { + /** + * Current segment state return from `state.segments`. + */ segment: DateSegmentState; /** * Object returned by the `useTimeFieldBaseState` hook.