Watermark
Add specific text or patterns to the page.
When To Use
- Use when the page needs to be watermarked to identify the copyright.
- Suitable for preventing information theft.
Examples
- Basic ·
basic - Multi-line watermark ·
multi-line - Image watermark ·
image - Custom configuration ·
custom - Modal or Drawer ·
portal
API
Common props ref：Common props
This component is available since
antd@5.1.0.
Watermark
| Property | Description | Type | Default | Version | Global Config |
|---|---|---|---|---|---|
| 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 | 999 | × | |
| image | Image source, it is recommended to export 2x or 3x image, high priority (support base64 format) | string | - | × | |
| content | Watermark text content | string | WatermarkText | (string | WatermarkText)[] | - | WatermarkText: 6.5.0 | × |
| font | Text style | 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] | × | |
| onRemove | Callback when the watermark is removed by DOM mutation | () => void | - | 6.0.0 | × |
WatermarkText
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| font | Custom line text style | Font | - | 6.5.0 |
| text | Line text | string | - | 6.5.0 |
Font
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| color | font color | CanvasFillStrokeStyles.fillStyle | rgba(0,0,0,.15) | |
| fontSize | font size | number | 16 | |
| fontWeight | font weight | normal | lighter | bold | bolder | number | normal | |
| fontFamily | font family | string | sans-serif | |
| fontStyle | font style | none | normal | italic | oblique | normal | |
| textAlign | specify the text alignment direction | CanvasTextAlign | center | 5.10.0 |
Design Token
The pinned source has no separate ComponentToken declaration for this component. Styling follows native global tokens or the composed component's tokens; additional fields and defaults are not inferred.
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).
<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>
Why overflow: hidden style is added since version 5.18.0?
User can hide the watermark by setting the container height to 0 through the developer tool in the previous version. To avoid this situation, we added the overflow: hidden style to the container. When the container height changes, the content is also hidden. You can override the style to modify this behavior:
<Watermark style={{ overflow: 'visible' }} />
Shared native props
Tips: The following generic properties apply to most antd components; those not supported are described separately.
| Property | Description | Type | Default |
|---|---|---|---|
| style | The additional style | CSSProperties | - |
| className | The additional css class | string | - |
| rootClassName | ClassName on the root element | string | - |
| autoFocus | Auto focus when component mounted, only effective for focusable elements like forms, links, etc. | boolean | false |
Install and reproduce an example
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23
Use ConfigProvider and native App; configure dayjs locale separately. Each example lists its complete source files and additional pinned dependencies in View code. Example names select demos, not universal component props. See the resource setup guide for theme, locale and SSR.
Native type references
The source viewer includes unchanged native implementations and the following source declarations. Inherited types remain in their native packages. English source comments are preserved as code reference.
vendor/components/watermark/context.tsvendor/components/watermark/index.tsxvendor/components/watermark/useSingletonCache.tsvendor/components/watermark/useWatermark.tsvendor/components/watermark/utils.ts
Source and license
https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd
Original bilingual prose and executable examples are retained. Website-only embeds and token tables are expanded locally. Ant Design is MIT; separately listed dependency notices also apply. Upload previews block outbound requests and do not provide a backend.