Frame
Dialog shell for review and confirmation surfaces.
Demo
Review request
Review the details before continuing.
Network
Tempo
Amount
Usage
import { Button, Frame } from 'regen-ui'
export function ReviewFrame(props: { onDismiss: () => void }) {
return (
<Frame
footer={
<Frame.Actions>
<Button>Cancel</Button>
<Button variant="primary">Approve</Button>
</Frame.Actions>
}
onDismiss={props.onDismiss}
subtitle="Review the details before continuing."
title="Review request"
>
Request details
</Frame>
)
}Inherited dismiss
import { Frame } from 'regen-ui'
export function FramedRoute(props: { children: React.ReactNode; onDismiss: () => void }) {
return (
<Frame.Provider onDismiss={props.onDismiss}>
{props.children}
</Frame.Provider>
)
}API Reference
Frame.Props
| Name | Type | Default | Description |
|---|---|---|---|
bodyClassName | string | None | Additional class names for uncommon body wrapper overrides. |
footer | ReactNode | None | Footer content anchored to the bottom. |
footerClassName | string | None | Additional class names for uncommon footer wrapper overrides. |
onDismiss | () => void | null | None | Dismiss handler. Pass null to opt out of inherited dismiss behavior. |
subtitle | ReactNode | None | Secondary text below the title. |
title | ReactNode | None | Primary heading text. |
variant | 'card' | 'page' | 'plain' | 'sheet' | 'card' | Visual shell variant. |
Inherits HTMLAttributes<HTMLDivElement>, except title. | |||
bodyClassNameType
stringDefaultNone
Additional class names for uncommon body wrapper overrides.footerType
ReactNodeDefaultNone
Footer content anchored to the bottom.footerClassNameType
stringDefaultNone
Additional class names for uncommon footer wrapper overrides.onDismissType
() => void | nullDefaultNone
Dismiss handler. Pass null to opt out of inherited dismiss behavior.subtitleType
ReactNodeDefaultNone
Secondary text below the title.titleType
ReactNodeDefaultNone
Primary heading text.variantType
'card' | 'page' | 'plain' | 'sheet'Default
Visual shell variant.'card'Inherits
HTMLAttributes<HTMLDivElement>, except title.Frame.Actions.Props
| Name | Type | Default | Description |
|---|---|---|---|
children | ReactNode | None | Action buttons. |
childrenType
ReactNodeDefaultNone
Action buttons.Frame.Provider.Props
| Name | Type | Default | Description |
|---|---|---|---|
children | ReactNode | None | Nested frame content. |
onDismiss | () => void | None | Dismiss handler inherited by nested frames. |
childrenType
ReactNodeDefaultNone
Nested frame content.onDismissType
() => voidDefaultNone
Dismiss handler inherited by nested frames.