@justeattakeaway/pie-assistive-text

Table of Contents

1. Introduction
2. Installation
3. Importing the component
4. Peer Dependencies
5. Props
6. Slots
7. Contributing

pie-assistive-text

pie-assistive-text 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-assistive-text in your application, run the following on your command line:

# npm
$ npm i @justeattakeaway/pie-assistive-text

# yarn
$ yarn add @justeattakeaway/pie-assistive-text

For full information on using PIE components as part of an application, check out the Getting Started Guide.

Importing the component

JavaScript

// Default – for Native JS Applications, Vue, Angular, Svelte, etc.
import { PieAssistiveText } from '@justeattakeaway/pie-assistive-text';

// 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-assistive-text';

React

// React
// For React, you will need to import our React-specific component build
// which wraps the web component using ​@lit/react
import { PieAssistiveText } from '@justeattakeaway/pie-assistive-text/dist/react';

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

Peer Dependencies

[!IMPORTANT] When using pie-assistive-text, you will also need to include a couple of dependencies to ensure the component renders as expected. See the PIE Wiki for more information and how to include these in your application.

Props

Property	Type	Default	Description
variant	string	default	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.

Slots

Property	Description
default	The default, unnamed slot is used to pass in text to the component.

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

<!-- Native HTML -->
<pie-assistive-text
  variant="success">
  Your request has been submitted.
</pie-assistive-text>

<!-- JSX -->
<PieAssistiveText
  variant="error">
  Password contains too few characters.
</PieAssistiveText>

Contributing

Check out our contributing guide for more information on local development and how to run specific component tests.