# mask.js

**Repository Path**: athelas/mask.js

## Basic Information

- **Project Name**: mask.js
- **Description**: 简单易用的遮罩层
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-18
- **Last Updated**: 2021-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 引入JS
	<script type="text/javascript" src="mask.js></script>

### 开启遮罩层（手动）
	mask.show(
		{
			id: '#mask',
			type: 'manual',
			text: '执行中，请稍候...'
		}
	);

### 开启遮罩层（自动）
	mask.show(
		{
			id: '#mask',
			type: 'auto',
			countdown: 3000,
			text: '执行中，请稍候...'
		}
	);

### 开启遮罩层（自定义样式）
	mask.show(
		{
			id: '#mask',
			type: 'manual',
			text: '执行中，请稍候...',
			css: {
				'text-shadow': '1px 1px 2px #f00',
				'color': '#00f'
			}
		}
	);

### 关闭遮罩层
	mask.hide(
		{
			id: '#mask'
		}
	);

### 参数说明
| 参数名 | 类型 | 必填 | 作用 |
| --- | --- | --- | --- |
| id | String | 是 | 遮罩层ID，必须以#开头，且不能是已经存在的HTML DOM。开启遮罩层时将自动创建。 |
| type | String | 是 | 遮罩层类型。 manual：手动关闭； &nbsp;&nbsp; auto：自动关闭 |
| countdown | Int | 否 | 自动关闭倒计时（毫秒），必须为大于0的整数，仅当type=auto时有效 **且为必填**。 |
| text | String | 是 | 要显示的提示文字 |
| css | Object | 否 | 用户自定义样式 。优先级较高，可覆盖默认样式。 <br /> **注：width、height等影响遮罩层作用的样式无法被覆盖。** |