# @univerjs/docs-hyper-link

[![npm version](https://img.shields.io/npm/v/@univerjs/docs-hyper-link?style=flat-square)](https://npmjs.com/package/@univerjs/docs-hyper-link)
[![license](https://img.shields.io/npm/l/@univerjs/docs-hyper-link?style=flat-square)](https://npmjs.com/package/@univerjs/docs-hyper-link)
[![downloads](https://img.shields.io/npm/dm/@univerjs/docs-hyper-link?style=flat-square)](https://npmjs.com/package/@univerjs/docs-hyper-link)

`@univerjs/docs-hyper-link` provides the core hyperlink model and commands for Univer Docs.

## Package Overview

| Package | UMD global | CSS | Locales | Facade entry |
| --- | --- | :---: | :---: | :---: |
| `@univerjs/docs-hyper-link` | `UniverDocsHyperLink` | No | No | No |

## Installation

```sh
pnpm add @univerjs/docs-hyper-link
# or
npm install @univerjs/docs-hyper-link
```

Keep all `@univerjs/*` packages on the same version.

## Usage

```ts
import { UniverDocsHyperLinkPlugin } from '@univerjs/docs-hyper-link';

univer.registerPlugin(UniverDocsHyperLinkPlugin);
```

## Integration Notes

Use this package with `@univerjs/docs-hyper-link-ui` when users need hyperlink editing UI.

## Resources

- [Documentation](https://docs.univer.ai)
- [NPM package](https://npmjs.com/package/@univerjs/docs-hyper-link)
- [GitHub repository](https://github.com/dream-num/univer)