gwm.js

Generate Watermark

It can be used to generate watermarking in internal system, which can prompt information security and responsibility tracking. Safety issues can not be ignored, which has a certain role in prompting the sensitive operation of internal personnel.

Characteristic

• Support the generation of three types of watermarking: canvas, SVG and element
• Supporting element monitoring to prevent tampering
• Extensibility

Example

Click here to see the effect →：Demo

Instructions

1、Introducing JS files

<script src="../js/gwm.js"></script>

Or install with NPM

npm install gwm

2、Building watermark

gwm.creation()

Parameter

Custom Font Example

To use a custom font, you can specify the desired font through the font parameter when creating the watermark. For example, to change the font to Arial, you can do it like this:

gwm.creation({
  font: 'Arial'
})

Method

| Method | Explain | | :-------- | :---- | | gwm.creation | Create a watermarking. | | gwm.observing | Manually open the observer, when the watermarking element is tampered with, re-render the watermarking element. | | gwm.cancel | Cancel the observer, the watermark can be hidden or deleted. |

Development Guide

Requirements

• Node.js >= 20.0.0
• npm >= 9.0.0

Installation

# Clone the repository
git clone https://github.com/loadchange/gwm.git
cd gwm

# Install dependencies
npm install

Development

# Start development server with hot reload
npm run dev

Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch

Building

# Build for production (includes type declarations)
npm run build

构建将使用 Vite 完成，产物和类型声明均输出到 dist 目录。

Documentation

# Generate documentation
npm run deploy-docs

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details.