# 超链接

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/features/hyper-link](https://docs.univer.ai/zh-CN/guides/docs/features/hyper-link)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/features/hyper-link.md](https://docs.univer.ai/zh-CN/guides/docs/features/hyper-link.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/hyper-link.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/hyper-link.zh-CN.mdx)

---

#### Package metadata

```json
{
  "preset": [
    {
      "client": "@univerjs/preset-docs-hyper-link",
      "locale": "@univerjs/preset-docs-hyper-link/locales/zh-CN",
      "style": "@univerjs/preset-docs-hyper-link/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs/docs-hyper-link"
    },
    {
      "client": "@univerjs/docs-hyper-link-ui",
      "locale": "@univerjs/docs-hyper-link-ui/locale/zh-CN",
      "style": "@univerjs/docs-hyper-link-ui/lib/index.css"
    }
  ],
  "server": false
}
```

超链接用于实现文档外部网页、电子邮件地址等内容的快速跳转与访问。

## 预设模式

### 安装

#### npm

```bash
npm install @univerjs/preset-docs-hyper-link
```

#### pnpm

```bash
pnpm add @univerjs/preset-docs-hyper-link
```

#### yarn

```bash
yarn add @univerjs/preset-docs-hyper-link
```

#### bun

```bash
bun add @univerjs/preset-docs-hyper-link
```

### 使用

```typescript
import { UniverDocsCorePreset } from '@univerjs/preset-docs-core'
import UniverPresetDocsCoreZhCN from '@univerjs/preset-docs-core/locales/zh-CN'
import { UniverDocsHyperLinkPreset } from '@univerjs/preset-docs-hyper-link' // [!code ++]
import UniverPresetDocsHyperLinkZhCN from '@univerjs/preset-docs-hyper-link/locales/zh-CN' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

import '@univerjs/preset-docs-core/lib/index.css'
import '@univerjs/preset-docs-hyper-link/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniverPresetDocsCoreZhCN,
      UniverPresetDocsHyperLinkZhCN, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
    UniverDocsHyperLinkPreset(), // [!code ++]
  ],
})
```

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs/docs-hyper-link @univerjs/docs-hyper-link-ui
```

#### pnpm

```bash
pnpm add @univerjs/docs-hyper-link @univerjs/docs-hyper-link-ui
```

#### yarn

```bash
yarn add @univerjs/docs-hyper-link @univerjs/docs-hyper-link-ui
```

#### bun

```bash
bun add @univerjs/docs-hyper-link @univerjs/docs-hyper-link-ui
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverDocsHyperLinkPlugin } from '@univerjs/docs-hyper-link' // [!code ++]
import { UniverDocsHyperLinkUIPlugin } from '@univerjs/docs-hyper-link-ui' // [!code ++]
import DocsHyperLinkUIZhCN from '@univerjs/docs-hyper-link-ui/locale/zh-CN' // [!code ++]

import '@univerjs/docs-hyper-link-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DocsHyperLinkUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsHyperLinkPlugin) // [!code ++]
univer.registerPlugin(UniverDocsHyperLinkUIPlugin) // [!code ++]
```

## 使用 Facade API 创建和编辑链接

`link(text, url)` 会追加链接文本并记录对应范围，无需手动计算字符位置。后续修改链接地址时，使用 `getLinks()` 返回的范围 ID。

```ts
const richText = univerAPI
  .newRichText()
  .text('Read ')
  .link('Univer Office SDK documentation', 'https://docs.univer.ai')
  .text(' for details.')

const [link] = richText.getLinks()
if (!link) throw new Error('Link was not created')

richText.updateLink(link.rangeId, 'https://docs.univer.ai/guides')
```

调用 `removeLink(link.rangeId)` 可移除链接地址，同时保留可见文本。