# xy-badge

> 基于 React Hooks 的徽章组件

Latest version **0.1.0** (published 2019-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install xy-badge
pnpm add xy-badge
yarn add xy-badge
bun add xy-badge
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-11-19 |
| First published | 2019-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 24 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | XueYou |
| Maintainers | xueyou2000 |
| Keywords | react, react-component, xy-badge |

## Links

- npm: https://www.npmjs.com/package/xy-badge
- Repository: https://github.com/xueyou2000/xy-badge
- Homepage: https://github.com/xueyou2000/xy-badge#readme
- Issues: https://github.com/xueyou2000/xy-badge/issues
- npm.io page: https://npm.io/package/xy-badge

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.12.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.12.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [utils-hooks](https://npm.io/package/utils-hooks.md) ^0.0.71

## 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

- 0.1.0 (latest) — 2019-11-19
- 0.0.4 — 2019-09-03
- 0.0.3 — 2019-05-11
- 0.0.2 — 2019-05-06

## README

| ![IE](https://github.com/alrra/browser-logos/blob/master/src/edge/edge_48x48.png?raw=true) | ![Chrome](https://github.com/alrra/browser-logos/blob/master/src/chrome/chrome_48x48.png?raw=true) | ![Firefox](https://github.com/alrra/browser-logos/blob/master/src/firefox/firefox_48x48.png?raw=true) | ![Opera](https://github.com/alrra/browser-logos/blob/master/src/opera/opera_48x48.png?raw=true) | ![Safari](https://github.com/alrra/browser-logos/blob/master/src/safari/safari_48x48.png?raw=true) |
| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| IE 10+ ✔                                                                                   | Chrome 31.0+ ✔                                                                                     | Firefox 31.0+ ✔                                                                                       | Opera 30.0+ ✔                                                                                   | Safari 7.0+ ✔                                                                                      |

![NPM version](http://img.shields.io/npm/v/xy-badge.svg?style=flat-square)
![node version](https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square)
![npm download](https://img.shields.io/npm/dm/xy-badge.svg?style=flat-square)

[![xy-badge](https://nodei.co/npm/xy-badge.png)](https://npmjs.org/package/xy-badge)

# xy-badge

徽章组件

## 安装

```bash
# yarn
yarn add xy-badge utils-hooks classnames
```

## 使用例子

```tsx
import React from "react";
import ReactDOM from "react-dom";
import { Badge, BadgeDot, ScrollNumber, ScrollNumberItem } from "xy-badge";
ReactDOM.render(
    <Badge count={10}>
        <a>Link</a>
    </Badge>,
    container
);
```

## API

| 属性          | 说明                                                                 | 类型                | 默认值 |
| ------------- | -------------------------------------------------------------------- | ------------------- | ------ |
| positionStyle | 悬浮 Badge 样式                                                      | React.CSSProperties | -      |
| dot           | 点模式, 不展示详细数字, 值显示一个小红点                             | boolean             | false  |
| status        | 状态, 可选值: "success"，"processing"，"default"，"error"，"warning" | string              | -      |
| text          | 设置状态点时的文本                                                   | React.ReactNode     | -      |
| children      | 包裹内容                                                             | React.ReactNode     | -      |
| count         | 要展示的徽标数                                                       | number              | -      |
| overflowCount | 封顶数值,超过封顶值不滚动数字，而是最追加一个+字符                   | number              | -      |
| showZero      | 是否显示 0                                                           | boolean             | false  |

## 开发

```sh
yarn run start
```

## 例子

http://localhost:6006

## 测试

```
yarn run test
```

## 开源许可

xy-badge is released under the MIT license.

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