# tf-react-sidebar

> sidebar组件

Latest version **0.1.0** (published 2018-12-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install tf-react-sidebar
pnpm add tf-react-sidebar
yarn add tf-react-sidebar
bun add tf-react-sidebar
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-12-17 |
| First published | 2018-12-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 41.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tffed |

## Links

- npm: https://www.npmjs.com/package/tf-react-sidebar
- npm.io page: https://npm.io/package/tf-react-sidebar

## Recent versions

- 0.1.0 (latest) — 2018-12-17

## README

## sidebar组件

> 本组件基于npm构建, react版本

### 安装

```
npm i tf-react-sidebar
```

### 引入

```javascript
import Sidebar from 'tf-react-sidebar'
import 'tf-react-sidebar/dist/index.css'
```

### 使用

```javascript
<Sidebar
  placement= 'bottom' // top, bottom, left, right 4个方向, 内容从哪个方向滑出
  isClickMaskClose={true} // 点击遮罩是否隐藏(关闭)
  hasMask={true} // 是否有遮罩
  onVisibleChange={ (tag) => {} } // 可见性调用
  overlayClassName='' // 设置类名
  overlayStyle={{color: 'red'}} // 样式
  content='' // 内容, 可以是字符串或者一个react组件
  visible={false}
>
<div>点我触发......</div>
</Sidebar>
```


### 更新日志

```
0.1.0
  版本发布
```

---
_Source: https://npm.io/package/tf-react-sidebar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._