npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xpyjs/watermark

v1.0.11

Published

A rich configuration, easy to use watermark plugin.

Downloads

10

Readme

X-Watermark

X-Watermark 是一款易用的 JavaScript X-Watermark ,通过简单的配置,就可以在网页的任何位置添加水印效果。

特性

  • 任意位置:可以挂载到任意 DOM 节点上,以便在任意位置显示水印
  • 动态计算宽度和高度:水印可以根据内容长度和容器宽度进行自适应调整,确保水印始终显示完整。
  • 自动换行:当水印内容超过容器宽度时,水印会自动进行换行,以便适应容器的大小。
  • 动态监听:X-Watermark 会监听 DOM 变化,还可以指定某个 DOM,以便发生变化时自动更新水印。
  • 防止删除:X-Watermark 会监听自身变化,如果发现水印被删除,会自动重新添加水印。
  • 多种样式选择:水印支持多种样式,包括平铺、横向、纵向以及错位铺等多种形式,满足不同需求。
  • 高度可定制化:水印的样式、颜色、透明度等都可以根据需求进行定制,以满足不同场景的需求。
  • 支持 TypeScript:X-Watermark 提供了完整的类型定义,可以在 TypeScript 项目中直接使用。

快速开始

CDN

<script src="https://unpkg.com/@xpyjs/watermark"></script>

// or
<script src="https://cdn.jsdelivr.net/npm/@xpyjs/watermark"></script>

默认初始化:

const watermark = new XWatermark.XWatermark('Watermark Text', {
  parentSelector: '#container' // 优先级高于 parentNode
});

// or
const watermark = new XWatermark.XWatermark('Watermark Text', {
  parentNode: document.getElementById('container')
});

也可以通过 init 方法手动初始化:

const watermark = new XWatermark.XWatermark();

watermark.init('Watermark Text', {
  parentSelector: '#container' // 优先级高于 parentNode
});

// or
watermark.init('Watermark Text', {
  parentNode: document.getElementById('container')
});

安装

使用 npm 安装X-Watermark

npm install @xpyjs/watermark --save

引入

在你的 JavaScript 文件中引入 X-Watermark

import XWatermark from '@xpyjs/watermark';

使用

创建一个水印实例,并将其应用于指定的 DOM 元素:

const watermark = new XWatermark();

watermark.init('Watermark Text', {
  parentSelector: '#container' // 优先级高于 parentNode
});

// or
watermark.init('Watermark Text', {
  parentNode: document.getElementById('container')
});

以上代码将在 id 为 container 的 DOM 元素中应用一个平铺样式的水印,水印内容为 "Watermark Text"。

高级

X-Watermark 可以提供自动监听,包括大小变化时重载和内容修改时重载。

const watermark = new XWatermark();

watermark.init('Watermark Text', {
  parentSelector: '#container',
  prevent: true,  // 防止被删除
  observer: true  // 监听大小变化
});

有些时候,我们应用在了某个 DOM 元素上,比如表格上。当表格内容频繁变化时,水印的监听会导致性能问题。这时,可以使用停起事件来手动控制:

const watermark = new XWatermark({...});

// 停止监听
watermark.stop();

// 1秒后重新监听
setTimeout(() => {
  watermark.start();
}, 1000);

配置选项

X-Watermark 提供了丰富的配置选项,以便根据需求进行定制。

请参阅完整类型以获取所有配置选项的详细说明。

贡献

如果你发现了任何问题或有任何改进意见,请随时提出 issue 或发送 pull request。我们欢迎并感谢你的贡献。

许可证

X-Watermark 基于 MIT 许可证进行分发。请参阅许可证文件以获取更多信息。