Page page link

Full documentation: https://webawesome.com/docs/components/page

<wa-page> Stable Since 3.0

Pages scaffold an entire application layout with header, navigation, sidebar, main content, aside, and footer regions. Use them to structure full pages with minimal markup and responsive behavior built in.

The page component is designed to power full webpages. It is flexible enough to handle most modern designs and includes a simple mechanism for handling desktop and mobile navigation.

Layout Anatomy layout anatomy link

This image depicts a page’s anatomy, including the default positions of each section. The labels represent the named slots you can use to populate them.

Most slots are optional. Slots that have no content will not be shown, allowing you to opt-in to just the sections you actually need.

Slots

banner header subheader navigation-header navigation navigation-footer main-header main-footer aside footer

Using wa-page using wa page link

If you’re not familiar with how slots work in HTML, you might want to learn more about slots before using this component.

A number of sections are available as part of the page component, most of which are optional. Content is populated by slotting elements into various locations.

This component does not implement any content sectioning or “semantic elements” internally (such as <main>, <header>, <footer>, etc.). Instead, we recommend that you slot in content sectioning elements wherever you feel they’re appropriate.

When using <wa-page>, make sure to zero out all paddings and margins on <html> and <body>, otherwise you may see unexpected gaps. We highly recommend adding the following styles when using <wa-page>:

html,
body {
  min-height: 100%;
  padding: 0;
  margin: 0;
}

If you use native styles, this is already taken care of.

Examples examples link

Open demos in a new tab to examine their behavior in different window sizes. The previews below use simulated zooming which, depending on your browser, may not be accurate.

Documentation documentation link

A sample documentation page using all available slots. The navigation menu collapses into a drawer at a custom mobile-breakpoint of 920px. It can be opened using a button with [data-toggle-nav] that appears in the subheader slot. The aside slot is also hidden below 920px.

Open demo in a new window

Media media link

A sample media app page using header, navigation-header, main-header, and main-footer along with the default slot. The navigation menu collapses into a drawer at the default mobile-breakpoint and can be opened using a button with [data-toggle-nav] that appears in the header slot.

Open demo in a new window

Customization customization link

Sticky Sections sticky sections link

The following sections of a page are “sticky” by default, meaning they remain in position as the user scrolls.

banner
header
sub-header
menu (navigation itself is not sticky, but its parent menu is)
aside

This is often desirable, but you can change this behavior using the disable-sticky attribute. Use a space-delimited list of names to tell the page which sections should not be sticky.

<wa-page disable-sticky="header aside"> ... </wa-page>

The layout provides a “skip to content” link that’s visually hidden until the user tabs into it. You don’t have to do anything to configure this, unless you want to change the text displayed in the link. In that case, you can slot in your own text using the skip-to-content slot.

This example localizes the “skip to content” link for German users.

<wa-page>
  ...
  <span slot="skip-to-content">Zum Inhalt springen</span>
  ...
</wa-page>

Responsiveness responsiveness link

A page isn’t very opinionated when it comes to responsive behaviors, but there are tools in place to help make responsiveness easy.

Default Slot Styles default slot styles link

Each slot is a flex container and specifies some flex properties so that your content is reasonably responsive by default.

The following slots specify justify-content: space-between and flex-wrap: wrap to evenly distribute child elements horizontally and allow them to wrap when space is limited.

header
subheader
main-header
main-footer
footer

The following slots specify flex-direction: column to arrange child elements vertically.

navigation-header
navigation (or menu)
navigation-footer
aside

And the banner slot specifies justify-content: center to horizontally center its child elements.

You can override the default display and flex properties for each slot with your own CSS.

When you use the navigation slot, your slotted content automatically collapses into a drawer on smaller screens. The breakpoint at which this occurs is 768px by default, but you can change it using the mobile-breakpoint attribute, which takes either a number or a CSS length.

<wa-page mobile-breakpoint="600"> ... </wa-page>

