# @justeattakeaway/pie-assistive-text

> PIE Design System Assistive Text built using Web Components

Latest version **1.0.19** (published 2026-11-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @justeattakeaway/pie-assistive-text
pnpm add @justeattakeaway/pie-assistive-text
yarn add @justeattakeaway/pie-assistive-text
bun add @justeattakeaway/pie-assistive-text
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.19 |
| Published | 2026-11-18 |
| First published | 2024-02-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 21.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 42 |
| Author | Just Eat Takeaway.com - Design System Team |
| Maintainers | mwh1989, anastasiia.horban, ashleynolan, jamieomaguire, lizzie.turney, davidpn.11, roberto.santana, mmakwe-onyeka, fozzie-bot, siggerzz, maledr5 |

## Links

- npm: https://www.npmjs.com/package/@justeattakeaway/pie-assistive-text
- Repository: https://github.com/justeattakeaway/pie
- Homepage: https://webc.pie.design/?path=/docs/components-assistive-text--overview
- Issues: https://github.com/justeattakeaway/pie/issues
- npm.io page: https://npm.io/package/@justeattakeaway/pie-assistive-text

## Dependencies (2)

- [@justeattakeaway/pie-webc-core](https://npm.io/package/@justeattakeaway/pie-webc-core.md) 22.1.0
- [@justeattakeaway/pie-icons-webc](https://npm.io/package/@justeattakeaway/pie-icons-webc.md) 1.31.1

## Recent versions

- 1.0.19 (latest) — 2026-11-18
- 0.0.0-snapshot-release-20261118102158 (snapshot-release) — 2026-11-18
- 1.0.18 — 2026-11-18
- 0.0.0-snapshot-release-20261117171525 — 2026-11-17
- 0.0.0-snapshot-release-20261117100349 — 2026-11-17
- 0.0.0-snapshot-release-20261117084101 — 2026-11-17
- 0.0.0-snapshot-release-20261110113822 — 2026-11-10
- 1.0.17 — 2026-11-05
- 0.0.0-snapshot-release-20261104130132 — 2026-11-04
- 0.0.0-snapshot-release-20261104103259 — 2026-11-04
- 0.0.0-snapshot-release-20261103180059 — 2026-11-03
- 1.0.16 — 2026-10-14
- 0.0.0-snapshot-release-20261013151643 — 2026-10-13
- 0.0.0-snapshot-release-20261013150640 — 2026-10-13
- 0.0.0-snapshot-release-20261013143817 — 2026-10-13
- … 267 more at https://npm.io/package/@justeattakeaway/pie-assistive-text/versions

## README

# @justeattakeaway/pie-assistive-text
[Source Code](https://github.com/justeattakeaway/pie/tree/main/packages/components/pie-assistive-text) | [Design Documentation](https://pie.design/components/assistive-text) | [NPM](https://www.npmjs.com/package/@justeattakeaway/pie-assistive-text)

<p>
  <a href="https://www.npmjs.com/@justeattakeaway/pie-assistive-text">
    <img alt="GitHub Workflow Status" src="https://img.shields.io/npm/v/@justeattakeaway/pie-assistive-text.svg">
  </a>
</p>

`@justeattakeaway/pie-assistive-text` is a Web Component built using the Lit library. It offers a simple and accessible assistive-text component for web applications to use in forms.

## Table of Contents

- [Installation](#installation)
- [Documentation](#documentation)
  - [Properties](#properties)
  - [Slots](#slots)
  - [CSS Variables](#css-variables)
  - [Events](#events)
- [Usage Examples](#usage-examples)
- [Questions and Support](#questions-and-support)
- [Contributing](#contributing)

## Installation

> To install any of our web components in your application, we would suggest following the [getting started guide](https://webc.pie.design/?path=/docs/introduction-getting-started--docs) to set up your project.

Ideally, you should install the component using the **`@justeattakeaway/pie-webc`** package, which includes all of the components. Or you can install the individual component package.

## Documentation

### Properties

| Prop              | Options                           | Description                                                                                                                                                                                                                                   | Default   |
|-------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
| `variant`         | `"default"`, `"error"`, `"success"` | Sets the type of message displayed to one of three potential options: `error`, `success` or `default`. `error` and `success` include an icon and are used for validation messages. `default` provides users with extra context and guidance. | `default` |
| `message`         | `string`                           | The assistive message text content.                                                                                                                                                                                                          | `""`      |
| `isVisuallyHidden`| `true`, `false`                    | If true, hides the component visually but leaves it accessible for screen readers.                                                                                                                                                           | `false`   |

### Slots
This component does not have any slots. All content is controlled through properties.

### CSS Variables
This component does not expose any CSS variables for style overrides.

### Events

This component does not emit any custom events. In order to add event listening to this component, you can treat it like a native HTML element in your application.

## Usage Examples

**For HTML:**

```js
// import as module into a js file e.g. main.js
import '@justeattakeaway/pie-webc/components/assistive-text.js'
```

```html
<pie-assistive-text
  variant="success"
  message="Your request has been submitted.">
</pie-assistive-text>

<script type="module" src="/main.js"></script>
```

**For Native JS Applications, Vue, Angular, Svelte etc.:**

```js
// import as module into a js file that will be loaded on the page where the component is used.
import '@justeattakeaway/pie-webc/components/assistive-text.js';
```

```html
<pie-assistive-text
  variant="success"
  message="Your request has been submitted.">
</pie-assistive-text>
```

**For React Applications:**

```jsx
import { PieAssistiveText } from '@justeattakeaway/pie-webc/react/assistive-text.js';

<PieAssistiveText
  variant="success"
  message="Your request has been submitted."
/>
```

## Questions and Support

If you work at Just Eat Takeaway.com, please contact us on **#help-designsystem**. Otherwise, please raise an issue on [Github](https://github.com/justeattakeaway/pie/issues).

## Contributing

Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing).

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