Back to Element Plus

Link

docs/en-US/component/link.md

2.13.73.1 KB
Original Source

Link

Text hyperlink

:::warning Security Warning The href prop will be rendered directly to an <a> tag. If you pass a value such as javascript:alert(1) or a malicious URL, it may cause XSS or open redirect vulnerabilities.

Always validate and sanitize the URL before use. For example:

<details> <summary>Show code example</summary>
js
function sanitizeUrl(url) {
  const allowedProtocols = ['http:', 'https:']
  try {
    const parsed = new URL(url, window.location.origin)
    return allowedProtocols.includes(parsed.protocol) ? parsed.href : '#'
  } catch {
    return '#'
  }
}
</details>

:::

Basic

Basic text link

:::demo

link/basic

:::

Disabled

Disabled state of link

:::demo

link/disabled

:::

Underline

Controlling when underlines should appear

:::warning

The boolean value has been deprecated, and will be removed in ^(3.0.0) , consider switching to new values.

:::

:::tip

Starting from ^(2.9.9) , you can use 'always' | 'hover' | 'never' to control when underlines should appear. The examples in the document all use these values. If you are using a version less than ^(2.9.9) , please refer to:

:::

vue
<template>
  <!-- works before 2.9.9, use 'hover' after, removed in 3.0.0 -->
  <el-link underline>link</el-link>
  <!-- works before 2.9.9, use 'never' after, removed in 3.0.0 -->
  <el-link :underline="false">link</el-link>
</template>

:::demo

link/underline

:::

Icon

Link with icon

:::tip

Use the icon attribute to add icon. You can pass either string for the component name (registered in advance) or the component itself which is a SVG Vue component. Element Plus has provided a set of icon that you can find at icon

:::

:::demo

link/with-icon

:::

API

Attributes

NameDescriptionTypeDefault
typetype^[enum]'primary' | 'success' | 'warning' | 'danger' | 'info' | 'default'default
underlinewhen underlines should appear^[enum]'always' | 'hover' | 'never' | booleanhover
disabledwhether the component is disabled^[boolean]false
hrefsame as native hyperlink's href^[string]
targetsame as native hyperlink's target^[enum]'_blank' | '_parent' | '_self' | '_top'_self
iconicon component^[string] / ^[Component]

Slots

NameDescription
defaultcustomize default content
iconcustomize icon component