Styling Components
How to customize component appearance: xstyle prop, Tailwind, StyleX, className, rest props, compound component patterns, and theming hooks.Overview
There are several ways to style things. Here is when to use each:| Approach | Use for | Example |
|---|---|---|
| xstyle prop | Overriding a specific component | xstyle={styles.override} |
| Tailwind utilities | Layout, wrappers, and utility styling | className="flex gap-3 p-4" |
| stylex.create | Reusable styles, pseudo-classes, typed tokens | stylex.create({ card: { ... } }) |
| className | Integrating with external CSS or Tailwind on components | className="my-card shadow-lg" |
xstyle Prop
Every component accepts an xstyle prop for style customization. It accepts StyleX styles created via stylex.create(), not inline objects or class name strings. StyleX styles are compiled at build time for optimal deduplication and dead-code elimination.Simple overrides
tsximport * as stylex from '@stylexjs/stylex';const overrides = stylex.create({card: { maxWidth: 400, marginBlock: 16 },saveButton: { alignSelf: 'flex-end' },});<XDSCard xstyle={overrides.card} /><XDSButton label="Save" xstyle={overrides.saveButton} />
Pseudo-classes and conditional styles
tsximport * as stylex from '@stylexjs/stylex';const overrides = stylex.create({card: {boxShadow: {default: 'none',':hover': { '@media (hover: hover)': '0 4px 12px rgba(0,0,0,0.1)' },},},});<XDSCard xstyle={overrides.card}>...</XDSCard>
- All xstyle values must come from stylex.create()
- Pseudo-classes (:hover, :focus-visible) are supported inside stylex.create
- All :hover styles MUST use @media (hover: hover) guard
- For non-StyleX styling (Tailwind, external CSS), use className instead
Tailwind Integration
The design system ships a Tailwind v4 theme bridge that maps all design tokens to Tailwind utility classes. Import it once and use Tailwind classes backed by design tokens: colors, spacing, radius, shadows, and typography all resolve to the active theme.globals.css: import the bridge
css@import "tailwindcss";@import "@xds/core/tailwind-theme.css" layer(theme);
Tailwind utilities alongside components
The bridge is pure CSS with zero JS. Theme changes (dark mode, custom themes) apply automatically because the utilities reference the same CSS custom properties that components use.tsx<div className="text-primary bg-surface rounded-container p-4 flex gap-3"><XDSButton label="Save" variant="primary" /><XDSButton label="Cancel" variant="secondary" /></div>
className and style Props
Every component also accepts standard className and style props. className is appended after the component's own classes. style is merged after StyleX inline styles, so consumer values win on conflict.className with Tailwind utilities
For layout and wrapper styling, Tailwind utilities on className work well. For component-specific overrides (padding, colors, borders), prefer xstyle; it integrates with StyleX deduplication and the component's internal style pipeline.tsx<XDSCard className="shadow-lg hover:shadow-xl transition-shadow">...</XDSCard><XDSButton label="Save" className="my-app-save-btn" />
Rest Props (Prop Drilling)
Components extend HTML attributes and spread rest props onto their root DOM element. This means data-* attributes, aria-* attributes, event handlers, and other HTML props pass through automatically.Data attributes, event handlers, and ARIA
tsx<XDSCarddata-testid="user-card"data-user-id={user.id}onMouseEnter={handleHover}aria-label="User profile card">...</XDSCard>
Ref forwarding
A few HTML attributes are intentionally omitted from the base type (contentEditable, dangerouslySetInnerHTML). children is not in the base type either; components that accept children declare it explicitly, so slot-based components don't silently drop JSX children.tsxconst cardRef = useRef<HTMLDivElement>(null);<XDSCard ref={cardRef}>...</XDSCard>
Compound Components
Complex components are composed from smaller components. Each sub-component accepts its own xstyle, className, and rest props. You style the parts individually; there's no single "drill into sub-part" prop.Dialog with individually styled parts
The pattern: the parent component (Dialog) controls structure and behavior, child components (Layout, Header, Button) control their own appearance. Style each piece where it lives.tsximport * as stylex from '@stylexjs/stylex';const overrides = stylex.create({dialog: { maxWidth: 500 },content: { gap: 'var(--spacing-4)' },});<XDSDialog isOpen={isOpen} onClose={close} xstyle={overrides.dialog}><XDSLayoutheader={<XDSLayoutHeader hasDivider><XDSHeading level={2}>Edit Profile</XDSHeading></XDSLayoutHeader>}content={<XDSLayoutContent xstyle={overrides.content}><XDSTextInput label="Name" value={name} onChange={setName} /></XDSLayoutContent>}footer={<XDSLayoutFooter hasDivider><XDSButton label="Cancel" variant="secondary" onClick={close} /><XDSButton label="Save" variant="primary" onClick={save} /></XDSLayoutFooter>}/></XDSDialog>
Preferred Selector Surface: Data Attributes
When external CSS needs to target an XDS component by prop or state, combine the stable component class with reflected data attributes. The component class identifies the component (.xds-button, .xds-card); data attributes identify the axis and value (data-variant, data-size, data-level, etc.). This is the preferred selector surface for new CSS because it is explicit and collision-resistant.css.my-app .xds-button[data-variant="primary"] {/* primary buttons in this app context */}.my-app .xds-button[data-variant="primary"][data-size="sm"] {/* small primary buttons */}.my-app .xds-heading[data-level="2"] {/* level 2 headings; numeric values stay literal in data attrs */}
What components reflect
For systematic theming, use defineTheme component overrides instead of raw CSS selectors. defineTheme keeps the higher-level tsx// <XDSButton variant="primary" size="sm" />// preferred selector attrs: data-variant="primary" data-size="sm"// <XDSCard variant="elevated" />// preferred selector attrs: data-variant="elevated"// <XDSHeading level={2} />// preferred selector attrs: data-level="2"
prop:value API (variant:primary, size:sm) and handles selector generation for you. Run npx xds docs theme for the full theming guide.Deprecated: Bare Prop and State Classes
XDS still emits legacy bare prop/state classes such as.primary, .sm, .level-2, and .checked for compatibility with existing apps and built themes. Do not write new CSS against these bare classes. The stable base component classes (.xds-button, .xds-card, etc.) are not deprecated; only the unprefixed prop/state classes are the legacy surface.css/* Deprecated compatibility selector — avoid in new CSS */.my-app .xds-button.primary {/* use .xds-button[data-variant="primary"] instead */}/* Deprecated compatibility selector — avoid in new CSS */.my-app .xds-heading.level-2 {/* use .xds-heading[data-level="2"] instead */}
Design Tokens
When writing custom styles, use design tokens instead of hardcoded values. Tokens are CSS custom properties that adapt to the active theme and color mode. The design system provides tokens for spacing, color, radius, shadow, typography, and size.Using tokens in stylex.create
tsximport * as stylex from '@stylexjs/stylex';const styles = stylex.create({surface: {padding: 'var(--spacing-4)',borderRadius: 'var(--radius-container)',backgroundColor: 'var(--color-background-surface)',},});<XDSCard xstyle={styles.surface} />
Using typed token imports in stylex.create
Both approaches work: var() strings or typed imports from tokens.stylex. The typed imports give autocomplete and catch typos at build time.See tsximport {colorVars, spacingVars, radiusVars} from '@xds/core/theme/tokens.stylex';const styles = stylex.create({highlight: {backgroundColor: colorVars['--color-accent-muted'],padding: spacingVars['--spacing-3'],borderRadius: radiusVars['--radius-element'],},});
npx xds docs tokens for the full token reference (all spacing, color, radius, shadow, and typography tokens with values). See npx xds docs theme for how to override tokens via defineTheme.What NOT to Do
| Guidance | Practices |
|---|---|
| Don't | style={{}} on raw <div> wrappers. Use xstyle on the component directly. |
| Don't | Hardcoded colors (#fff, rgb(...)). Use var(--color-*) tokens or Tailwind semantic classes (text-primary, bg-surface). |
| Don't | Hardcoded spacing (16px, 1rem). Use var(--spacing-*) tokens or Tailwind spacing utilities (p-4, gap-3). |
| Don't | Wrapping a component in a <div> just to add margin. Use xstyle with stylex.create on the component. |
| Don't | Using !important. If styles aren't applying, check specificity; xstyle is merged last. |