An open source design system that's fully customizable and agent ready
TypeScript
docs(storybook): add missing @example blocks to 5 exported components (#1560)
Joey8a7ff255dd5e
diff --git a/packages/core/src/Chat/XDSChatComposer.tsx b/packages/core/src/Chat/XDSChatComposer.tsxindex 5dab081986..ba4d84a5e9 100644--- a/packages/core/src/Chat/XDSChatComposer.tsx+++ b/packages/core/src/Chat/XDSChatComposer.tsx@@ -249,6 +249,18 @@ const styles = stylex.create({// Component// =============================================================================+/**+ * Layout shell for a chat composer with slots for attachments, input,+ * actions, and a send button.+ *+ * @example+ * ```+ * <XDSChatComposer+ * onSubmit={(value) => console.log(value)}+ * placeholder="Type a message..."+ * />+ * ```+ */export function XDSChatComposer(props: XDSChatComposerProps) {const {onSubmit,diff --git a/packages/core/src/Chat/XDSChatComposerAttachments.tsx b/packages/core/src/Chat/XDSChatComposerAttachments.tsxindex f7c638b15b..58a81baa35 100644--- a/packages/core/src/Chat/XDSChatComposerAttachments.tsx+++ b/packages/core/src/Chat/XDSChatComposerAttachments.tsx@@ -188,6 +188,18 @@ const styles = stylex.create({},});+/**+ * Container for attachment previews inside a chat composer.+ * Supports collapsible behavior with a count badge.+ *+ * @example+ * ```+ * <XDSChatComposerAttachments count={3}>+ * <AttachmentThumbnail />+ * <AttachmentThumbnail />+ * </XDSChatComposerAttachments>+ * ```+ */export function XDSChatComposerAttachments({ref,children,diff --git a/packages/core/src/Chat/XDSChatDictationButton.tsx b/packages/core/src/Chat/XDSChatDictationButton.tsxindex 3db2d1630c..8c0f0544ea 100644--- a/packages/core/src/Chat/XDSChatDictationButton.tsx+++ b/packages/core/src/Chat/XDSChatDictationButton.tsx@@ -84,6 +84,15 @@ const SIZE_CONFIG = {// Component// =============================================================================+/**+ * Microphone button for voice input in a chat composer.+ * Requires the return value of useXDSChatDictation.+ *+ * @example+ * ```+ * <XDSChatDictationButton dictation={dictation} />+ * ```+ */export function XDSChatDictationButton({dictation,size = 'md',@@ -117,18 +126,22 @@ export function XDSChatDictationButton({{isListening && (<spanaria-hidden- {...mergeProps(stylex.props(styles.barsContainer), {style: {gap: barGap, height: barMaxHeight}})}>+ {...mergeProps(stylex.props(styles.barsContainer), {+ style: {gap: barGap, height: barMaxHeight},+ })}>{boostedBands.slice(0, BAR_COUNT).map((level, i) => {const scale = BAR_MIN_SCALE + level * (1 - BAR_MIN_SCALE);return (<spankey={i}- {...mergeProps(stylex.props(styles.bar), {style: {- width: barWidth,- height: '100%',- backgroundColor: barColor,- transform: `scaleY(${scale})`,- }})}+ {...mergeProps(stylex.props(styles.bar), {+ style: {+ width: barWidth,+ height: '100%',+ backgroundColor: barColor,+ transform: `scaleY(${scale})`,+ },+ })}/>);})}diff --git a/packages/core/src/Chat/XDSChatLayoutScrollButton.tsx b/packages/core/src/Chat/XDSChatLayoutScrollButton.tsxindex 50ff2c7c09..70efbb827d 100644--- a/packages/core/src/Chat/XDSChatLayoutScrollButton.tsx+++ b/packages/core/src/Chat/XDSChatLayoutScrollButton.tsx@@ -86,6 +86,14 @@ const styles = stylex.create({// Component// =============================================================================+/**+ * Floating scroll-to-bottom button for use inside XDSChatLayout.+ *+ * @example+ * ```+ * <XDSChatLayoutScrollButton isVisible={!isAtBottom} onClick={scrollToBottom} />+ * ```+ */export function XDSChatLayoutScrollButton({isVisible,label,diff --git a/packages/core/src/CodeBlock/XDSCodeBlock.tsx b/packages/core/src/CodeBlock/XDSCodeBlock.tsxindex c09c84f662..cc0a73b2e4 100644--- a/packages/core/src/CodeBlock/XDSCodeBlock.tsx+++ b/packages/core/src/CodeBlock/XDSCodeBlock.tsx@@ -511,6 +511,15 @@ function RangeCodeContent({// Main component// ---------------------------------------------------------------------------+/**+ * Read-only code display with syntax highlighting, line numbers,+ * and optional copy button.+ *+ * @example+ * ```+ * <XDSCodeBlock code="const x = 42;" language="javascript" />+ * ```+ */export function XDSCodeBlock({code,language = 'plaintext',