@app-studio/components
PageLayout
Compose an application screen with structured header, content, and footer regions.
View component sourceImport
ts
import { PageLayout } 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 { Horizontal, Text, View, Vertical } from 'app-studio';
import { Button, PageLayout } from '@app-studio/components';
/**
* A bordered, fixed-height frame stands in for a device screen so the pinned
* header/footer and scrollable middle are visible in the gallery.
*/
export const DefaultPageLayout = () => (
<View
height={420}
width="100%"
maxWidth={360}
borderRadius={16}
overflow="hidden"
borderWidth={1}
borderStyle="solid"
borderColor="color-gray-200"
>
<PageLayout
safe={false}
header={
<Horizontal
padding={16}
backgroundColor="color-blue-500"
justifyContent="center"
>
<Text color="color-white" fontWeight="bold">
Pinned Header
</Text>
</Horizontal>
}
footer={
<View padding={12} backgroundColor="color-white">
<Button width="100%">Submit</Button>
</View>
}
>
<Vertical padding={16} gap={12}>
{Array.from({ length: 20 }).map((_, i) => (
<View
key={i}
padding={16}
borderRadius={8}
backgroundColor="color-gray-100"
>
<Text>Scrollable row {i + 1}</Text>
</View>
))}
</Vertical>
</PageLayout>
</View>
);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 |
|---|---|---|---|
header | 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 | — | Pinned header rendered above the scrollable content.Source |
footer | 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 | — | Pinned footer (e.g. a submit bar). It rides above the keyboard on native because it sits inside the keyboard-avoiding region.Source |
isLoading | boolean | false | Replace the content with a centered Loader.Source |
safe | boolean | true | Apply device safe-area insets to the outer container. Default true.Source |
scrollable | boolean | true | Make the content area scroll when it overflows. Default true.Source |
dismissKeyboardOnTap | boolean | true | Tap an empty area to dismiss the keyboard (native only). Default true.Source |
keyboardVerticalOffset | number | 0 | Offset for the keyboard-avoiding region, e.g. a fixed header height.Source |
views | PageLayoutViews | {} | Per-slot style overrides.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 |
Common inherited styling props (7)
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
media | Record<string, CssProps> | — | See the type and source declaration for this property. |
onClick | any | — | Called when the user activates the component. |
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. |
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.