# @govuk-react/header

> Outputs a styled heading tag of provided level, rendering children as contents.

Latest version **0.8.0** (published 2021-05-16) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.0 |
| Published | 2021-05-16 |
| First published | 2018-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 48 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/header
- Homepage: https://github.com/govuk-react/govuk-react/tree/master/components/header
- npm.io page: https://npm.io/package/@govuk-react/header

## Dependencies (3)

- [@govuk-react/hoc](https://npm.io/package/@govuk-react/hoc.md) ^0.8.0
- [@govuk-react/lib](https://npm.io/package/@govuk-react/lib.md) ^0.8.0
- [@govuk-react/constants](https://npm.io/package/@govuk-react/constants.md) ^0.8.0

## Recent versions

- 0.8.0 (latest) — 2021-05-16
- 0.6.0-rc.1 (next) — 2019-02-28
- 0.7.1 — 2019-05-24
- 0.7.0 — 2019-03-15
- 0.6.0 — 2019-03-01
- 0.6.0-alpha.4 — 2019-02-15
- 0.6.0-alpha.1 — 2019-02-07
- 0.6.0-alpha.0 — 2019-02-07
- 0.5.1 — 2019-02-04
- 0.5.0 — 2019-01-21
- 0.4.0 — 2019-01-14
- 0.3.1 — 2018-11-07
- 0.3.0 — 2018-10-29
- 0.2.12 — 2018-09-26
- 0.2.7 — 2018-06-29
- … 14 more at https://npm.io/package/@govuk-react/header/versions

## README

Header
======

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

### Usage

This component is DEPRECATED.

Please use the `Heading` component instead.

### Properties
Prop | Required | Default | Type | Description
:--- | :------- | :------ | :--- | :----------
 `level` |  | ```1``` | number | Semantic heading level value between 1 and 6
 `size` |  | ```undefined``` | enum(...Object.keys(HEADING_SIZES) \| ...Object.keys(TYPOGRAPHY_SCALE)) | Visual size level, accepts:<br/>   `XLARGE`, `LARGE`, `MEDIUM`, `SMALL`, `XL`, `L`, `M`, `S`<br/>   or a numeric size that fits in the GDS font scale list

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