acud/es/watermark/useWatermark.d.ts

acg react 组件库

import * as React from 'react';
/**
 * Base size of the canvas, 1 for parallel layout and 2 for alternate layout
 * Only alternate layout is currently supported
 */
export declare const BaseSize = 2;
export declare const FontGap = 3;
export type AppendWatermark = (base64Url: string, markWidth: number, container: HTMLElement) => void;
/**
 * 获取水印组件的钩子函数，用于在组件中添加或移除水印。
 *
 * @param markStyle 给水印元素设置的样式。
 * @returns 返回一个包含三个函数的数组：appendWatermark、removeWatermark和isWatermarkEle。
 * - appendWatermark 函数用于在指定容器中添加水印元素。参数为 base64Url（水印图片的 base64 编码字符串），markWidth（水印宽度）和 container（容器）。
 * - removeWatermark 函数用于从指定容器中删除水印元素。参数为 container（容器）。
 * - isWatermarkEle 函数用于判断某个节点是否为水印元素，并返回布尔值。参数为 ele（节点）。
 */
export default function useWatermark(markStyle: React.CSSProperties): [
    appendWatermark: AppendWatermark,
    removeWatermark: (container: HTMLElement) => void,
    isWatermarkEle: (ele: Node) => boolean
];