By default, a “hamburger” button appears in the header slot to toggle the navigation menu on smaller screens. You can customize what this looks like by slotting your own button in the toggle-navigation slot or place the data-toggle-nav attribute on any button on your page. This does not have to be a Web Awesome element.

The default button will not be shown when using either of these methods — if you want to use multiple navigation toggles on your page, simply add the data-toggle-nav attribute to multiple elements.

<wa-page mobile-breakpoint="600">
  ...
  <wa-button data-toggle-nav>Menu</wa-button>
  ...
</wa-page>

Alternatively, you can apply nav-state="open" and nav-state="closed" to the layout component to show and hide the navigation, respectively.

<wa-page nav-state="open"> ... </wa-page>

<wa-page> is given the attribute view="mobile" or view="desktop" when the viewport narrower or wider than the mobile-breakpoint value, respectively. You can leverage these attributes to change styles depending on the size of the viewport. This is especially useful to hide your data-toggle-nav button when the viewport is wider.

wa-page[view='desktop'] [data-toggle-nav] {
  display: none;
}

If you use native styles, this is already taken care for you, and the data-toggle-nav button is already hidden on wider screens.

Custom Widths custom widths link

You specify widths for some slots on your page with CSS custom properties for --menu-width, --main-width, and --aside-width.

If you specify --menu-width to apply a specific width to your navigation slot, space will still be reserved on the page even below the mobile-breakpoint. To collapse this space on smaller screens, add the following code to your styles.

wa-page[view='mobile'] {
  --menu-width: auto;
}

You can use a similar approach for --aside-width to hide the aside slot on smaller screens. Be sure to also specify display: none for the slot:

wa-page[view='mobile'] {
  --aside-width: auto;

  [slot='aside'] {
    display: none;
  }
}

Spacing spacing link

A page specifies default padding within each slot and a gap between the slot’s direct children. You can drop elements into any slot, and reasonable spacing is already applied for you.

You can override the default spacing for each slot with your own CSS. In this example, we’re setting custom gap and padding for the footer slot.

[slot='footer'] {
  gap: var(--wa-space-xl);
  padding: var(--wa-space-xl);
}

Utility classes utility classes link

Native styles define a few useful defaults for <wa-page>, as well as two utility classes you can use for common responsive design tasks:

.wa-mobile-only hides an element on the desktop view
.wa-desktop-only hides an element on the mobile view

Importing importing link

If you’re using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

**CDN**

Import this component directly from the CDN:

import 'https://ka-f.webawesome.com/webawesome@3.7.0/components/page/page.js';

**npm**

After installing Web Awesome via npm, import this component:

import '@awesome.me/webawesome/dist/components/page/page.js';

**Self-Hosted**

If you’re self-hosting Web Awesome, import this component from your server:

import './webawesome/dist/components/page/page.js';

**React**

To import this component for React 18 or below, use the following code:

import WaPage from '@awesome.me/webawesome/dist/react/page/index.js';

Slots slots link

Learn more about using slots.

