Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

Improve SegmentedControl docs page and block examples (#1647)

Ernest83ddae0c57f1
diff --git a/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.doc.mjs b/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.doc.mjs
new file mode 100644
index 0000000000..6b921314c9
--- /dev/null
+++ b/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.doc.mjs
@@ -0,0 +1,10 @@
+/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
+export const doc = {
+ type: 'block',
+ name: 'SegmentedControl \u2014 Fill Layout',
+ description:
+ 'Segmented control that stretches segments equally to fill the available width, useful for fixed-width containers.',
+ isReady: true,
+ aspectRatio: 4 / 3,
+ componentsUsed: ['SegmentedControl'],
+};
diff --git a/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.tsx b/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.tsx
new file mode 100644
index 0000000000..6d929438e2
--- /dev/null
+++ b/packages/cli/templates/blocks/components/SegmentedControl/SegmentedControlFillLayout.tsx
@@ -0,0 +1,24 @@
+'use client';
+
+import {useState} from 'react';
+import {
+ XDSSegmentedControl,
+ XDSSegmentedControlItem,
+} from '@xds/core/SegmentedControl';
+
+export default function SegmentedControlFillLayout() {
+ const [value, setValue] = useState('weekly');
+ return (
+ <div style={{width: 400}}>
+ <XDSSegmentedControl
+ value={value}
+ onChange={setValue}
+ label="Time range"
+ layout="fill">
+ <XDSSegmentedControlItem value="daily" label="Daily" />
+ <XDSSegmentedControlItem value="weekly" label="Weekly" />
+ <XDSSegmentedControlItem value="monthly" label="Monthly" />
+ </XDSSegmentedControl>
+ </div>
+ );
+}
diff --git a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
index 8cc473d311..b61af3c65f 100644
--- a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
+++ b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
@@ -49,6 +49,12 @@ export const docs = {
description: 'Size variant for the control.',
default: "'md'",
},
+ {
+ name: 'layout',
+ type: "'hug' | 'fill'",
+ description: 'Layout mode. hug (default) sizes segments to content; fill stretches them equally to fill the container.',
+ default: "'hug'",
+ },
{
name: 'isDisabled',
type: 'boolean',
@@ -131,6 +137,7 @@ export const docsZh = {
onChange: '选中分段时触发的回调。',
label: '单选组的无障碍标签(用作 aria-label,不会渲染为可见内容)。',
size: '控件的尺寸变体。',
+ layout: '布局模式。hug(默认)根据内容调整分段宽度;fill 将分段等宽拉伸以填满容器。',
isDisabled: '是否禁用整个控件。',
children: 'XDSSegmentedControlItem 子组件。',
xstyle: '容器的额外 StyleX 样式。',
@@ -178,6 +185,7 @@ export const docsDense = {
onChange: 'callback on segment selection',
label: 'aria-label for radio group (never rendered)',
size: 'size variant',
+ layout: 'hug (default) sizes to content; fill stretches equally',
isDisabled: 'disables entire control',
children: 'XDSSegmentedControlItem children',
xstyle: 'additional StyleX styles for container',
@@ -185,12 +193,13 @@ export const docsDense = {
components: [
{
name: 'XDSSegmentedControl',
- description: 'container; provides context (value/onChange/size/isDisabled) to children',
+ description: 'container; provides context (value/onChange/size/layout/isDisabled) to children',
propDescriptions: {
value: 'selected value (controlled)',
onChange: 'selection callback',
label: 'aria-label for radio group (not rendered)',
size: 'size variant',
+ layout: 'hug (default) sizes to content; fill stretches equally',
isDisabled: 'disables entire control',
children: 'XDSSegmentedControlItem children',
xstyle: 'extra StyleX styles',
diff --git a/packages/core/src/SegmentedControl/XDSSegmentedControl.tsx b/packages/core/src/SegmentedControl/XDSSegmentedControl.tsx
index 3731152891..3810d4bfae 100644
--- a/packages/core/src/SegmentedControl/XDSSegmentedControl.tsx
+++ b/packages/core/src/SegmentedControl/XDSSegmentedControl.tsx
@@ -16,7 +16,7 @@ import React, {useMemo, useRef, useCallback, type ReactNode} from 'react';
import * as stylex from '@stylexjs/stylex';
import {colorVars, spacingVars, radiusVars} from '../theme/tokens.stylex';
import {XDSSegmentedControlContext} from './XDSSegmentedControlContext';
-import type {XDSSegmentedControlSize} from './XDSSegmentedControlContext';
+import type {XDSSegmentedControlSize, XDSSegmentedControlLayout} from './XDSSegmentedControlContext';
import {xdsClassName, mergeProps} from '../utils';
import {useXDSSize} from '../SizeContext/XDSSizeContext';
import type {XDSBaseProps} from '../XDSBaseProps';
@@ -42,6 +42,13 @@ export interface XDSSegmentedControlProps extends Omit<
* @default 'md'
*/
size?: XDSSegmentedControlSize;
+ /**
+ * Layout mode for segment sizing.
+ * - `'hug'` (default): each segment hugs its content width.
+ * - `'fill'`: segments stretch equally to fill the container width.
+ * @default 'hug'
+ */
+ layout?: XDSSegmentedControlLayout;
/**
* Whether the entire control is disabled.
* @default false
@@ -66,6 +73,10 @@ const styles = stylex.create({
padding: 'var(--_segmented-control-padding)',
backgroundColor: colorVars['--color-neutral'],
},
+ fill: {
+ display: 'flex',
+ width: '100%',
+ },
disabled: {
opacity: 0.5,
pointerEvents: 'none',
@@ -105,6 +116,7 @@ export function XDSSegmentedControl({
onChange,
label,
size: sizeProp,
+ layout = 'hug',
isDisabled = false,
children,
xstyle,
@@ -168,8 +180,8 @@ export function XDSSegmentedControl({
);
const contextValue = useMemo(
- () => ({value, onChange, size, isDisabled}),
- [value, onChange, size, isDisabled],
+ () => ({value, onChange, size, layout, isDisabled}),
+ [value, onChange, size, layout, isDisabled],
);
return (
@@ -185,6 +197,7 @@ export function XDSSegmentedControl({
stylex.props(
styles.container,
sizeStyles[size],
+ layout === 'fill' && styles.fill,
isDisabled && styles.disabled,
xstyle,
),
diff --git a/packages/core/src/SegmentedControl/XDSSegmentedControlContext.ts b/packages/core/src/SegmentedControl/XDSSegmentedControlContext.ts
index ed2a4fed46..87ec27779a 100644
--- a/packages/core/src/SegmentedControl/XDSSegmentedControlContext.ts
+++ b/packages/core/src/SegmentedControl/XDSSegmentedControlContext.ts
@@ -13,11 +13,13 @@
import {createContext, useContext} from 'react';
export type XDSSegmentedControlSize = 'sm' | 'md' | 'lg';
+export type XDSSegmentedControlLayout = 'hug' | 'fill';
export interface XDSSegmentedControlContextValue {
value: string;
onChange: (value: string) => void;
size: XDSSegmentedControlSize;
+ layout: XDSSegmentedControlLayout;
isDisabled: boolean;
}
diff --git a/packages/core/src/SegmentedControl/XDSSegmentedControlItem.tsx b/packages/core/src/SegmentedControl/XDSSegmentedControlItem.tsx
index 8a1c0ccb87..7c786592b4 100644
--- a/packages/core/src/SegmentedControl/XDSSegmentedControlItem.tsx
+++ b/packages/core/src/SegmentedControl/XDSSegmentedControlItem.tsx
@@ -106,6 +106,10 @@ const styles = stylex.create({
cursor: 'default',
color: colorVars['--color-text-disabled'],
},
+ fill: {
+ flex: 1,
+ justifyContent: 'center',
+ },
icon: {
display: 'inline-flex',
alignItems: 'center',
@@ -163,6 +167,7 @@ export function XDSSegmentedControlItem({
const isSelected = ctx.value === value;
const isItemDisabled = isDisabled || ctx.isDisabled;
const size: XDSSegmentedControlSize = ctx.size;
+ const isFill = ctx.layout === 'fill';
const handleClick = useCallback(() => {
if (!isItemDisabled && !isSelected) {
@@ -193,6 +198,7 @@ export function XDSSegmentedControlItem({
stylex.props(
styles.base,
sizeStyles[size],
+ isFill && styles.fill,
isSelected && styles.selected,
!isSelected && !isItemDisabled && styles.hover,
isItemDisabled && styles.disabled,
diff --git a/packages/core/src/SegmentedControl/index.ts b/packages/core/src/SegmentedControl/index.ts
index 5f722299f0..85293d580c 100644
--- a/packages/core/src/SegmentedControl/index.ts
+++ b/packages/core/src/SegmentedControl/index.ts
@@ -15,4 +15,4 @@ export type {XDSSegmentedControlProps} from './XDSSegmentedControl';
export {XDSSegmentedControlItem} from './XDSSegmentedControlItem';
export type {XDSSegmentedControlItemProps} from './XDSSegmentedControlItem';
-export type {XDSSegmentedControlSize} from './XDSSegmentedControlContext';
+export type {XDSSegmentedControlSize, XDSSegmentedControlLayout} from './XDSSegmentedControlContext';