Skip to content
TrademarkTrademark
Docs
Components

StyleOverlay

Updated: May 9, 2025
View on GitHub

StyleOverlay renders a toggleable panel designed for accessing Once UI styling properties in a compact way during development. The panel slides out from the corner of the screen and overlays content.

Trigger

Set any element as trigger for the overlay in the children prop.

Behavior

  • The overlay appears in the top-right corner.
  • Internally uses StylePanel as content which can be customized with Flex props.
  • Automatically clamps height using safe spacing constraints.
  • Contains close and trigger buttons with consistent z-index stacking and conditional rendering.

API reference

Type
Default
iconButtonProps
Props forwarded to the trigger icon button.
Partial<React.ComponentProps<typeof IconButton>>—
children
React.ReactNode—
zIndex
DisplayProps["zIndex"]2
…and every FlexProps propinherited—
className
string—
style
React.CSSProperties—
Edit this page on GitHub