# scale-controller
**Repository Path**: lincq_cn/scale-controller
## Basic Information
- **Project Name**: scale-controller
- **Description**: `scaleController` 是一个简单的 JavaScript 库,用于为网页元素添加触摸缩放功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-13
- **Last Updated**: 2024-12-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# scale-controller 调用文档
`scale-controller` 是一个简单的 JavaScript 库,用于为H5网页元素添加触摸缩放功能。以下是如何在你的项目中使用这个库的详细说明。
## 安装
使用以下命令安装库:
```bash
npm i scale-controller
```
或者使用 yarn:
```bash
yarn add scale-controller
```
## 引入
在你的 JavaScript 文件中,引入 `scale-controller`:
```javascript
import { enablePinchZoom, cancelPinchZoom, generateUniqueId } from 'scale-controller';
// 或者
import scaleControl from 'scale-controller';
```
## API
`scale-controller` 暴露了以下 API:
### enablePinchZoom(params)
启用元素的触摸缩放功能。
#### 参数
- `params` (Object): 配置参数对象,包含以下属性:
- `element` (String | HTMLElement): 需要添加缩放功能的 DOM 节点。
- `minScale` (Float): 最小缩放值,默认为 `0.5`。
- `maxScale` (Float): 最大缩放值,默认为 `3`。
- `button` (Boolean): 是否显示还原按钮,默认为 `true`。
- `rotate` (Number): 还原按钮旋转角度,默认为 `0`。
- `rebound` (Boolean): 是否在缩放小于 1 时自动反弹回原大小,默认为 `false`。
- `transition` (Number): 缩放动画过渡时间(毫秒),默认为 `600`。
#### 示例
```javascript
scaleControl.enablePinchZoom({
element: document.getElementById('myElement'),
minScale: 0.5,
maxScale: 5,
button: true,
rotate: 45,
rebound: true,
transition: 300,
});
```
### cancelPinchZoom(element)
取消元素的触摸缩放功能。
#### 参数
- `element` (String | HTMLElement): 需要取消缩放功能的 DOM 节点。
#### 示例
```javascript
scaleControl.cancelPinchZoom(document.getElementById('myElement'));
```
### generateUniqueId()
生成一个唯一的 ID。
#### 返回值
- (String): 唯一的 ID。
#### 示例
```javascript
const uniqueId = scaleControl.generateUniqueId();
console.log(uniqueId); // 输出类似 "1n5s0o0km9h0000" 的唯一字符串
```
要在网页中直接通过 `
```
### 3. 在 HTML 中引入库
在你的 HTML 文件中,使用 `