chore: Document options limit on segmented control (#3586)

timogasda · web-flow · commit 294fe9e2fb52 · 2025-06-20T07:14:02.000Z
diff --git a/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap b/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap
@@ -15780,7 +15780,8 @@ the label is visible and attached to the select component, unless \`ariaLabelled
       "type": "string",
     },
     {
-      "description": "An array of objects representing options. Each segment has the following properties:
+      "description": "An array of objects representing options. Only up to 6 options are supported.
+Each segment has the following properties:
 
 - \`id\` (string) - The ID of the segment.
 - \`disabled\` [boolean] - (Optional) Determines whether the segment is disabled, which prevents the user from selecting it.
diff --git a/src/segmented-control/interfaces.ts b/src/segmented-control/interfaces.ts
@@ -13,7 +13,8 @@ export interface SegmentedControlProps extends BaseComponentProps {
   selectedId: string | null;
 
   /**
-   * An array of objects representing options. Each segment has the following properties:
+   * An array of objects representing options. Only up to 6 options are supported.
+   * Each segment has the following properties:
    *
    * - `id` (string) - The ID of the segment.
    * - `disabled` [boolean] - (Optional) Determines whether the segment is disabled, which prevents the user from selecting it.

Original file line number	Diff line number	Diff line change
@@ -15780,7 +15780,8 @@ the label is visible and attached to the select component, unless \`ariaLabelled
`15780`	`15780`	`"type": "string",`
`15781`	`15781`	`},`
`15782`	`15782`	`{`
`15783`		`- "description": "An array of objects representing options. Each segment has the following properties:`
	`15783`	`+ "description": "An array of objects representing options. Only up to 6 options are supported.`
	`15784`	`+Each segment has the following properties:`
`15784`	`15785`
`15785`	`15786`	- \`id\` (string) - The ID of the segment.
`15786`	`15787`	- \`disabled\` [boolean] - (Optional) Determines whether the segment is disabled, which prevents the user from selecting it.
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,8 @@ export interface SegmentedControlProps extends BaseComponentProps {`
`13`	`13`	`selectedId: string \| null;`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * An array of objects representing options. Each segment has the following properties:`
	`16`	`+ * An array of objects representing options. Only up to 6 options are supported.`
	`17`	`+ * Each segment has the following properties:`
`17`	`18`	`*`
`18`	`19`	* - `id` (string) - The ID of the segment.
`19`	`20`	* - `disabled` [boolean] - (Optional) Determines whether the segment is disabled, which prevents the user from selecting it.