# @govuk-react/page

> Provides Page wrapper components.

Latest version **0.10.7** (published 2024-05-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @govuk-react/page
pnpm add @govuk-react/page
yarn add @govuk-react/page
bun add @govuk-react/page
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.7 |
| Published | 2024-05-13 |
| First published | 2018-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alasdair McLeay |
| Maintainers | loque-, steve_sims, petelockey, penx, marksy |

## Links

- npm: https://www.npmjs.com/package/@govuk-react/page
- Homepage: https://github.com/govuk-react/govuk-react/tree/main/components/page
- npm.io page: https://npm.io/package/@govuk-react/page

## Dependencies (4)

- [@govuk-react/lib](https://npm.io/package/@govuk-react/lib.md) ^0.10.7
- [@govuk-react/top-nav](https://npm.io/package/@govuk-react/top-nav.md) ^0.10.7
- [@govuk-react/constants](https://npm.io/package/@govuk-react/constants.md) ^0.10.7
- [@govuk-react/skip-link](https://npm.io/package/@govuk-react/skip-link.md) ^0.10.7

## Recent versions

- 0.10.7 (latest) — 2024-05-13
- 0.6.0-rc.1 (next) — 2019-02-28
- 0.10.6 — 2023-10-01
- 0.10.5 — 2022-11-22
- 0.10.4 — 2022-10-08
- 0.10.3 — 2022-08-20
- 0.10.2 — 2022-08-19
- 0.10.1 — 2022-04-08
- 0.10.0 — 2021-10-07
- 0.9.1 — 2021-09-06
- 0.9.0 — 2021-05-30
- 0.8.0 — 2021-05-16
- 0.7.1 — 2019-05-24
- 0.7.0 — 2019-03-15
- 0.6.0 — 2019-03-01
- … 8 more at https://npm.io/package/@govuk-react/page/versions

## README

Page
====

### Import
```js
  import Page from '@govuk-react/page';
```
<!-- STORY -->

Use this template to keep your pages consistent with the rest of GOV.UK.

- https://govuk-react.github.io/govuk-react/?path=/docs/page
- https://design-system.service.gov.uk/styles/page-template/
- https://design-system.service.gov.uk/styles/layout/#page-wrappers

### Properties
Prop | Required | Default | Type | Description
:--- | :------- | :------ | :--- | :----------
 `beforeChildren` |  | ```undefined``` | ReactNode | Content that needs to appear outside the main page wrapper (see `main`).<br/>For example: A back link component, breadcrumbs, phase banner component
 `children` |  | ```undefined``` | ReactNode | Page contents
 `container` |  | ```Page.WidthContainer``` | ElementType<any> | Override the default page container component.<br/>`beforeChildren` and `children` (wrapped in `main`) will be placed inside this component.
 `footer` |  | ```undefined``` | ReactNode | Override the default page footer component.
 `header` |  | ```<TopNav />``` | ReactNode | Override the default page header component.
 `id` |  | ```content``` | string | ID for page content
 `main` |  | ```Page.Main``` | ElementType<any> | Override the default wrapper component for main page content

---
_Source: https://npm.io/package/@govuk-react/page · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
