docs(segments): 📝 add docs

adaptui · Jul 25, 2022 · d70d2d0 · d70d2d0 · vercel · Jul 25, 2022
1 parent 439c3ae
commit d70d2d0
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/docs/datefield.md b/docs/datefield.md
@@ -95,7 +95,7 @@ export default DateFieldBasic;
 
 | Name | Type | Description |
 | :------------ | :-------------------------- | :--------------------------------------------------- |
-| **`segment`** | <code>DateSegment</code> |   |
+| **`segment`** | <code>DateSegment</code> | Current segment state return from `state.segments`. |
 | **`state`** | <code>DateFieldState</code> | Object returned by the `useDateFieldBaseState` hook. |
 
 ### `DateFieldOptions`

diff --git a/docs/timefield.md b/docs/timefield.md
@@ -94,7 +94,7 @@ export default TimeFieldBasic;
 
 | Name | Type | Description |
 | :------------ | :-------------------------- | :--------------------------------------------------- |
-| **`segment`** | <code>DateSegment</code> |   |
+| **`segment`** | <code>DateSegment</code> | Current segment state return from `state.segments`. |
 | **`state`** | <code>DateFieldState</code> | Object returned by the `useTimeFieldBaseState` hook. |
 
 ### `TimeFieldOptions`

diff --git a/src/datefield/date-segment.ts b/src/datefield/date-segment.ts
@@ -31,6 +31,9 @@ export const DateSegment = createComponent<DateSegmentOptions>(props => {
 });
 
 export type DateSegmentOptions<T extends As = "div"> = Options<T> & {
+ /**
+ * 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
@@ -31,6 +31,9 @@ export const TimeSegment = createComponent<TimeSegmentOptions>(props => {
 });
 
 export type TimeSegmentOptions<T extends As = "div"> = Options<T> & {
+ /**
+ * Current segment state return from `state.segments`.
+ */
  segment: DateSegmentState;
  /**
  * Object returned by the `useTimeFieldBaseState` hook.