Modal
A custom content overlay that appears on top of the main screen, with support for headers, bodies, footers, and flexible positioning.
View component sourceImport
import { Modal } from '@app-studio/components';New to the library? Complete installation and provider setup first.
Interactive examples
Try the component, then open Code to copy the complete example.
import React from 'react';
import { Button } from '@app-studio/components';
import { Text } from 'app-studio';
import { Modal } from '@app-studio/components';
import { hideModal, showModal } from '@app-studio/components';
export const DefaultModal = () => {
return (
<>
<Button onClick={() => showModal('DefaultModal')} isAuto>
Blur Overlay
</Button>
<Modal.Layout
modals={{
DefaultModal: () => (
<Modal.Container>
<Modal.Header>
<Text size="lg" weight="semiBold">
Title
</Text>
</Modal.Header>
<Modal.Body>
<Text>
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
Cras mattis consectetur purus sit amet fermentum. Cras justo
odio, dapibus ac facilisis in, egestas eget quam. Morbi leo
risus, porta ac consectetur ac, vestibulum at eros. Praesent
commodo cursus magna, vel scelerisque nisl consectetur et.
</Text>
</Modal.Body>
<Modal.Footer>
<Button onClick={hideModal}>Cancel</Button>
</Modal.Footer>
</Modal.Container>
),
}}
/>
</>
);
};Props
Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
buttonColor | string | — | See the type and source declaration for this property.Source |
iconSize | Size"sm""md""lg""xs""xl" | — | See the type and source declaration for this property.Source |
shape | Shape"square""rounded" | — | Shape preset for the component.Source |
isFullScreen | boolean | — | See the type and source declaration for this property.Source |
buttonPosition | CloseButtonPosition"left""right""none" | — | See the type and source declaration for this property.Source |
onClose | (() => void) | — | Called when the user requests dismissal.Source |
blur | number | — | See the type and source declaration for this property.Source |
isOpen | boolean | — | Controls whether the component is open.Source |
isClosePrevented | boolean | — | See the type and source declaration for this property.Source |
position | Position"bottom""left""right""top""center" | — | Position of the element or notification.Source |
shadow | ViewProps | Shadow | Elevation | — | Shadow or elevation styling.Source |
id | string | — | See the type and source declaration for this property.Source |
title | string | — | Main title displayed by the component.Source |
Common inherited styling props (7)
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
onClick | any | — | Called when the user activates the component. |
media | Record<string, CssProps> | — | See the type and source declaration for this property. |
as | keyof JSX.IntrinsicElements"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view" | — | See the type and source declaration for this property. |
themeMode | "light" | "dark""light""dark" | — | See the type and source declaration for this property. |
_hover | string | CssProps | — | See the type and source declaration for this property. |
_active | string | CssProps | — | See the type and source declaration for this property. |
_focus | string | CssProps | — | See the type and source declaration for this property. |
Modal.Overlay
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
children | View typestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | null | — | Content rendered inside the component.Source |
blur | number | — | See the type and source declaration for this property.Source |
isOpen Required | boolean | — | Controls whether the component is open.Source |
isClosePrevented | boolean | — | See the type and source declaration for this property.Source |
position | Position | — | Position of the element or notification.Source |
isFullScreen | boolean | — | See the type and source declaration for this property.Source |
onClose Required | () => void | — | Called when the user requests dismissal.Source |
Modal.Container
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
views | { container?: ViewProps; } | — | Style overrides for the named internal parts.Source |
children Required | View typestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | null | — | Content rendered inside the component.Source |
shape | Shape | — | Shape preset for the component.Source |
isFullScreen | boolean | — | See the type and source declaration for this property.Source |
isOpen | boolean | — | Controls whether the component is open.Source |
onClose | (() => void) | — | Called when the user requests dismissal.Source |
isClosePrevented | boolean | — | See the type and source declaration for this property.Source |
blur | number | — | See the type and source declaration for this property.Source |
variant | string | — | Visual treatment of the component.Source |
buttonColor | any | — | See the type and source declaration for this property.Source |
buttonPosition | CloseButtonPosition | — | See the type and source declaration for this property.Source |
position | Position | — | Position of the element or notification.Source |
shadow | ViewProps | Shadow | Elevation | — | Shadow or elevation styling.Source |
Modal.Header
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
views | { container?: ViewProps; header?: ViewProps; } | — | Style overrides for the named internal parts.Source |
buttonColor | string | — | See the type and source declaration for this property.Source |
iconSize | Size | — | See the type and source declaration for this property.Source |
children | View typestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | null | — | Content rendered inside the component.Source |
buttonPosition | CloseButtonPosition | — | See the type and source declaration for this property.Source |
buttonSize | Size | — | See the type and source declaration for this property.Source |
variant | string | — | Visual treatment of the component.Source |
onClose | (() => void) | — | Called when the user requests dismissal.Source |
Modal.Body
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
views | { view?: ViewProps; } | — | Style overrides for the named internal parts.Source |
buttonColor | any | — | See the type and source declaration for this property.Source |
variant | string | — | Visual treatment of the component.Source |
Modal.Footer
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
views | { container?: ViewProps; } | — | Style overrides for the named internal parts.Source |
Modal.Layout
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
modals Required | { [x: string]: React.FC<any>; } | — | See the type and source declaration for this property.Source |
onShow | ((name: string, props?: any) => void) | — | See the type and source declaration for this property.Source |
onHide | ((name?: string, props?: any) => void) | — | See the type and source declaration for this property.Source |
For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.
Usage guidance
- Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
- For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
- These previews run in the browser. Check React Native setup for platform requirements and differences.