# 水印

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

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

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs/watermark",
      "facade": "@univerjs/watermark/facade"
    }
  ],
  "server": false
}
```

水印功能旨在为网页或应用提供灵活且安全的水印方案。通过该功能，开发者可以在页面上动态生成文本或图片水印，以防止内容未经授权的使用或传播。并支持多种配置。

> Interactive example: [Open the playground](/playground/docs/watermark)

## 预设模式

水印并未提供预设模式，但支持与其插件混用。

### 安装

#### npm

```bash
npm install @univerjs/watermark
```

#### pnpm

```bash
pnpm add @univerjs/watermark
```

#### yarn

```bash
yarn add @univerjs/watermark
```

#### bun

```bash
bun add @univerjs/watermark
```

### 使用

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const { univerAPI } = createUniver({
  // ...
  presets: [
    UniverDocsCorePreset(),
  ],
  plugins: [
    [UniverWatermarkPlugin, { // [!code ++]
      textWatermarkSettings: { // [!code ++]
        content: 'Hello, Univer!', // [!code ++]
        fontSize: 36, // [!code ++]
      }, // [!code ++]
    }], // [!code ++]
  ],
})
```

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs/watermark
```

#### pnpm

```bash
pnpm add @univerjs/watermark
```

#### yarn

```bash
yarn add @univerjs/watermark
```

#### bun

```bash
bun add @univerjs/watermark
```

### 使用

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const univer = new Univer({
  // ...
})

univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]
  textWatermarkSettings: { // [!code ++]
    content: 'Hello, Univer!', // [!code ++]
    fontSize: 36, // [!code ++]
  }, // [!code ++]
}) // [!code ++]
```

### 插件与配置

#### @univerjs/watermark

本插件提供了水印功能的核心实现。它允许开发者在应用中添加文本或图片水印，并提供多种配置选项来定制水印的外观和行为。其提供了 `UniverWatermarkPlugin` 插件。

参考：[@univerjs/watermark](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs/watermark.md)

## Facade API

### 引入

> [!INFO: 插件模式提示]
> 仅插件模式需要手动引入 Facade 包。预设模式已内置对应的 Facade 包，无需额外导入。

```typescript
import '@univerjs/watermark/facade'
```

### 设置水印

```typescript
univerAPI.addWatermark('text', { content: 'hello', repeat: true })
```

### 移除水印

```typescript
univerAPI.deleteWatermark()
```