| Name | Description | | — | — | | (default) | The page’s main content. | | `aside` | Content to be shown on the right side of the page. Typically contains a table of contents, ads, etc. This section “sticks” to the top as the page scrolls. | | `banner` | The banner that gets display above the header. The banner will not be shown if no content is provided. | | `footer` | The content to display in the footer. This is always displayed underneath the viewport so will always make the page “scrollable”. | | `header` | The header to display at the top of the page. If a banner is present, the header will appear below the banner. The header will not be shown if there is no content. | | `main-footer` | Footer to display inline below the main content. | | `main-header` | Header to display inline above the main content. | | `menu` | `navigation` The left side of the page. If you slot an element in here, you will override the default slot and will be handling navigation on your own. This also will not disable the fallback behavior of the navigation button. This section “sticks” to the top as the page scrolls. | | `navigation` | `menu` The main content to display in the navigation area. This is displayed on the left side of the page, if is not used. This section “sticks” to the top as the page scrolls. | | `navigation-footer` | `` The footer for a navigation area. On mobile this will be the footer for . | | `navigation-header` | `` The header for a navigation area. On mobile this will be the header for . | | `navigation-toggle` | `` Use this slot to slot in your own button + icon for toggling the navigation drawer. By default it is a + a 3 bars ` Use this to slot in your own icon for toggling the navigation drawer. By default it is 3 bars . | | `skip-to-content` | `Skip to content` The “skip to content” slot. You can override this If you would like to override the button and add additional “Skip to X”, they can be inserted here. | | `subheader` | `header` A sub to display below the header. This is a good place to put things like breadcrumbs. |

Attributes & Properties attributes properties link

Learn more about attributes and properties.

Name	Description	Reflects
`css`	`CSSResultGroup \\| undefined` One or more CSSResultGroup to include in the component’s shadow root. Host styles are automatically prepended. Type Default [visuallyHidden, styles]
`disableNavigationToggle` disable-navigation-toggle	`data-toggle-nav` Determines whether or not to hide the default hamburger button. This will automatically flip to “true” if you add an element with anywhere in the element light DOM. Generally this will be set for you and you don’t need to do anything, unless you’re using SSR, in which case you should set this manually for initial page loads. Type boolean Default false
`mobileBreakpoint` mobile-breakpoint	`50em` At what page width to hide the “navigation” slot and collapse into a hamburger button. Accepts both numbers (interpreted as px) and CSS lengths (e.g. ), which are resolved based on the root element. Type string Default ‘768px’
`navigationPlacement` navigation-placement	`‘start’ \\| ‘end’` Where to place the navigation when in the mobile viewport. Type Default ‘start’
`navOpen` nav-open	`boolean` Whether or not the navigation drawer is open. Note, the navigation drawer is only “open” on mobile views. Type Default false
`view` view	`mobile-breakpoint` The view is a reflection of the “mobileBreakpoint”, when the page is larger than the (768px by default), it is considered to be a “desktop” view. The view is merely a way to distinguish when to show/hide the navigation. You can use additional media queries to make other adjustments to content as necessary. The default is “desktop” because the “mobile navigation drawer” isn’t accessible via SSR due to drawer requiring JS. Type ‘mobile’ \| ‘desktop’ Default ‘desktop’

Methods methods link

Learn more about methods.

Name	Description	Arguments
`hideNavigation()`	Hides the mobile navigation drawer
`showNavigation()`	Shows the mobile navigation drawer
`toggleNavigation()`	Toggles the mobile navigation drawer
`visiblePixelsInViewport()`	https://stackoverflow.com/a/26831113 This prevents awkward gaps when scrolling the page and the aside / menu dont “fill” the gaps.	`element: HTMLElement \\| null`

CSS custom properties css custom properties link

Learn more about CSS custom properties.

Name	Description
`–aside-width`	`auto` The wide of the page’s “aside” section. Default
`–banner-height`	`0px` The height of the banner. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. Default
`–header-height`	`0px` The height of the header. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. Default
`–main-width`	`1fr` The width of the page’s “main” section. Default
`–menu-width`	`auto` The width of the page’s “menu” section. Default
`–subheader-height`	`0px` The height of the subheader. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. Default

CSS parts css parts link

Learn more about CSS parts.

Name	Description	CSS selector
`aside`	The right hand side of the page. Used for things like table of contents, ads, etc.	`::part(aside)`
`banner`	The banner to show above header.	`::part(banner)`
`base`	The component’s base wrapper.	`::part(base)`
`body`	The wrapper around menu, main, and aside.	`::part(body)`
`dialog-wrapper`	A wrapper around elements such as dialogs or other modal-like elements.	`::part(dialog-wrapper)`
`footer`	The footer of the page. This is always below the initial viewport size.	`::part(footer)`
`header`	The header, usually for top level navigation / branding.	`::part(header)`
`main-content`	The main content.	`::part(main-content)`
`main-footer`	The footer below main content.	`::part(main-footer)`
`main-header`	The header above main content.	`::part(main-header)`
`menu`	The left hand side of the page. Generally intended for navigation.	`::part(menu)`
`navigation`	`

Need a hand? Report a bug Ask for help

Page