Components/Layout/Page
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/page
Use the page component to build the structure of each page. It's designed for Business Manager applications but can be customized for other use cases too.
<MarketingPageLayout/> instead.This component consists of <Page.Header/> and <Page.Content/> areas. Both are mandatory in the Business Manager page layout.
Set page height using viewport height unit (vh). By default, page height should equal 100vh (full screen size). If the page has a Business Manager top bar navigation, set the page height to calc(100vh-48px).
Add constraints to content width with the following props:
minWidth specifies the minimum content width.maxWidth specifies the maximum content width. When the limit is reached, the side margins stretch and the content aligns to the center of the page.By default, the page minimum width is 864px and the maximum width is 1248px (plus 48px padding on the sides). These values should be used across all Business Manager pages but can be changed for other use cases.
Control left and right content padding with the sidePadding prop. The default value is 48px and should be used across all Business Manager pages. The default padding can be changed for other use cases.
Add a background image to the page header with backgroundImageUrl prop. Use it to showcase things like services, products or other items you want to feature.
The <Page.Header/> sticks to the top of the page and minimizes when visitors scroll down. This default behavior can't be changed.
Enable horizontal scroll with the horizontalScroll prop.
When visitors scroll, the <Page.Header/> stays fixed. Use it when the width of content exceeds the maximum page width. For example, when displaying wide tables or lists.
Pin content below the header by wrapping it into a <Page.Tail/> container. Use it for content that needs to be visible at all times, for example a table header in an infinite scroll table.
Wrap page sections into <Page.Sticky/> containers to keep a section fixed in position while visitors scroll.
Create anchor links that direct visitors to a place inside the page using references (ref) and onClick events.
When there's no data to display on a page, use an <EmptyState/> with a clear call to action that tells visitors what they should do next.
<Tabs/> can be used to show more content with the same hierarchy level on the same page. Use <Page.Tail/> to fix tabs below the page header so visitors can navigate between content.
Make sure the form page has "Save" and "Cancel" both at the top and the bottom of the page. Use <Page.Footer/> container to store actions at the end of a form.
For form page layouts, use an 8 column layout and keep 4 columns blank. This makes it easier to scan.
Use a <Layout/> grid to construct a ⅔ form layout that exposes primary and secondary content at the same time. To fix the sidebar's position while scrolling through the main page content, use <Page.Sticky/>.
Use <Page.Sticky/> to fix the position of the content to a specific part of the page. For example, fixing the column titles of a table so visitors can sort and filter easily.
Use a 2-column page layout to list features, tools or products. This layout works well for items that have relatively long titles and descriptions.
Use a grid page layout with 4 columns to display visual items like, menus, categories, collections and photo albums.
Use a combination of different grids within the same page. This is a great way to display different types of content on one page. Use <Page.Section/> to divide content into groups.
| Name | Type | Default | Description |
|---|---|---|---|
backgroundImageUrl | string | — | Provides a link to the background image source (URL). The image is displayed at the top of the page, underneath the <Page.Header/>. |
children | ReactNode | — | Accepts compound components as child items: - <Page.Header/> - <Page.Content/> - <Page.Tail/> - <Page.Section/> - <Page.Footer/> |
dataHook | string | — | Applies a data-hook HTML attribute that can be used in the tests. |
gradientClassName | string | — | Specifies a CSS class name that defines a gradient background for <Page.Header/>. |
height | string | — | Sets the height of the page in pixels (px), viewport height (vh), etc. |
horizontalScroll | boolean | — | Enables page content to scroll horizontally when its width exceed maximum allowed width. |
maxWidth (required) | number | — | Sets the maximum width of the page (paddings excluded) |
minWidth | number | — | Sets the minimum width of the page (paddings excluded). When mobile is enabled on <WixDesignSystemProvider/>, the default minimum width is removed, but an explicitly provided value is still applied. |
scrollableContentRef | (ref: HTMLElement | null) => void | — | Defines a reference called together with page scrollable content ref after page mount. Note - if you need this ref only for listening to scroll events on the scrollable content then use this prop instead: scrollProps = {onScrollChanged/onScrollAreaChanged} |
scrollProps (required) | ScrollableContainerCommonProps | — | Pass properties related to the scrollable content of the page. onScrollAreaChanged - defines a handler function for scroll area changes. Function is triggered when the user scrolls to a different area of the scrollable content. See signature for possible areas: function({area: {y: AreaY, x: AreaX}, target: HTMLElement}) => void AreaY: top | middle | bottom | none AreaX: start | middle | end | none (not implemented yet) onScrollAreaChanged - defines a general handler for scroll changes with throttling (100ms): function({target: HTMLElement}) => void |
sidePadding | number | — | Sets the side paddings of a page. Also applies when <Page.Content/> is fullScreen. |
verticalPadding | number | — | Sets the top and bottom paddings of the page content in pixels. The top padding applies only when the page has no <Page.Header/> or <Page.Tail/>, and the bottom padding only when it has no <Page.FixedFooter/>. When not set, the content has no top padding and a 48px bottom padding. |
zIndex | number | — | Specifies the stack order (z-index) of a page. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
hasClass | — |
scrollableContainer | Provides a UniDriver for the page's scrollable container. |
backgroundImageExists | true if header background image exist |
gradientClassNameExists | true if gradient class name exist |
tailExists | true if tail exist in DOM |
gradientContainerHeight | return container height |
getPageHtml | returns html in a string form |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
click | Clicks on the component root element. |
base | Returns UniDriver for the base element. |
scrollableContainer property to the UniDriver so tests can access the page's scrollable content. (#17444)stretchVertically to Page.Content, so content such as a <Card stretchVertically/> can fill the page's visible height, and a verticalPadding prop to set the content's top and bottom padding. A sidePadding set on Page now also applies to fullScreen content, which previously dropped it. (#17337) — has visual changes#F8F6F6 to #F7F7F7 in Harmony (odeditor). (#16941)Last updated: 26 October 2026