Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/@react-spectrum/s2/style/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const iconSizes = {

export function iconStyle(this: MacroContext | void, options: IconStyle): StyleString<Exclude<keyof IconStyle, 'color' | 'size'>> {
let {size = 'M', color, ...styles} = options;

if (color) {
styles['--iconPrimary'] = {
type: 'fill',
Expand Down
21 changes: 20 additions & 1 deletion packages/dev/s2-docs/pages/react-aria/styling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,28 @@ With this configured, all states for React Aria Components can be accessed with
</ListBoxItem>
```

## Style macro

If you want to build custom components that follow Spectrum design tokens and styling, you can use the [style macro](../s2/styling.html) from React Spectrum. The `style` macro is a build-time CSS generator that provides type safe access to Spectrum 2 design tokens including colors, spacing, sizing, and typography.

```tsx
import {Checkbox} from 'react-aria-components';
import {style} from '@react-spectrum/s2/style' with {type: 'macro'};

<Checkbox
className={style({
backgroundColor: {
default: 'gray-100',
isHovered: 'gray-200',
isSelected: 'gray-900'
}
})}
/>
```

## Animation

React Aria Components supports both [CSS transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions/Using_CSS_transitions) and [keyframe animations](https://developer.mozilla.org/en-US/docs/Web/CSS/@keyframes), and works with JavaScript animation libraries like [Framer Motion](https://www.framer.com/motion/).
React Aria Components supports both [CSS transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions/Using_CSS_transitions) and [keyframe animations](https://developer.mozilla.org/en-US/docs/Web/CSS/@keyframes), and works with JavaScript animation libraries like [Motion](https://motion.dev/).

### CSS transitions

Expand Down
2 changes: 1 addition & 1 deletion packages/dev/s2-docs/pages/s2/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const title = 'Home';
{id: 'Divider', name: 'Divider', href: 'Divider.html'},
{id: 'DropZone', name: 'DropZone', href: 'DropZone.html'},
{id: 'Form', name: 'Form', href: 'Form.html'},
{id: 'Icons', name: 'Icons', href: 'Icons.html'},
{id: 'Icons', name: 'Icons', href: 'icons.html'},
{id: 'IllustratedMessage', name: 'IllustratedMessage', href: 'IllustratedMessage.html'},
{id: 'Illustrations', name: 'Illustrations', href: 'Illustrations.html'},
{id: 'Image', name: 'Image', href: 'Image.html'},
Expand Down
82 changes: 82 additions & 0 deletions packages/dev/s2-docs/pages/s2/reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import {Layout} from '../../src/Layout';
import {InlineAlert, Heading, Content, Link} from '@react-spectrum/s2';
import {S2Colors} from '../../src/S2Colors';
import {S2Typography} from '../../src/S2Typography';
import {StyleMacroProperties} from '../../src/types';
import {getPropertyDefinitions, getShorthandDefinitions} from '../../src/styleProperties';
export default Layout;

export const section = 'Components';
export const tags = ['style', 'macro', 'spectrum', 'custom', 'values', 'reference'];
export const description = 'Reference table for the style macro';

# Style Macro

The `style` macro supports a constrained set of values per property that conform to Spectrum 2.

## Colors

All Spectrum 2 color tokens are available across color properties (e.g., `backgroundColor`, `color`, `borderColor`).
`baseColors` consists of the semantic and global colors listed below.

<S2Colors />

<StyleMacroProperties properties={getPropertyDefinitions('color')} />

## Dimensions

Spacing props like `margin` and `padding` accept values on a **4px grid**. These are specified in `px` and get converted to `rem`. In addition to numbers, these named options are available:

- `edge-to-text` – default spacing between the edge of a control and its text. Relative to control height.
- `pill` – default spacing between the edge of a pill-shaped control and its text. Relative to control height.
- `text-to-control` – default spacing between text and a control (e.g., label and input). Scales with font size.
- `text-to-visual` – default spacing between text and a visual element (e.g., icon). Scales with font size.

Size props like `width` and `height` accept arbitrary pixel values. Values are converted to `rem` and multiplied by 1.25x on touch devices to increase hit targets.

<StyleMacroProperties properties={getPropertyDefinitions('dimensions')} />

## Text

Spectrum 2 typography can be applied via the `font` [shorthand](#shorthands), which sets `fontFamily`, `fontSize`, `fontWeight`, `lineHeight`, and `color`. You can override any of these individually.
Note that `font` should be applied on a per element basis rather than globally so as to properly conform with Spectrum designs.

```tsx
<main>
<h1 className={style({font: 'heading-xl'})}>Heading</h1>
<p className={style({font: 'body'})}>Body</p>
<ul className={style({font: 'body-sm', fontWeight: 'bold'})}>
<li>List item</li>
</ul>
</main>
```

Type scales include: UI, Body, Heading, Title, Detail, and Code. Each scale has a default and additional t-shirt sizes (e.g., `ui-sm`, `heading-2xl`, `code-xl`).

<S2Typography />


<StyleMacroProperties properties={getPropertyDefinitions('text')} />


## Effects

<StyleMacroProperties properties={getPropertyDefinitions('effects')} />

## Layout

<StyleMacroProperties properties={getPropertyDefinitions('layout')} />

## Misc

<StyleMacroProperties properties={getPropertyDefinitions('misc')} />

## Shorthands

Shorthands apply their provided value to commonly grouped properties.

<StyleMacroProperties properties={getShorthandDefinitions('shorthand')} />

## Conditions

<StyleMacroProperties properties={getPropertyDefinitions('conditions')} />
151 changes: 70 additions & 81 deletions packages/dev/s2-docs/pages/s2/styling.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import {Layout} from '../../src/Layout';
import {InlineAlert, Heading, Content, Link} from '@react-spectrum/s2';
import {S2Colors} from '../../src/S2Colors';
import {S2Typography} from '../../src/S2Typography';
import {S2StyleProperties} from '../../src/S2StyleProperties';
import {S2FAQ} from '../../src/S2FAQ';
export default Layout;

export const section = 'Guides';
Expand All @@ -11,11 +10,13 @@ export const description = 'Styling in React Spectrum';

# Styling

React Spectrum includes a build-time style macro that generates atomic CSS and lets you apply Spectrum tokens directly in your components with type-safe autocompletion.
React Spectrum includes a build-time `style` macro that generates atomic CSS and lets you apply Spectrum tokens directly in your components with type-safe autocompletion.

## Style macro

The `style` macro runs at build time and returns a class name for applying Spectrum 2 design tokens (colors, spacing, sizing, typography, etc.).
The `style` macro runs at build time and returns a class name for applying Spectrum 2 design tokens (colors, spacing, sizing, typography, etc.). As can been seen below,
the keys of the object passed to the `style` macro correspond to a CSS property, each paired with the property's desired value. See [here](./reference.html) for a full list
of supported values.

```tsx
import {style} from '@react-spectrum/s2/style' with {type: 'macro'};
Expand All @@ -37,6 +38,14 @@ Colocating styles with your component code means:
- Develop more efficiently – no switching files or writing selectors.
- Refactor with confidence – changes are isolated; deleting a component removes its styles.

<InlineAlert variant="informative">
<Heading>Important Note</Heading>
<Content>
Due to the atomic nature of the generated CSS rules, it is strongly recommended that you follow the CSS optimization guide listed [below](#css-optimization).
Failure to do so can result in large number of duplicate rules and obtuse styling bugs.
</Content>
</InlineAlert>

## Spectrum components

The `styles` prop accepts a limited set of CSS properties, including layout, spacing, sizing, and positioning. Other styles such as colors and internal padding cannot be customized within Spectrum components.
Expand Down Expand Up @@ -86,77 +95,6 @@ import {Button} from '@react-spectrum/s2';
'visibility'
]} />

### UNSAFE Style Overrides

We highly discourage overriding the styles of React Spectrum components because it may break at any time when we change our implementation, making it difficult for you to update in the future. Consider using [React Aria Components](https://react-spectrum.adobe.com/react-aria/) with our style macro to build a custom component with Spectrum styles instead.

With that being said, the `UNSAFE_className` and `UNSAFE_style` props are supported on Spectrum 2 components as last-resort escape hatches.

```tsx
/* YourComponent.tsx */
import {Button} from '@react-spectrum/s2';
import './YourComponent.css';

function YourComponent() {
return <Button UNSAFE_className="your-unsafe-class">Button</Button>;
}
```

```css
/* YourComponent.css */
.your-unsafe-class {
background: red;
}
```

## Values

The `style` macro supports a constrained set of values per property that conform to Spectrum 2. This improves consistency and maintainability.

### Colors

All Spectrum 2 color tokens are available across color properties (e.g., `backgroundColor`, `color`, `borderColor`).

<S2Colors />

### Spacing

Spacing props like `margin` and `padding` accept values on a **4px grid**. These are specified in `px` and get converted to `rem`. In addition to numbers, these named options are available:

- `edge-to-text` – default spacing between the edge of a control and its text. Relative to control height.
- `pill` – default spacing between the edge of a pill-shaped control and its text. Relative to control height.
- `text-to-control` – default spacing between text and a control (e.g., label and input). Scales with font size.
- `text-to-visual` – default spacing between text and a visual element (e.g., icon). Scales with font size.

### Sizing

Size props like `width` and `height` accept arbitrary pixel values. Values are converted to `rem` and multiplied by 1.25x on touch devices to increase hit targets.

### Typography

Spectrum 2 typography is applied via the `font` shorthand, which sets `fontFamily`, `fontSize`, `fontWeight`, `lineHeight`, and `color`. You can override any of these individually.

```tsx
<main>
<h1 className={style({font: 'heading-xl'})}>Heading</h1>
<p className={style({font: 'body'})}>Body</p>
<ul className={style({font: 'body-sm', fontWeight: 'bold'})}>
<li>List item</li>
</ul>
</main>
```

Type scales include: UI, Body, Heading, Title, Detail, and Code. Each scale has a default and additional t-shirt sizes (e.g., `ui-sm`, `heading-2xl`, `code-xl`).

<S2Typography />

<InlineAlert variant="notice">
<Heading>Important Note</Heading>
<Content>
Only use `<Heading>` and `<Text>` inside Spectrum components with predefined styles (e.g., `<Dialog>`, `<MenuItem>`). They are unstyled by default and should not be used standalone. Use HTML elements with the style macro instead.
</Content>
</InlineAlert>

## Conditional styles

Define conditional values as objects to handle media queries, UI states (hover/press), and variants. This keeps all values for a property together.
Expand All @@ -166,12 +104,19 @@ Define conditional values as objects to handle media queries, UI states (hover/p
className={style({
padding: {
default: 8,
lg: 32
lg: 32,
'@media (min-width: 2560px)': 64
}
})}
/>
```

In the example above, the keys of the nested object now map out the "conditions" that govern the padding of the `div`. This translates to the following:

- If the viewport is larger than `2560px`, as specified by a user defined [media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries), the padding of the `div` is set to `64px`.
- If the viewport matches the `style` macro's predefined `lg` [breakpoint](./reference.html#conditions) (i.e. the viewport is larger than `1024px`), but does not exceed previous condition, the padding of the `div` is set to `32px`
- Otherwise, default to a padding of `8px`.

Conditions are mutually exclusive and ordered. The macro uses CSS cascade layers so the last matching condition wins without specificity issues.

### Runtime conditions
Expand All @@ -195,13 +140,14 @@ function MyComponent({variant}: {variant: 'primary' | 'secondary'}) {
}
```

Boolean conditions starting with `is` can be used directly without nesting:
Boolean conditions starting with `is` or `allows` can be used directly without nesting:

```tsx
const styles = style({
backgroundColor: {
default: 'gray-100',
isSelected: 'gray-900'
isSelected: 'gray-900',
allowsRemoving: 'gray-400'
}
});

Expand All @@ -222,7 +168,7 @@ import {style} from '@react-spectrum/s2/style' with {type: 'macro'};
isSelected: 'gray-900'
}
})}
/>
/>
```

### Nesting conditions
Expand Down Expand Up @@ -253,6 +199,11 @@ const styles = style({
Extract common styles into constants and spread them into `style` calls. These must be in the same file or imported from another file as a macro.

```tsx
// style-utils.ts
export const bannerBackground = () => 'blue-1000' as const;

// component.tsx
import {bannerBackground} from './style-utils' with {type: 'macro'};
const horizontalStack = {
display: 'flex',
alignItems: 'center',
Expand All @@ -261,6 +212,7 @@ const horizontalStack = {

const styles = style({
...horizontalStack,
backgroundColor: bannerBackground(),
columnGap: 4
});
```
Expand Down Expand Up @@ -308,9 +260,28 @@ const buttonStyle = style({
<Button styles={buttonStyle}>Press me</Button>
```

## Setting CSS variables

CSS variables can be directly defined in a `style` macro, allowing child elements to then access them in their own styles.
A `type` should be provided to specify the CSS property type the `value` represents.

```tsx
const parentStyle = style({
'--rowBackgroundColor': {
type: 'backgroundColor',
value: 'gray-400'
}
});

const childStyle = style({
backgroundColor: '--rowBackgroundColor'
});
```

## CSS optimization

The style macro relies on CSS bundling and minification for optimal output. Follow these best practices:
The `style` macro relies on CSS bundling and minification for optimal output. Failure to perform this optimization will result in a suboptimal developer experience and obtuse styling bugs.
Follow these best practices:

- Ensure styles are extracted into a CSS bundle; do not inject at runtime with `<style>` tags.
- Use a CSS minifier like `lightningcss` to deduplicate common rules (consider in dev for easier debugging).
Expand Down Expand Up @@ -362,4 +333,22 @@ CSS resets are strongly discouraged. Global CSS selectors can unintentionally af
/* App.css */
@layer reset, _;
@import "reset.css" layer(reset);
```
```

## Developing with style macros

Since `style` macros are quite different from using `className`/`style` directly, many may find it initially challenging to debug and develop against.
Below are some useful tools that may benefit your developer experience:

- The [atomic-css-devtools](https://github.com/astahmer/atomic-css-devtools) extension presents an inspected element's atomic CSS rules
in a non-atomic format, making it easier to scan.

- This [sandbox](https://codesandbox.io/p/devbox/react-spectrum-s2-style-macro-template-h6fpsq) is preconfigured to support React Spectrum S2, React Aria Components, and
the `style` macros for quick prototyping.

- If you are using Cursor, we offer a set of [Cursor rules](https://github.com/adobe/react-spectrum/blob/main/rules/style-macro.mdc) to use when developing with style macros. Additionally,
we have MCP servers for [React Aria](../react-aria/mcp.html) and [React Spectrum](./mcp.html) respectively that interface with the docs.

## FAQ

<S2FAQ />
Loading
Loading