@justeattakeaway/pie-avatar

Source Code | Design Documentation | NPM

@justeattakeaway/pie-avatar is a Web Component built using the Lit library. It offers a simple and accessible button component for web applications.

Table of Contents

• Installation
• Documentation
  • Properties
  • Slots
  • CSS Variables
  • Events
• Usage Examples
• Questions and Support
• Contributing

Installation

To install any of our web components in your application, we would suggest following the getting started guide 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 | |------|---------|-------------|---------| | src | — | The src attribute for the underlying image tag. | "" | | tag | "button", "a", "div" | Which HTML element to use when rendering the avatar.| div | | label | - | User or company name that will be rendered as initials inside the avatar.| "" |

Slots

| Slot | Description | |----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | | |

CSS Variables

| Variable | Description | Default | |----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | | | |

Events

| Event | Type | Description | |------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| | | | |

Usage Examples

For HTML:

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

<!-- pass js file into <script> tag -->

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

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

// Vue templates (using Nuxt 3)
import '@justeattakeaway/pie-webc/components/avatar.js'

For React Applications:

import { PieAvatar } from '@justeattakeaway/pie-webc/react/avatar.js';

Questions and Support

If you work at Just Eat Takeaway.com, please contact us on #help-designsystem. Otherwise, please raise an issue on Github.

Contributing

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