# @justeattakeaway/pie-ai-suggestions

> PIE Design System Ai Suggestions built using Web Components

Latest version **0.6.1** (published 2026-04-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @justeattakeaway/pie-ai-suggestions
pnpm add @justeattakeaway/pie-ai-suggestions
yarn add @justeattakeaway/pie-ai-suggestions
bun add @justeattakeaway/pie-ai-suggestions
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

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

## Links

- npm: https://www.npmjs.com/package/@justeattakeaway/pie-ai-suggestions
- npm.io page: https://npm.io/package/@justeattakeaway/pie-ai-suggestions

## Dependencies (15)

- [@justeattakeaway/pie-tag](https://npm.io/package/@justeattakeaway/pie-tag.md) 0.22.4
- [@justeattakeaway/pie-chip](https://npm.io/package/@justeattakeaway/pie-chip.md) 0.12.2
- [@justeattakeaway/pie-modal](https://npm.io/package/@justeattakeaway/pie-modal.md) 1.10.1
- [@justeattakeaway/pie-radio](https://npm.io/package/@justeattakeaway/pie-radio.md) 0.8.0
- [@justeattakeaway/pie-button](https://npm.io/package/@justeattakeaway/pie-button.md) 1.6.2
- [@justeattakeaway/pie-divider](https://npm.io/package/@justeattakeaway/pie-divider.md) 1.4.1
- [@justeattakeaway/pie-checkbox](https://npm.io/package/@justeattakeaway/pie-checkbox.md) 0.16.2
- [@justeattakeaway/pie-thumbnail](https://npm.io/package/@justeattakeaway/pie-thumbnail.md) 0.4.0
- [@justeattakeaway/pie-webc-core](https://npm.io/package/@justeattakeaway/pie-webc-core.md) 1.0.0
- [@justeattakeaway/pie-form-label](https://npm.io/package/@justeattakeaway/pie-form-label.md) 0.16.1
- [@justeattakeaway/pie-icons-webc](https://npm.io/package/@justeattakeaway/pie-icons-webc.md) 1.10.1
- [@justeattakeaway/pie-text-input](https://npm.io/package/@justeattakeaway/pie-text-input.md) 0.28.2
- [@justeattakeaway/pie-icon-button](https://npm.io/package/@justeattakeaway/pie-icon-button.md) 1.5.1
- [@justeattakeaway/pie-icons-configs](https://npm.io/package/@justeattakeaway/pie-icons-configs.md) 4.5.1
- [@justeattakeaway/pie-assistive-text](https://npm.io/package/@justeattakeaway/pie-assistive-text.md) 0.10.2

## Recent versions

- 0.6.1 (latest) — 2026-04-07
- 0.0.0-snapshot-release-20250918205629 (snapshot-release) — 2025-09-18
- 0.6.0 — 2026-03-02
- 0.5.2 — 2025-09-22
- 0.0.0-snapshot-release-20250918191342 — 2025-09-18
- 0.5.1 — 2025-09-09
- 0.0.0-snapshot-release-20250908111915 — 2025-09-08
- 0.5.0 — 2025-08-19
- 0.4.0 — 2025-08-15
- 0.0.0-snapshot-release-20250812095116 — 2025-08-12
- 0.0.0-snapshot-release-20250811125937 — 2025-08-11
- 0.0.0-snapshot-release-20250807134136 — 2025-08-07
- 0.3.0 — 2025-05-22
- 0.0.0-snapshot-release-20250522113840 — 2025-05-22
- 0.2.2 — 2025-04-28
- … 12 more at https://npm.io/package/@justeattakeaway/pie-ai-suggestions/versions

## README

<p align="center">
  <img align="center" src="../../../readme_image.png" height="200" alt="">
</p>

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

# Table of Contents

1. [Introduction](#pie-ai-suggestions)
2. [Installation](#installation)
3. [Importing the component](#importing-the-component)
4. [Peer Dependencies](#peer-dependencies)
5. [Props](#props)
6. [Events](#events)
7. [Contributing](#contributing)

## pie-ai-suggestions

`pie-ai-suggestions` is a Web Component built using the Lit library.

This component can be easily integrated into various frontend frameworks and customized through a set of properties.

## Installation

To install `pie-ai-suggestions` in your application, run the following on your command line:

```bash
# npm
$ npm i @justeattakeaway/pie-ai-suggestions

# yarn
$ yarn add @justeattakeaway/pie-ai-suggestions
```

For full information on using PIE components as part of an application, check out the [Getting Started Guide](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components).

### Importing the component

#### JavaScript

```js
// Default – for Native JS Applications, Vue, Angular, Svelte, etc.
import { PieAiSuggestions } from '@justeattakeaway/pie-ai-suggestions';

// If you don't need to reference the imported object, you can simply
// import the module which registers the component as a custom element.
import '@justeattakeaway/pie-ai-suggestions';
```

#### React

```js
// React
// For React, you will need to import our React-specific component build
// which wraps the web component using ​@lit/react
import { PieAiSuggestions } from '@justeattakeaway/pie-ai-suggestions/dist/react';
```

> [!NOTE]
> When using the React version of the component, please make sure to also
> include React as a [peer dependency](#peer-dependencies) in your project.


## Peer Dependencies

> [!IMPORTANT]
> When using `pie-ai-suggestions`, you will also need to include a couple of dependencies to ensure the component renders as expected. See [the PIE Wiki](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components#expected-dependencies) for more information and how to include these in your application.


## Props

| Property | Type | Default | Description |
|----------|------|---------|-------------|
| `itemName` | `string` | `''` | The name of the menu item with AI suggestions |
| `texts` | `AiSuggestionsTexts` | - | UI text strings for the component |
| `sections` | `AiSuggestionsSections` | `{}` | Configuration for AI suggestion sections (tags, abv, allergens, gtin) |
| `intro` | `Intro` | `undefined` | Optional intro dialog configuration |
| `isOpen` | `boolean` | `false` | Controls whether the modal is displayed |

See [defs.ts](./src/defs.ts) for complete TypeScript definitions.

### Sections

The component supports four optional section types:

| Section | Purpose |
|---------|---------|
| `tags` | Dietary information tags (vegan, vegetarian, etc.) |
| `abv` | Alcohol by volume percentage |
| `allergens` | Allergen information with confirmation modal |
| `gtin` | Product barcode identification |

## Events

| Event | Description |
|-------|-------------|
| `pie-ai-suggestions-submit` | Fired when user submits or rejects suggestions |
| `pie-ai-suggestions-close` | Fired when the component is closed |
| `pie-ai-suggestions-error` | Fired when an error occurs |

### Usage

In your markup or JSX, you can then use these to set the properties for the `pie-ai-suggestions` component:

```html
<!-- Native HTML -->
<pie-ai-suggestions
    itemName="Pepsi can"
    .texts="${textsConfig}"
    .sections="${sectionsConfig}"
    ?isOpen="${true}"
    @pie-ai-suggestions-submit="${handleSubmit}">
</pie-ai-suggestions>

<!-- JSX -->
<PieAiSuggestions
    itemName="Pepsi can"
    texts={textsConfig}
    sections={sectionsConfig}
    isOpen={true}
    onPieAiSuggestionsSubmit={handleSubmit}
/>
```

## 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-ai-suggestions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
