This package has been deprecated

Author message:

Please use @justeattakeaway/pie-text-input instead

@justeattakeaway/pie-input

Table of Contents

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

pie-input

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

# npm
$ npm i @justeattakeaway/pie-input

# yarn
$ yarn add @justeattakeaway/pie-input

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 { PieInput } from '@justeattakeaway/pie-input';

// 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-input';

React

// React
// For React, you will need to import our React-specific component build
// which wraps the web component using ​@lit/react
import { PieInput } from '@justeattakeaway/pie-input/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-input, 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
autocomplete	string	-	Allows the user to enable or disable autocomplete functionality on the input field. See MDN for more information and values.
autoFocus	boolean	-	If true, the input will be focused on the first render. No more than one element in the document or dialog may have the autofocus attribute. If applied to multiple elements the first one will receive focus. See MDN for more information.
inputmode	'none', 'text', 'tel', 'url', 'email', 'numeric', 'decimal', 'search'	-	Provides a hint to browsers as to the type of virtual keyboard configuration to use when editing this element. See MDN for more information.
maxlength	number	-	Maximum length (number of characters) of value. Only applies to types: text, url, tel, email, and password.
minlength	number	-	Minimum length (number of characters) of value. Only applies to types: text, url, tel, email, and password.
name	string	-	The name of the input (used as a key/value pair with value). This is required in order to work properly with forms.
pattern	string	-	Specifies a regular expression the form control's value should match.
placeholder	string	-	The placeholder text to display when the input is empty. Only applies to types: text, url, tel, email, and password.
readonly	boolean	-	When true, the user cannot edit the control. Not the same as disabled. See MDN for more information.
type	'text', 'number', 'password', 'url', 'email', 'tel'	text	The type of HTML input to render.
value	string	''	The value of the input (used as a key/value pair in HTML forms with name).
assistiveText	string	''	Allows assistive text to be displayed below the input element.
status	'error', 'success'	undefined	The status of the input component / assistive text.
step	number	-	An optional amount that value should be incremented or decremented by when using the up and down arrows in the input. Only applies when type is number.
min	number	-	The minimum value of the input. Only applies when type is number. If the value provided is lower, the input is invalid.
max	number	-	The maximum value of the input. Only applies when type is number. If the value provided is higher, the input is invalid.
size	'small', 'medium', 'large'	medium	The size of the input field. Can be small, medium, or large. Defaults to medium.
required	boolean	false	If true, the input is required to have a value before submitting the form. If there is no value, then the component validity state will be invalid.

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

<!-- Native HTML -->
<pie-input
    autocomplete="on"
    autoFocus
    inputmode="text"
    maxlength="8"
    minlength="4"
    name="myinput"
    pattern="[a-z]{4,8}"
    placeholder="Please enter a value"
    readonly
    type="text"
    value="">
</pie-input>

<!-- JSX -->
<PieInput
    autocomplete="on"
    autoFocus
    inputmode="text"
    maxlength={8}
    minlength={4}
    name="myinput"
    pattern="[a-z]{4,8}"
    placeholder="Please enter a value"
    readonly
    type="text"
    value="">
</PieInput>

Events

Event	Type	Description
change	CustomEvent	Triggered when the input loses focus after it's value has changed.
input	InputEvent	Triggered when the input value is changed.

Slots

Slot	Description
leading	An icon or short text to display at the start of the input.
trailing	An icon or short text to display at the end of the input.

Contributing

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