Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
edeaa2f
add FAQ and other sections
LFDanLu Oct 23, 2025
8a1f97e
add section for creating custom components
LFDanLu Oct 23, 2025
28eb788
initial stab at extracting types from style macro
LFDanLu Oct 24, 2025
457c59a
testing sizing properties
LFDanLu Oct 24, 2025
a15c24f
Merge branch 'main' of github.com:adobe/react-spectrum into reference…
LFDanLu Oct 24, 2025
819c076
revert export of theme object since it was breaking inference
LFDanLu Oct 24, 2025
3b991ea
adding more values
LFDanLu Oct 28, 2025
42b0406
reorg
LFDanLu Oct 28, 2025
36f1a6f
add the rest of the properties and double check them
LFDanLu Oct 28, 2025
e2b29c9
add more type links
LFDanLu Oct 28, 2025
4c94cd0
add mdn links for common types and specific css properties
LFDanLu Oct 29, 2025
83262ef
add relative links so basecolors and various dimension strings link b…
LFDanLu Oct 29, 2025
5d2b172
add descriptions to table and get rid of unessasary isRelative
LFDanLu Oct 30, 2025
980d3d6
add short hand and condition tables
LFDanLu Oct 30, 2025
59e9400
add subpage for reference and advanced style macro section
LFDanLu Oct 30, 2025
a414886
support subpage list under the ToC
LFDanLu Oct 31, 2025
0b2751d
forgot to move last bit of content
LFDanLu Oct 31, 2025
4ef4996
update FAQ, add mobile related pages, link from RAC styling
LFDanLu Oct 31, 2025
b04b7af
Merge branch 'main' of github.com:adobe/react-spectrum into style_mac…
LFDanLu Oct 31, 2025
807beb0
fix mobile styling
LFDanLu Oct 31, 2025
0c6ac3f
review comments
LFDanLu Nov 3, 2025
a3d57a9
fix build links?
LFDanLu Nov 3, 2025
30bab22
rename mdx file to fix all links
LFDanLu Nov 3, 2025
44b0d8d
Merge branch 'main' of github.com:adobe/react-spectrum into style_mac…
LFDanLu Nov 3, 2025
5084b6b
small fixes
LFDanLu Nov 3, 2025
34ad8cc
move reference out of subpage and merge styling page
LFDanLu Nov 3, 2025
6bf1724
make icons page lowercase and fix shorthands link
LFDanLu Nov 4, 2025
6e508f2
whoops forgot to make git track the capitalization rename
LFDanLu Nov 4, 2025
4b38f98
addressing feedback from quarry team
LFDanLu Nov 4, 2025
2e13868
Merge branch 'main' of github.com:adobe/react-spectrum into style_mac…
LFDanLu Nov 4, 2025
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
19 changes: 19 additions & 0 deletions packages/dev/s2-docs/pages/react-aria/styling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,25 @@ 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/).
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'},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why would this be the only one with a lowercase? seems like the file should be renamed if that's what it relies on, that way it's more predictable.

really i'd like to get rid of all the uppercases in the urls... but that's a different issue

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the convention that seems to exist currently is that component pages are capitalized (e.g. DropZone/Menu/etc) and that non component pages aren't (e.g. dnd.mdx/migrating.mdx/etc) and icons fits into the latter. The file should be renamed to be lower case as well with my last commit, forgot to force git to recognize that change since it didn't automatically

{id: 'IllustratedMessage', name: 'IllustratedMessage', href: 'IllustratedMessage.html'},
{id: 'Illustrations', name: 'Illustrations', href: 'Illustrations.html'},
{id: 'Image', name: 'Image', href: 'Image.html'},
Expand Down
81 changes: 81 additions & 0 deletions packages/dev/s2-docs/pages/s2/reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
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')} />
Comment on lines +22 to +24
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit, we should add some margin between these:

Image


## 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.

```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')} />
Loading