Skip to content

Commit d70d2d0

Browse files
committed
docs(segments): 📝 add docs
1 parent 439c3ae commit d70d2d0

File tree

4 files changed

+8
-2
lines changed

4 files changed

+8
-2
lines changed

docs/datefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export default DateFieldBasic;
9595

9696
| Name | Type | Description |
9797
| :------------ | :-------------------------- | :--------------------------------------------------- |
98-
| **`segment`** | <code>DateSegment</code> | |
98+
| **`segment`** | <code>DateSegment</code> | Current segment state return from `state.segments`. |
9999
| **`state`** | <code>DateFieldState</code> | Object returned by the `useDateFieldBaseState` hook. |
100100

101101
### `DateFieldOptions`

docs/timefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export default TimeFieldBasic;
9494

9595
| Name | Type | Description |
9696
| :------------ | :-------------------------- | :--------------------------------------------------- |
97-
| **`segment`** | <code>DateSegment</code> | |
97+
| **`segment`** | <code>DateSegment</code> | Current segment state return from `state.segments`. |
9898
| **`state`** | <code>DateFieldState</code> | Object returned by the `useTimeFieldBaseState` hook. |
9999

100100
### `TimeFieldOptions`

src/datefield/date-segment.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export const DateSegment = createComponent<DateSegmentOptions>(props => {
3131
});
3232

3333
export type DateSegmentOptions<T extends As = "div"> = Options<T> & {
34+
/**
35+
* Current segment state return from `state.segments`.
36+
*/
3437
segment: DateSegmentState;
3538
/**
3639
* Object returned by the `useDateFieldBaseState` hook.

src/timefield/time-segment.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export const TimeSegment = createComponent<TimeSegmentOptions>(props => {
3131
});
3232

3333
export type TimeSegmentOptions<T extends As = "div"> = Options<T> & {
34+
/**
35+
* Current segment state return from `state.segments`.
36+
*/
3437
segment: DateSegmentState;
3538
/**
3639
* Object returned by the `useTimeFieldBaseState` hook.

0 commit comments

Comments
 (0)