# bee-affix

> Affix ui component for react

Latest version **1.0.20** (published 2021-04-30) · MIT license · 173 weekly downloads

## Install

```sh
npm install bee-affix
pnpm add bee-affix
yarn add bee-affix
bun add bee-affix
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.20 |
| Published | 2021-04-30 |
| First published | 2017-10-12 |
| Weekly downloads | 173 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 4 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | yonyou |
| Maintainers | wangjings123, diozhu, cnkvkens, yonyoufed, jonyw, guoyongfeng, kvkens, whizbz, npm_yx, bjyxszd, tinper-bot, houjitong, gaox2025f, gcht163, liushaozhen |
| Keywords | react, react-component, bee-affix, iuap-design, tinper-bee, Affix |

## Links

- npm: https://www.npmjs.com/package/bee-affix
- Repository: https://github.com/tinper-bee/bee-affix
- Issues: https://github.com/tinper-bee/bee-affix/issues
- npm.io page: https://npm.io/package/bee-affix

## Dependencies (4)

- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.23.0
- [lodash.isequal](https://npm.io/package/lodash.isequal.md) ^4.5.0
- [tinper-bee-core](https://npm.io/package/tinper-bee-core.md) latest

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.20 (latest) — 2021-04-30
- 1.0.17-alpha.0 (alpha) — 2019-09-23
- 1.0.19 — 2021-04-30
- 1.0.18 — 2020-04-24
- 1.0.17 — 2019-09-23
- 1.0.16 — 2019-09-11
- 1.0.16-alpha.0 — 2019-09-10
- 1.0.15 — 2019-03-14
- 1.0.14 — 2018-11-16
- 1.0.13 — 2018-10-18
- 1.0.12 — 2018-10-10
- 1.0.11 — 2018-10-10
- 1.0.10 — 2018-10-10
- 1.0.9 — 2018-09-27
- 1.0.8 — 2018-09-27
- … 8 more at https://npm.io/package/bee-affix/versions

## README

# bee-affix

[![npm version](https://img.shields.io/npm/v/bee-affix.svg)](https://www.npmjs.com/package/bee-affix)
[![Build Status](https://img.shields.io/travis/tinper-bee/bee-affix/master.svg)](https://travis-ci.org/tinper-bee/bee-affix)
[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-affix/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-affix?branch=master)
[![devDependency Status](https://img.shields.io/david/dev/tinper-bee/bee-affix.svg)](https://david-dm.org/tinper-bee/bee-affix#info=devDependencies)
[![NPM downloads](http://img.shields.io/npm/dm/bee-affix.svg?style=flat)](https://npmjs.org/package/bee-affix)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tinper-bee/bee-affix.svg)](http://isitmaintained.com/project/tinper-bee/bee-affix "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/tinper-bee/bee-affix.svg)](http://isitmaintained.com/project/tinper-bee/bee-affix "Percentage of issues still open")


react bee-affix component for tinper-bee

some description...

## Affix
将页面元素钉在可视范围。
当内容区域比较长，需要滚动页面时，这部分内容对应的操作或者导航需要在滚动范围内始终展现。常用于侧边菜单和按钮组合。页面可视范围过小时，慎用此功能以免遮挡页面内容。

## 使用方法

```
import Affix from 'bee-affix';

React.render(<Affix><div className="content"></div></Affix>,
         document.getElementById('target'));
```

## 样式引入

```
<link rel="stylesheet" href="./node_modules/bee-affix/build/Affix.css">
//或是
import "./node_modules/bee-affix/src/Affix.scss"
//或是
import "./node_modules/bee-affix/build/Affix.css"
```

## API

|参数|说明|类型|默认值|
|:--|:---:|:--:|---:|
|container|固定元素所属容器|object|document.body|
|offsetTop|固定被触发距离，默认是0 ，可选的属性|number|0|
|horizontal|被固定时是否可以左右滑动，默认是false，可选的属性|boolean|false|
|canHidden|当Affix的内容高度超过container可视区域的高度，Affix是否可以被隐藏一部分内容,false：affix始终完全展示，true：展示部分受container限制|boolean|false|
|target|设置 Affix 需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数，默认值() => window |function|() => window|
|onChange|触发固定或者固定取消时的回调函数,返回值{ affixed: true, event: evt} |function|-|
|onTargetChange|时刻获取Affix的状态值,返回值{state} |function|-|
|childrenRef|如果affix下面的内容高度是变化的，让childrenRef是affix下内容的ref；如果affix下面的内容高度不变，不需要使用这个属性|object|null|
#### 开发调试

```sh
$ npm install -g bee-tools
$ git clone https://github.com/tinper-bee/bee-affix
$ cd bee-affix
$ npm install
$ npm run dev
```

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