Skip to content

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

TypeScript

docs(common-props): add stylex.create() guidance to 4 remaining xstyle props (#1988)

Joey78f9bd82fab2
diff --git a/packages/core/src/Chat/Chat.doc.mjs b/packages/core/src/Chat/Chat.doc.mjs
index 7cc901eb07..c97b10ca0d 100644
--- a/packages/core/src/Chat/Chat.doc.mjs
+++ b/packages/core/src/Chat/Chat.doc.mjs
@@ -147,7 +147,7 @@ export const docs = {
{name: 'sendIcon', type: 'ReactNode', description: 'Custom icon for the send state. Defaults to arrowUp from icon registry.'},
{name: 'stopIcon', type: 'ReactNode', description: 'Custom icon for the stop state. Defaults to stop from icon registry.'},
{name: 'size', type: "'sm' | 'md'", description: 'Button size.', default: "'md'"},
- {name: 'xstyle', type: 'StyleXStyles', description: 'Additional StyleX styles.'},
+ {name: 'xstyle', type: 'StyleXStyles', description: 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value — not an inline style object like style={{}}.'},
],
},
{
diff --git a/packages/core/src/Chat/ChatDictationButton.doc.mjs b/packages/core/src/Chat/ChatDictationButton.doc.mjs
index 7fbbd3c599..65cc995ab5 100644
--- a/packages/core/src/Chat/ChatDictationButton.doc.mjs
+++ b/packages/core/src/Chat/ChatDictationButton.doc.mjs
@@ -54,7 +54,7 @@ export const docs = {
{
name: 'xstyle',
type: 'StyleXStyles',
- description: 'Additional StyleX styles applied to the wrapper.',
+ description: 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value — not an inline style object like style={{}}.',
},
],
diff --git a/packages/core/src/Layer/Layer.doc.mjs b/packages/core/src/Layer/Layer.doc.mjs
index 33996adaec..a7f01a0891 100644
--- a/packages/core/src/Layer/Layer.doc.mjs
+++ b/packages/core/src/Layer/Layer.doc.mjs
@@ -26,7 +26,7 @@ export const docs = {
name: 'xstyle',
type: 'StyleXStyles',
description:
- 'StyleX styles for layout customization.',
+ 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value — not an inline style object like style={{}}.',
},
],
usage: {
diff --git a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
index b61af3c65f..535b416a99 100644
--- a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
+++ b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
@@ -70,7 +70,7 @@ export const docs = {
{
name: 'xstyle',
type: 'StyleXStyles',
- description: 'Additional StyleX styles for the container.',
+ description: 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value — not an inline style object like style={{}}.',
},
], },
{