Scroll
<Scroll> declares an independent scroll region. Arrange a group of scrolls with a
concrete <Panel flexDirection> wrapper.
Import
import { Scroll } from '@bedrock-core/ui';
Each <Scroll> becomes its own scroll viewport (index 0 is the root) and scrolls
vertically. Content not wrapped in any <Scroll> falls into a single full-screen root
scroll, so simple UIs need none.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
children | JSX.Node | — | The content laid out inside this scroll's viewport |
Inherits control props and they size and
position its viewport in the parent's flex flow, exactly like a <Panel>. An un-sized,
non-absolute scroll defaults to flexGrow: 1 so bare <Scroll>s share the parent's space;
width/height override that, and position={'absolute'} + top/left take it out of the flow.
Padding insets the native viewport and its scrollbar inside the outer layout box. Content width, overflow, and percentage sizes use this inner viewport. Percentage padding uses the parent's width, like other control padding.
Compiled screens apply visible to the viewport. enabled and background are accepted
as control props but are not applied to the viewport.
// Two side-by-side scroll columns — arrangement comes from the parent Panel.
<Panel flexDirection={'row'} gap={4}>
<Scroll width={'30%'}>{left}</Scroll>
<Scroll>{right}</Scroll>
</Panel>
// A fixed header above a scrolling body (stacked column).
<Panel flexDirection={'column'} height={'100%'}>
<Panel height={30}>{header}</Panel>
<Scroll>{body}</Scroll>
</Panel>
Notes
Compiled scroll regions enable content dragging on touch input when the client's gesture setting permits it. Dropdown popups use the same gesture policy.
- Scrolls cost engine time on big screens. Use one only where you genuinely need an
independent scrolling region; reach for a plain
<Panel>when the single root scroll will do. - Using any
<Scroll>fixes the screen to the canonical viewport size. Without scrolls the whole tree lives in the root scroll, which grows and scrolls when content overflows. As soon as you add a<Scroll>, the screen itself becomes a fixed-size canvas: content outside a scroll must fit within it, and only the content inside each<Scroll>scrolls. Size the outer layout to the screen (e.g.height={'100%'}) and let each<Scroll>absorb overflow. - Scrolls are vertical. Horizontal scrolling is not exposed.