@polarityio/pi-external-link
v1.0.4
Published
External link component that opens in a new tab with icon and tooltip
Readme
Polarity Integration Component Library
External Link Component
A styled link that opens in a new tab with an external link icon and customizable hover tooltip.
Installation
npm install @polarityio/pi-external-linkPeer Dependencies
- lit ^3.0.0
Usage
import '@polarityio/pi-external-link';<!-- Basic link (displays the URL as text) -->
<pi-external-link href="https://example.com"></pi-external-link>
<!-- Link with custom display text -->
<pi-external-link href="https://example.com" text="Visit Example"></pi-external-link>
<!-- Link without icon -->
<pi-external-link href="https://example.com" text="Example" no-icon></pi-external-link>
<!-- Link with custom tooltip -->
<pi-external-link href="https://example.com" text="Example" tooltip-text="Opens in a new tab"></pi-external-link>
<!-- Link without tooltip -->
<pi-external-link href="https://example.com" text="Example" no-tooltip></pi-external-link>API Reference
Properties
| Property | Type | Default | Description |
| ------------- | --------- | ------- | --------------------------------------------------------------- |
| href | string | '' | The destination URL. Component renders nothing when empty. |
| text | string | '' | Display text for the link. Falls back to href if empty. |
| noIcon | boolean | false | Hides the external-link icon when true |
| tooltipText | string | '' | Custom tooltip text. Defaults to showing the href when empty. |
| noTooltip | boolean | false | Hides the tooltip entirely when true |
Slots
| Slot Name | Description |
| --------- | ---------------------------------------------------------------------------------- |
| tooltip | Custom tooltip content. Overrides both tooltipText and the default href tooltip. |
CSS Custom Properties
| Property | Default | Description |
| ------------------------------- | -------------- | ------------------------------- |
| --pi-external-link-icon-size | 0.85em | Size of the external-link icon |
| --pi-external-link-icon-color | currentColor | Color of the external-link icon |
Theming
Customize the appearance using CSS custom properties. This component uses design tokens from @polarityio/pi-shared for consistent theming across the component library.
License
MIT
