From d70d2d02e6b4f4357e6518e3fa975e903bcd90a8 Mon Sep 17 00:00:00 2001
From: Navin Moorthy <navin007.a@gmail.com>
Date: Mon, 25 Jul 2022 19:28:00 +0530
Subject: [PATCH] =?UTF-8?q?docs(segments):=20=F0=9F=93=9D=20add=20docs?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/datefield.md             | 2 +-
 docs/timefield.md             | 2 +-
 src/datefield/date-segment.ts | 3 +++
 src/timefield/time-segment.ts | 3 +++
 4 files changed, 8 insertions(+), 2 deletions(-)

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`** | <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
index 7b5a85a9b..9b59d160a 100644
--- 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
index eb387dc57..8af8a15d7 100644
--- 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
index 3ffe2f1af..e20974ce6 100644
--- 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.