Skip to content

快速开始

在线尝试

Demo

npm 使用

bash
npm install avatar-clipper
# pnpm add avatar-clipper
# yarn add avatar-clipper
js
import { AvatarClipper } from "avatar-clipper";

const clipper = new AvatarClipper({ container: "#app" });

温馨提示

容器自身不设置宽高,请在挂载节点自行设置。

css
.avatar-clipper-container {
	position: relative;
	overflow: hidden;
	box-sizing: border-box;
	margin: 0;
	padding: 0;
}

浏览器使用

html
<!-- 使用 ES Module 实现 avatar-clipper 的引入 -->
<script type="module">
	import AvatarClipper from "https://unpkg.com/avatar-clipper";
	const clipper = new AvatarClipper({
		container: "#app",
	});
</script>

源码构建

bash
## 克隆仓库
git clone https://gitee.com/wfeng0/avatar-clipper
# git clone https://github.com/pushu-wf/avatar-clipper

## 下载依赖
npm install # or pnpm i

## 启动项目
npm run dev # or pnpm dev

温馨提示

Node.js(^18.18.0、^20.9.0 或 >=21.1.0)

项目使用了 Eslint 语法检查工具,因此对 node 的最低版本是有要求的哈~