Skip to content

docs: Improve styling API docs #8968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 4, 2025
+1,181 −352
Merged

docs: Improve styling API docs #8968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b14218
docs: Add docs for component CSS variables
devongovett Oct 3, 2025
e20b555
Automatically generate default class name and render props table
devongovett Oct 3, 2025
0048449
Fix type
devongovett Oct 3, 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: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Breadcrumbs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,3 @@ function Example() {
### Breadcrumb

<PropTable component={docs.exports.Breadcrumb} links={docs.links} />

<StateTable defaultClassName="react-aria-Breadcrumb" properties={docs.exports.BreadcrumbRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Button.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,5 +122,3 @@ import {Link} from 'react-aria-components';
## API

<PropTable component={docs.exports.Button} links={docs.links} />

<StateTable defaultClassName="react-aria-Button" properties={docs.exports.ButtonRenderProps.properties} />
12 changes: 0 additions & 12 deletions packages/dev/s2-docs/pages/react-aria/Calendar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,34 +312,22 @@ import {Button} from 'vanilla-starter/Button';

<PropTable component={docs.exports.Calendar} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Calendar" properties={docs.exports.CalendarRenderProps.properties} />

### CalendarGrid

<PropTable component={docs.exports.CalendarGrid} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGrid" properties={docs.exports.CalendarGridRenderProps.properties} /> */}

### CalendarGridHeader

<PropTable component={docs.exports.CalendarGridHeader} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGridHeader" properties={docs.exports.CalendarGridHeaderRenderProps.properties} /> */}

### CalendarHeaderCell

<PropTable component={docs.exports.CalendarHeaderCell} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarHeaderCell" properties={docs.exports.CalendarHeaderCellRenderProps.properties} /> */}

### CalendarGridBody

<PropTable component={docs.exports.CalendarGridBody} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGridBody" properties={docs.exports.CalendarGridBodyRenderProps.properties} /> */}

### CalendarCell

<PropTable component={docs.exports.CalendarCell} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-CalendarCell" properties={docs.exports.CalendarCellRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Checkbox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,3 @@ import {Form} from 'react-aria-components';
### Checkbox

<PropTable component={docs.exports.Checkbox} links={docs.links} />

<StateTable defaultClassName="react-aria-Checkbox" properties={docs.exports.CheckboxRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/CheckboxGroup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,5 +120,3 @@ import {Form} from 'react-aria-components';
### CheckboxGroup

<PropTable component={docs.exports.CheckboxGroup} links={docs.links} />

<StateTable defaultClassName="react-aria-CheckboxGroup" properties={docs.exports.CheckboxGroupRenderProps.properties} />
4 changes: 0 additions & 4 deletions packages/dev/s2-docs/pages/react-aria/ColorArea.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ function Example() {

<PropTable component={docs.exports.ColorArea} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorArea" properties={docs.exports.ColorAreaRenderProps.properties} />

### ColorThumb

<PropTable component={docs.exports.ColorThumb} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorThumb" properties={docs.exports.ColorThumbRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/ColorPicker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,5 +189,3 @@ import {ColorSwatchPicker, ColorSwatchPickerItem} from 'vanilla-starter/ColorSwa
## API

<PropTable component={docs.exports.ColorPicker} links={docs.links} />

<StateTable defaultClassName="react-aria-ColorPicker" properties={docs.exports.ColorPickerRenderProps.properties} />
4 changes: 0 additions & 4 deletions packages/dev/s2-docs/pages/react-aria/ColorSlider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,6 @@ function Example() {

<PropTable component={docs.exports.ColorSlider} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorSlider" properties={docs.exports.ColorSliderRenderProps.properties} />

### ColorThumb

<PropTable component={docs.exports.ColorThumb} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorThumb" properties={docs.exports.ColorThumbRenderProps.properties} />
6 changes: 0 additions & 6 deletions packages/dev/s2-docs/pages/react-aria/ColorWheel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,10 @@ function Example() {

<PropTable component={docs.exports.ColorWheel} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorWheel" properties={docs.exports.ColorWheelRenderProps.properties} />

### ColorWheelTrack

<PropTable component={docs.exports.ColorWheelTrack} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorWheelTrack" properties={docs.exports.ColorWheelTrackRenderProps.properties} />

### ColorThumb

<PropTable component={docs.exports.ColorThumb} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ColorThumb" properties={docs.exports.ColorThumbRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/ComboBox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,5 +343,3 @@ import {ComboBox, ComboBoxItem} from 'vanilla-starter/ComboBox';
### ComboBox

<PropTable component={docs.exports.ComboBox} links={docs.links} />

<StateTable defaultClassName="react-aria-ComboBox" properties={docs.exports.ComboBoxRenderProps.properties} />
6 changes: 0 additions & 6 deletions packages/dev/s2-docs/pages/react-aria/DateField.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,10 @@ import {Form} from 'react-aria-components';

<PropTable component={docs.exports.DateField} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-DateField" properties={docs.exports.DateFieldRenderProps.properties} />

### DateInput

<PropTable component={docs.exports.DateInput} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-DateInput" properties={docs.exports.DateInputRenderProps.properties} />

### DateSegment

<PropTable component={docs.exports.DateSegment} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-DateSegment" properties={docs.exports.DateSegmentRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/DatePicker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,5 +157,3 @@ function Example() {
### DatePicker

<PropTable component={docs.exports.DatePicker} links={docs.links} />

<StateTable defaultClassName="react-aria-DatePicker" properties={docs.exports.DatePickerRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/DateRangePicker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,5 +174,3 @@ function Example(props) {
### DateRangePicker

<PropTable component={docs.exports.DateRangePicker} links={docs.links} />

<StateTable defaultClassName="react-aria-DateRangePicker" properties={docs.exports.DateRangePickerRenderProps.properties} />
13 changes: 8 additions & 5 deletions packages/dev/s2-docs/pages/react-aria/Disclosure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,13 @@ import {Settings} from 'lucide-react';

<PropTable component={docs.exports.Disclosure} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Disclosure" properties={docs.exports.DisclosureRenderProps.properties} />

### DisclosurePanel

<PropTable component={docs.exports.DisclosurePanel} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-DisclosurePanel" properties={docs.exports.DisclosurePanelRenderProps.properties} />
<PropTable
component={docs.exports.DisclosurePanel}
links={docs.links}
showDescription
cssVariables={{
'--disclosure-panel-width': "The disclosure panel's intrinsic width in pixels. Useful for animations.",
'--disclosure-panel-height': "The disclosure panel's intrinsic height in pixels. Useful for animations."
}} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/DisclosureGroup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,3 @@ function Example() {
### DisclosureGroup

<PropTable component={docs.exports.DisclosureGroup} links={docs.links} />

<StateTable defaultClassName="react-aria-DisclosureGroup" properties={docs.exports.DisclosureGroupRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/DropZone.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,5 +100,3 @@ export const tags = ['file', 'drag', 'dnd', 'upload'];
### DropZone

<PropTable component={docs.exports.DropZone} links={docs.links} />

<StateTable defaultClassName="react-aria-DropZone" properties={docs.exports.DropZoneRenderProps.properties} />
6 changes: 0 additions & 6 deletions packages/dev/s2-docs/pages/react-aria/GridList.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,16 +279,10 @@ function Example() {

<PropTable component={docs.exports.GridList} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-GridList" properties={docs.exports.GridListRenderProps.properties} />

### GridListItem

<PropTable component={docs.exports.GridListItem} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-GridListItem" properties={docs.exports.GridListItemRenderProps.properties} />

### GridListLoadMoreItem

<PropTable component={docs.exports.GridListLoadMoreItem} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-GridListLoadMoreItem" properties={docs.exports.GridListLoadMoreItemRenderProps.properties} /> */}
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Group.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,3 @@ import {Input} from 'react-aria-components';
## API

<PropTable component={docs.exports.Group} links={docs.links} />

<StateTable defaultClassName="react-aria-Group" properties={docs.exports.GroupRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Link.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,3 @@ import {Link} from 'vanilla-starter/Link';
## API

<PropTable component={docs.exports.Link} links={docs.links} />

<StateTable defaultClassName="react-aria-Link" properties={docs.exports.LinkRenderProps.properties} />
8 changes: 0 additions & 8 deletions packages/dev/s2-docs/pages/react-aria/ListBox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,22 +393,14 @@ function Example() {

<PropTable component={docs.exports.ListBox} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ListBox" properties={docs.exports.ListBoxRenderProps.properties} />

### ListBoxItem

<PropTable component={docs.exports.ListBoxItem} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ListBoxItem" properties={docs.exports.ListBoxItemRenderProps.properties} />

### ListBoxSection

<PropTable component={docs.exports.ListBoxSection} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-ListBoxSection" properties={docs.exports.ListBoxSectionRenderProps.properties} /> */}

### ListBoxLoadMoreItem

<PropTable component={docs.exports.ListBoxLoadMoreItem} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-ListBoxLoadMoreItem" properties={docs.exports.ListBoxLoadMoreItemRenderProps.properties} /> */}
6 changes: 0 additions & 6 deletions packages/dev/s2-docs/pages/react-aria/Menu.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,20 +506,14 @@ import {MenuTrigger, Menu, MenuItem, Button, Popover} from 'react-aria-component

<PropTable component={docs.exports.Menu} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-Menu" properties={docs.exports.MenuRenderProps.properties} /> */}

### MenuItem

<PropTable component={docs.exports.MenuItem} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-MenuItem" properties={docs.exports.MenuItemRenderProps.properties} />

### MenuSection

<PropTable component={docs.exports.MenuSection} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-MenuSection" properties={docs.exports.MenuSectionRenderProps.properties} /> */}

### SubmenuTrigger

<PropTable component={docs.exports.SubmenuTrigger} links={docs.links} showDescription />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Meter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,3 @@ By default, the `value` prop is a percentage between 0 and 100. Use the `minValu
### Meter

<PropTable component={docs.exports.Meter} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Meter" properties={docs.exports.MeterRenderProps.properties} />
15 changes: 8 additions & 7 deletions packages/dev/s2-docs/pages/react-aria/Modal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,16 +182,17 @@ const CustomTrigger = React.forwardRef((props, ref) => (

<PropTable component={docs.exports.Modal} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Modal" properties={docs.exports.ModalRenderProps.properties} />

### ModalOverlay

<PropTable component={docs.exports.ModalOverlay} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ModalOverlay" properties={docs.exports.ModalRenderProps.properties} />
<PropTable
component={docs.exports.ModalOverlay}
links={docs.links}
showDescription
cssVariables={{
'--visual-viewport-height': 'The height of the [Visual Viewport](https://developer.mozilla.org/en-US/docs/Web/API/Visual_Viewport_API), i.e. space above the software keyboard.',
'--page-height': 'The height of the `<body>` element. Useful for sizing the modal backdrop.'
}} />

### Dialog

<PropTable component={docs.exports.Dialog} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Dialog" properties={docs.exports.DialogRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/NumberField.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,5 +144,3 @@ import {Form} from 'react-aria-components';
### NumberField

<PropTable component={docs.exports.NumberField} links={docs.links} />

<StateTable defaultClassName="react-aria-NumberField" properties={docs.exports.NumberFieldRenderProps.properties} />
13 changes: 8 additions & 5 deletions packages/dev/s2-docs/pages/react-aria/Popover.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,15 @@ function Example() {

### Popover

<PropTable component={docs.exports.Popover} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Popover" properties={docs.exports.PopoverRenderProps.properties} />
<PropTable
component={docs.exports.Popover}
links={docs.links}
showDescription
cssVariables={{
'--trigger-width': 'The width of the popover trigger element.',
'--trigger-anchor-point': 'The position of the trigger relative to the popover. Use with `transform-origin` when applying scale transitions.'
}} />

### OverlayArrow

<PropTable component={docs.exports.OverlayArrow} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-OverlayArrow" properties={docs.exports.OverlayArrowRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/ProgressBar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,3 @@ Use SVG within a `<ProgressBar>` to build a circular progress indicator or spinn
### ProgressBar

<PropTable component={docs.exports.ProgressBar} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-ProgressBar" properties={docs.exports.ProgressBarRenderProps.properties} />
4 changes: 0 additions & 4 deletions packages/dev/s2-docs/pages/react-aria/RadioGroup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,6 @@ import {Form} from 'react-aria-components';

<PropTable component={docs.exports.RadioGroup} links={docs.links} />

<StateTable defaultClassName="react-aria-RadioGroup" properties={docs.exports.RadioGroupRenderProps.properties} />

### Radio

<PropTable component={docs.exports.Radio} links={docs.links} />

<StateTable defaultClassName="react-aria-Radio" properties={docs.exports.RadioRenderProps.properties} />
12 changes: 0 additions & 12 deletions packages/dev/s2-docs/pages/react-aria/RangeCalendar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,34 +330,22 @@ import {Button} from 'vanilla-starter/Button';

<PropTable component={docs.exports.RangeCalendar} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-RangeCalendar" properties={docs.exports.RangeCalendarRenderProps.properties} />

### CalendarGrid

<PropTable component={docs.exports.CalendarGrid} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGrid" properties={docs.exports.CalendarGridRenderProps.properties} /> */}

### CalendarGridHeader

<PropTable component={docs.exports.CalendarGridHeader} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGridHeader" properties={docs.exports.CalendarGridHeaderRenderProps.properties} /> */}

### CalendarHeaderCell

<PropTable component={docs.exports.CalendarHeaderCell} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarHeaderCell" properties={docs.exports.CalendarHeaderCellRenderProps.properties} /> */}

### CalendarGridBody

<PropTable component={docs.exports.CalendarGridBody} links={docs.links} showDescription />

{/* <StateTable defaultClassName="react-aria-CalendarGridBody" properties={docs.exports.CalendarGridBodyRenderProps.properties} /> */}

### CalendarCell

<PropTable component={docs.exports.CalendarCell} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-CalendarCell" properties={docs.exports.CalendarCellRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/SearchField.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,5 +108,3 @@ function Example(props) {
### SearchField

<PropTable component={docs.exports.SearchField} links={docs.links} />

<StateTable defaultClassName="react-aria-SearchField" properties={docs.exports.SearchFieldRenderProps.properties} />
4 changes: 0 additions & 4 deletions packages/dev/s2-docs/pages/react-aria/Select.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,6 @@ import {Form} from 'react-aria-components';

<PropTable component={docs.exports.Select} links={docs.links} />

<StateTable defaultClassName="react-aria-Select" properties={docs.exports.SelectRenderProps.properties} />

### SelectValue

<PropTable component={docs.exports.SelectValue} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-SelectValue" properties={docs.exports.SelectValueRenderProps.properties} />
8 changes: 0 additions & 8 deletions packages/dev/s2-docs/pages/react-aria/Slider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,22 +115,14 @@ By default, slider values are percentages between 0 and 100. Use the `minValue`,

<PropTable component={docs.exports.Slider} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-Slider" properties={docs.exports.SliderRenderProps.properties} />

### SliderOutput

<PropTable component={docs.exports.SliderOutput} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-SliderOutput" properties={docs.exports.SliderRenderProps.properties} />

### SliderTrack

<PropTable component={docs.exports.SliderTrack} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-SliderTrack" properties={docs.exports.SliderTrackRenderProps.properties} />

### SliderThumb

<PropTable component={docs.exports.SliderThumb} links={docs.links} showDescription />

<StateTable defaultClassName="react-aria-SliderThumb" properties={docs.exports.SliderThumbRenderProps.properties} />
2 changes: 0 additions & 2 deletions packages/dev/s2-docs/pages/react-aria/Switch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,3 @@ import {Form} from 'react-aria-components';
### Switch

<PropTable component={docs.exports.Switch} links={docs.links} />

<StateTable defaultClassName="react-aria-Switch" properties={docs.exports.SwitchRenderProps.properties} />
Loading