Section
React componentGive related content a heading, description, and action.
Try it out
Use the live controls or open the Code tab to view and copy the example.
Notifications
Choose how you hear from us.
API reference
Generated from the package’s TypeScript exports. Standard React event and ARIA attributes are also accepted where the component wraps a native element.
| Prop | Type | Description |
|---|---|---|
heading | string | undefined | See the typed definition and working example for this option. |
description | ReactNode | Supporting instructions associated with the control. |
action | ReactNode | See the typed definition and working example for this option. |
defaultChecked | boolean | undefined | Standard React / HTML attribute passed to the underlying element. |
defaultValue | string | number | readonly string[] | undefined | Initial value for uncontrolled usage. |
className | string | undefined | Additional CSS class names. |
id | string | undefined | Standard React / HTML attribute passed to the underlying element. |
style | CSSProperties | undefined | Inline styles, including CSS custom property overrides. |
rel | string | undefined | Standard React / HTML attribute passed to the underlying element. |
children | ReactNode | Content rendered inside the component. |
onFocus | FocusEventHandler<HTMLElement> | undefined | Standard React / HTML attribute passed to the underlying element. |
onBlur | FocusEventHandler<HTMLElement> | undefined | Standard React / HTML attribute passed to the underlying element. |
onChange | ChangeEventHandler<HTMLElement, Element> | undefined | Standard React / HTML attribute passed to the underlying element. |
onError | ReactEventHandler<HTMLElement> | undefined | Standard React / HTML attribute passed to the underlying element. |
onClick | MouseEventHandler<HTMLElement> | undefined | Standard React / HTML attribute passed to the underlying element. |
Accessibility & interaction
Preserve semantic structure and communicate meaning with text rather than color alone.
Visible focus, reduced motion, and both color themes are shared across staqui. Choose labels and document structure that make sense in your application; automated checks do not replace assistive-technology testing.
Variants & implementation notes
Native section is named by its heading. Default heading level is h2; nested semantic structures can be authored using Box and Heading.
Use the typed API above for the supported variants. The example demonstrates the primary composition; shared controls inherit hover, focus, active and disabled treatment where applicable.