logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
5.26.0
  • Components Overview
  • General
    • Button
    • FloatButton
      5.0.0
    • Icon
    • Typography
  • Layout
    • Divider
    • Flex
      5.10.0
    • Grid
    • Layout
    • Space
    • Splitter
      5.21.0
  • Navigation
    • Anchor
    • Breadcrumb
    • Dropdown
    • Menu
    • Pagination
    • Steps
    • Tabs
  • Data Entry
    • AutoComplete
    • Cascader
    • Checkbox
    • ColorPicker
      5.5.0
    • DatePicker
    • Form
    • Input
    • InputNumber
    • Mentions
    • Radio
    • Rate
    • Select
    • Slider
    • Switch
    • TimePicker
    • Transfer
    • TreeSelect
    • Upload
  • Data Display
    • Avatar
    • Badge
    • Calendar
    • Card
    • Carousel
    • Collapse
    • Descriptions
    • Empty
    • Image
    • List
    • Popover
    • QRCode
      5.1.0
    • Segmented
    • Statistic
    • Table
    • Tag
    • Timeline
    • Tooltip
    • Tour
      5.0.0
    • Tree
  • Feedback
    • Alert
    • Drawer
    • Message
    • Modal
    • Notification
    • Popconfirm
    • Progress
    • Result
    • Skeleton
    • Spin
    • Watermark
      5.1.0
  • Other
    • Affix
    • App
      5.1.0
    • ConfigProvider
    • Util
      5.13.0
When To Use
Examples
Basic
Multi-line watermark
Image watermark
Custom configuration
Modal or Drawer
API
Watermark
Font
Design Token
FAQ
Handle abnormal image watermarks
Why overflow: hidden style is added since version 5.18.0?

Watermark

Add specific text or patterns to the page.
Importimport { Watermark } from "antd";
Sourcecomponents/watermark
Docs
Edit this pageChangelog
Versionsupported since 5.1.0
contributors
  • SpinAffix

    Resources

    Ant Design X
    Ant Design Charts
    Ant Design Pro
    Pro Components
    Ant Design Mobile
    Ant Design Mini
    Ant Design Web3
    Ant Design Landing-Landing Templates
    Scaffolds-Scaffold Market
    Umi-React Application Framework
    dumi-Component doc generator
    qiankun-Micro-Frontends Framework
    Ant Motion-Motion Solution
    China Mirror 🇨🇳

    Community

    Awesome Ant Design
    Medium
    Twitter
    yuque logoAnt Design in YuQue
    Ant Design in Zhihu
    Experience Cloud Blog
    seeconf logoSEE Conf-Experience Tech Conference

    Help

    GitHub
    Change Log
    FAQ
    Bug Report
    Issues
    Discussions
    StackOverflow
    SegmentFault

    Ant XTech logoMore Products

    yuque logoYuQue-Document Collaboration Platform
    AntV logoAntV-Data Visualization
    Egg logoEgg-Enterprise Node.js Framework
    Kitchen logoKitchen-Sketch Toolkit
    Galacean logoGalacean-Interactive Graphics Solution
    xtech logoAnt Financial Experience Tech
    Theme Editor
    Made with ❤ by
    Ant Group and Ant Design Community

    When To Use

    • Use when the page needs to be watermarked to identify the copyright.
    • Suitable for preventing information theft.

    Examples

    API

    Common props ref:Common props

    This component is available since antd@5.1.0.

    Watermark

    PropertyDescriptionTypeDefaultVersion
    widthThe width of the watermark, the default value of content is its own widthnumber120
    heightThe height of the watermark, the default value of content is its own heightnumber64
    inheritPass the watermark to the pop-up component such as Modal, Drawerbooleantrue5.11.0
    rotateWhen the watermark is drawn, the rotation Angle, unit °number-22
    zIndexThe z-index of the appended watermark elementnumber9
    imageImage source, it is recommended to export 2x or 3x image, high priority (support base64 format)string-
    contentWatermark text contentstring | string[]-
    fontText styleFontFont
    gapThe spacing between watermarks[number, number][100, 100]
    offsetThe 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

    PropertyDescriptionTypeDefaultVersion
    colorfont colorCanvasFillStrokeStyles.fillStylergba(0,0,0,.15)
    fontSizefont sizenumber16
    fontWeightfont weightnormal | light | weight | numbernormal
    fontFamilyfont familystringsans-serif
    fontStylefont stylenone | normal | italic | obliquenormal
    textAlignspecify the text alignment directionCanvasTextAligncenter5.10.0

    Design Token

    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
    <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:

    tsx
    <Watermark style={{ overflow: 'visible' }} />
    Basic

    The most basic usage.

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    Multi-line watermark

    Use content to set a string array to specify multi-line text watermark content.

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    Image watermark

    Specify the image address via image. To ensure that the image is high definition and not stretched, set the width and height, and upload at least twice the width and height of the logo image address.

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    Custom configuration

    Preview the watermark effect by configuring custom parameters.

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    Modal or Drawer

    Use in Modal and Drawer.

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    The light-speed iteration of the digital world makes products more complex. However, human consciousness and attention resources are limited. Facing this design contradiction, the pursuit of natural interaction will be the consistent direction of Ant Design.
    Natural user cognition: According to cognitive psychology, about 80% of external information is obtained through visual channels. The most important visual elements in the interface design, including layout, colors, illustrations, icons, etc., should fully absorb the laws of nature, thereby reducing the user's cognitive cost and bringing authentic and smooth feelings. In some scenarios, opportunely adding other sensory channels such as hearing, touch can create a richer and more natural product experience.
    Natural user behavior: In the interaction with the system, the designer should fully understand the relationship between users, system roles, and task objectives, and also contextually organize system functions and services. At the same time, a series of methods such as behavior analysis, artificial intelligence and sensors could be applied to assist users to make effective decisions and reduce extra operations of users, to save users' mental and physical resources and make human-computer interaction more natural.
    img