# @govuk-react/hidden-text

> Renders a styled details element along with summary from prop and children rendered as contents.

Latest version **0.5.1** (published 2019-02-04) · MIT license · 0 weekly downloads

## Install

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

## 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.5.1 |
| Published | 2019-02-04 |
| First published | 2018-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 50.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alasdair McLeay |
| Maintainers | loque-, marksy, penx, petelockey, steve_sims |

## Links

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

## Dependencies (5)

- [govuk-colours](https://npm.io/package/govuk-colours.md) ^1.0.3
- [@govuk-react/hoc](https://npm.io/package/@govuk-react/hoc.md) ^0.5.1
- [@govuk-react/constants](https://npm.io/package/@govuk-react/constants.md) ^0.5.1
- [@govuk-react/paragraph](https://npm.io/package/@govuk-react/paragraph.md) ^0.5.1
- [@govuk-react/inset-text](https://npm.io/package/@govuk-react/inset-text.md) ^0.5.1

## Recent versions

- 0.5.1 (latest) — 2019-02-04
- 0.6.0-alpha.0 — 2019-02-07
- 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.9 — 2018-07-17
- 0.2.8 — 2018-07-10
- 0.2.7 — 2018-06-29
- 0.2.6 — 2018-06-29
- 0.2.4 — 2018-06-14
- 0.2.3 — 2018-06-07

## README

HiddenText
==========

### Import
```js
  import HiddenText from '@govuk-react/hidden-text';
```
<!-- STORY -->

### Usage


Simple
```jsx
import Paragraph from '@govuk-react/paragraph';

<HiddenText summaryText={'Help with nationality'}>
  <Paragraph mb={0}>I am a paragraph. Please read me.</Paragraph>
</HiddenText>
```

### References
- https://govuk-elements.herokuapp.com/typography/#typography-hidden-text
- https://github.com/alphagov/govuk-frontend/blob/master/src/components/details/_details.scss

### Properties
Prop | Required | Default | Type | Description
:--- | :------- | :------ | :--- | :----------
 `children` |  | ```undefined``` | node | The nodes that will be displayed within the InsetText component
 `summaryText` | true | `````` | string | Text for the summary button link e.g. Help with nationality

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