@justeattakeaway/pie-link NPM

@justeattakeaway/pie-link

Source Code | Design Documentation | NPM

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

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
`size`	`"small"`, `"medium"`	Sets the size of the link.	`"medium"`
`variant`	`"default"`, `"high-visibility"`, `"inverse"`	Sets the variant of the link.	`"default"`
`tag`	`"a"`, `"button"`	Which HTML tag to use for the link.	`"a"`
`href`	—	The `href` attribute to apply.Cannot be used if `tag` is set to `"button"`.	`undefined`
`target`	—	The `target` attribute to apply.Cannot be used if `tag` is set to `"button"`.	`undefined`
`rel`	—	The `rel` attribute to apply.Cannot be used if `tag` is set to `"button"`.	`undefined`
`type`	`"button"`, `"reset"`, `"submit"`	The `type` attribute to apply when `tag` is set to `"button"`.	`"submit"`
`underline`	`"default"`, `"reversed"`	The underline behaviour of the link. The default behaviour has the link text underlined, with the underline disappearing on hover. `"reversed"` will only take effect if `isStandalone` is set to `true`.	`"default"`
`isBold`	`true`, `false`	If true, makes the link text bold.	`false`
`isStandalone`	`true`, `false`	If true, sets the link as a block element.	`false`
`hasVisited`	`true`, `false`	If true, the link will apply the styles for the visited state. Only takes effect if `tag` is `"a"`.	`false`
`iconPlacement`	`"leading"`, `"trailing"`	Sets the position of the icon relative to the text. Leading comes before the text and trailing comes after, taking writing direction into account. To use this, you must pass an icon into the icon slot. Will have no effect if `isStandalone` is false.	`undefined`
`aria`	`{ label?: string }`	Aria properties for the link to help with making it accessible.	`undefined`

Slots

Slot	Description
`default`	The default slot is used to pass text into the link component.
`icon`	Used to pass in an icon to the link component. The icon placement can be controlled via the `iconPlacement` prop and we recommend using `pie-icons-webc` for defining this icon. Please note the icon size is hardcoded and cannot be overridden.

CSS Variables

This component does not expose any CSS variables for style overrides.

Events

This component does not emit any custom events. In order to add event listening to this component, you can treat it like a native HTML element in your application.

Usage Examples

When using icons, we recommend using @justeattakeaway/pie-icons-webc to ensure consistency with the rest of the design system.

For HTML:

// import as module into a js file e.g. main.js
import '@justeattakeaway/pie-webc/components/link.js'
import '@justeattakeaway/pie-icons-webc/dist/IconPlaceholder.js';

<!-- pass js file into <script> tag -->
<pie-link href="https://www.pie.design">
  <icon-placeholder slot="icon"></icon-placeholder>
  pie.design
</pie-link>
<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/link.js';
import '@justeattakeaway/pie-icons-webc/dist/IconPlaceholder.js';

<pie-link href="https://www.pie.design">
  <icon-placeholder slot="icon"></icon-placeholder>
  pie.design
</pie-link>

For React Applications:

import { PieLink } from '@justeattakeaway/pie-webc/react/link.js';
import { IconPlaceholder } from '@justeattakeaway/pie-icons-webc/dist/react/IconPlaceholder.js';

<PieLink href="https://www.pie.design">
  <IconPlaceholder slot="icon" />
  pie.design
</PieLink>