mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-26 01:42:30 +08:00
570c1be492
* site: add component version to meta * Update .dumi/theme/builtins/ComponentMeta/index.tsx Signed-off-by: afc163 <afc163@gmail.com> --------- Signed-off-by: afc163 <afc163@gmail.com> Co-authored-by: afc163 <afc163@gmail.com>
80 lines
3.2 KiB
Markdown
80 lines
3.2 KiB
Markdown
---
|
||
category: Components
|
||
group: Feedback
|
||
title: Watermark
|
||
description: Add specific text or patterns to the page.
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*wr1ISY50SyYAAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*duAQQbjHlHQAAAAAAAAAAAAADrJ8AQ/original
|
||
demo:
|
||
cols: 1
|
||
tag: 5.1.0
|
||
---
|
||
|
||
## When To Use
|
||
|
||
- Use when the page needs to be watermarked to identify the copyright.
|
||
- Suitable for preventing information theft.
|
||
|
||
## Examples
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">Basic</code>
|
||
<code src="./demo/multi-line.tsx">Multi-line watermark</code>
|
||
<code src="./demo/image.tsx">Image watermark</code>
|
||
<code src="./demo/custom.tsx">Custom configuration</code>
|
||
<code src="./demo/portal.tsx">Modal or Drawer</code>
|
||
|
||
## API
|
||
|
||
Common props ref：[Common props](/docs/react/common-props)
|
||
|
||
> This component is available since `antd@5.1.0`.
|
||
|
||
### Watermark
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| width | The width of the watermark, the default value of `content` is its own width | number | 120 | |
|
||
| height | The height of the watermark, the default value of `content` is its own height | number | 64 | |
|
||
| inherit | Pass the watermark to the pop-up component such as Modal, Drawer | boolean | true | 5.11.0 |
|
||
| rotate | When the watermark is drawn, the rotation Angle, unit `°` | number | -22 | |
|
||
| zIndex | The z-index of the appended watermark element | number | 9 | |
|
||
| image | Image source, it is recommended to export 2x or 3x image, high priority (support base64 format) | string | - | |
|
||
| content | Watermark text content | string \| string[] | - | |
|
||
| font | Text style | [Font](#font) | [Font](#font) | |
|
||
| gap | The spacing between watermarks | \[number, number\] | \[100, 100\] | |
|
||
| offset | The offset of the watermark from the upper left corner of the container. The default is `gap/2` | \[number, number\] | \[gap\[0\]/2, gap\[1\]/2\] | |
|
||
|
||
### Font
|
||
|
||
<!-- prettier-ignore -->
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| color | font color | [CanvasFillStrokeStyles.fillStyle](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/fillStyle) | rgba(0,0,0,.15) | |
|
||
| fontSize | font size | number | 16 | |
|
||
| fontWeight | font weight | `normal` \| `light` \| `weight` \| number | normal | |
|
||
| fontFamily | font family | string | sans-serif | |
|
||
| fontStyle | font style | `none` \| `normal` \| `italic` \| `oblique` | normal | |
|
||
| textAlign | specify the text alignment direction | [CanvasTextAlign](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/textAlign) | `center` | 5.10.0 |
|
||
|
||
## Design Token
|
||
|
||
<ComponentTokenTable component="Watermark"></ComponentTokenTable>
|
||
|
||
## FAQ
|
||
|
||
### Handle abnormal image watermarks
|
||
|
||
When using an image watermark and the image loads abnormally, you can add `content` at the same time to prevent the watermark from becoming invalid (since 5.2.3).
|
||
|
||
```typescript jsx
|
||
<Watermark
|
||
height={30}
|
||
width={130}
|
||
content="Ant Design"
|
||
image="https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*lkAoRbywo0oAAAAAAAAAAAAADrJ8AQ/original"
|
||
>
|
||
<div style={{ height: 500 }} />
|
||
</Watermark>
|
||
```
|