zent/loading/README.md

一套前端设计语言和基于React的实现

# zent-loading

[![npm version](https://img.shields.io/npm/v/zent-loading.svg?style=flat)](https://www.npmjs.com/package/zent-loading) [![downloads](https://img.shields.io/npm/dt/zent-loading.svg)](https://www.npmjs.com/package/zent-loading)

加载状态组件

## 使用指南

#### 两种使用方式(**按需使用**)

-  API 调用

    调用 `on()` 方法和 `off()` 方法.

    使用 API 调用时, 也可以传入 props 用于初始化. e.g. `.on({prefix: 'cat'})`

-  普通组件调用

    提供 `show` 作为 props, 如果 `static` 为  `false`, 需要包一个目标组件, 以遮罩层形式存在; 如果 `static` 设置为 `true`, 将会出现在文档流中.

## API

| 参数             | 说明                                                     | 类型     | 默认值      |
| -------------- | ------------------------------------------------------ | ------ | -------- |
| className      | 自定义额外类名                                                | string | `''`     |
| containerClass | 自定义额外类名，外部包裹的容器使用                                      | string | `''`     |
| prefix         | 自定义前缀                                                  | string | `'zent'` |
| show           | 显示控制                                                   | bool   | `false`  |
| static         | 是否以标签形式存在于文档流中                                         | bool   | `true`   |
| height         | 设置 static 为 true 情况下，设置高度，如果包裹了组件，将会表现为组件高度，否则将会使用默认高度 | number | `160`    |
| zIndex         | 设置 z-index                                             | number | `9998`   |