# 超連結

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

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

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

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

---

#### Package metadata

```json
{
  "mobile": true,
  "preset": [
    {
      "client": "@univerjs/preset-docs-hyper-link",
      "locale": "@univerjs/preset-docs-hyper-link/locales/zh-TW",
      "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-TW",
      "style": "@univerjs/docs-hyper-link-ui/lib/index.css"
    }
  ],
  "server": false
}
```

超連結用於實現文件外部網頁、電子郵件地址等內容的快速跳轉與訪問。

## 外掛模式

### 安裝

#### 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 DocsHyperLinkUIZhTW from '@univerjs/docs-hyper-link-ui/locale/zh-TW' // [!code ++]

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

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

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

## 行動裝置支援

先設定[行動版編輯器](https://docs.univer.ai/zh-TW/guides/docs/getting-started/installation.md#mobile-support)。在本頁外掛模式的初始化程式碼中，將下列桌面版註冊替換為同一套件匯出的行動版外掛，並在**開啟文件前**完成。保留模型外掛、樣式、語言套件與 Facade 匯入，請勿同時註冊兩個版本。

| 套件                             | 桌面版註冊                         | 行動版註冊                               |
| ------------------------------ | ----------------------------- | ----------------------------------- |
| `@univerjs/docs-hyper-link-ui` | `UniverDocsHyperLinkUIPlugin` | `UniverDocsHyperLinkMobileUIPlugin` |

## 預設模式

### 安裝

#### 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 UniverPresetDocsCoreZhTW from '@univerjs/preset-docs-core/locales/zh-TW'
import { UniverDocsHyperLinkPreset } from '@univerjs/preset-docs-hyper-link' // [!code ++]
import UniverPresetDocsHyperLinkZhTW from '@univerjs/preset-docs-hyper-link/locales/zh-TW' // [!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_TW,
  locales: {
    [LocaleType.ZH_TW]: mergeLocales(
      UniverPresetDocsCoreZhTW,
      UniverPresetDocsHyperLinkZhTW, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
    UniverDocsHyperLinkPreset(), // [!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)` 可移除連結網址，同時保留顯示文字。