@justeattakeaway/pie-checkbox

Table of Contents

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

pie-checkbox

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

# npm
$ npm i @justeattakeaway/pie-checkbox

# yarn
$ yarn add @justeattakeaway/pie-checkbox

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

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

React

// React
// For React, you will need to import our React-specific component build
// which wraps the web component using ​@lit/react
import { PieCheckbox } from '@justeattakeaway/pie-checkbox/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-checkbox, 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
-	-	-	-

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

<!-- Native HTML -->
<pie-checkbox></pie-checkbox>

<!-- JSX -->
<PieCheckbox></PieCheckbox>

Contributing

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