# xy-button > 基于 React Hooks 的按钮组件 Latest version **1.1.0** (published 2019-11-19) · MIT license · 0 weekly downloads ## Install ```sh npm install xy-button pnpm add xy-button yarn add xy-button bun add xy-button ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2019-11-19 | | First published | 2019-04-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 6 | | Unpacked size | 20.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | XueYou | | Maintainers | xueyou2000 | | Keywords | react, react-component, xy-button | ## Links - npm: https://www.npmjs.com/package/xy-button - Repository: https://github.com/xueyou2000/xy-button - Homepage: https://github.com/xueyou2000/xy-button#readme - Issues: https://github.com/xueyou2000/xy-button/issues - npm.io page: https://npm.io/package/xy-button ## Dependencies (6) - [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 - [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) ^0.1.4 - [@fortawesome/fontawesome-svg-core](https://npm.io/package/@fortawesome/fontawesome-svg-core.md) ^1.2.17 - [@fortawesome/free-solid-svg-icons](https://npm.io/package/@fortawesome/free-solid-svg-icons.md) ^5.8.1 ## 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.1.0 (latest) — 2019-11-19 - 1.0.3 — 2019-09-03 - 1.0.2 — 2019-05-11 - 1.0.1 — 2019-05-05 - 1.0.0 — 2019-04-30 - 0.0.4 — 2019-04-30 - 0.0.3 — 2019-04-26 - 0.0.2 — 2019-04-20 ## 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][npm-image]][npm-url] [![node version][node-image]][node-url] [![npm download][download-image]][download-url] [npm-image]: http://img.shields.io/npm/v/xy-button.svg?style=flat-square [npm-url]: http://npmjs.org/package/xy-button [node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square [node-url]: http://nodejs.org/download/ [download-image]: https://img.shields.io/npm/dm/xy-button.svg?style=flat-square [download-url]: https://npmjs.org/package/xy-button [![xy-button](https://nodei.co/npm/xy-button.png)](https://npmjs.org/package/xy-button) # Button 按钮用于开始一个即时操作。[在线例子](https://xueyou2000.github.io/xy-button/demo) ## 安装 ```bash # yarn yarn add xy-button classnames ``` ## 使用例子 ```tsx import React from "react"; import ReactDOM from "react-dom"; import { Button, ButtonGroup } from "xy-button"; ReactDOM.render(, container); ``` ## 何时使用 标记了一个（或封装一组）操作命令，响应用户点击行为，触发相应的业务逻辑。 ## API ### 按钮 | 属性 | 说明 | 类型 | 默认值 | | -------- | ------------------------------------------------------------------ | -------------- | --------- | | ghost | 幽灵属性，使按钮背景透明 | boolean | false | | long | 是否长按钮 | boolean | false | | icon | 设置按钮的图标类型 | IconDefinition | - | | loading | 设置按钮载入状态 | boolean | `false` | | disabled | 按钮失效状态 | boolean | `false` | | shape | 设置按钮形状，可选值为 `circle` 或者不设 | string | - | | size | 设置按钮大小，可选值为 `small` `large` 或者不设 | string | `default` | | type | 设置按钮类型，可选值为 `primary` `dashed` `text` `danger` 或者不设 | string | - | | onClick | `click` 事件的 handler | function | - | ### 按钮组 | 属性 | 说明 | 类型 | 默认值 | | -------- | ----------------------------------------------- | ------- | --------- | | shape | 设置按钮形状，可选值为 `circle` 或者不设 | string | - | | size | 设置按钮大小，可选值为 `small` `large` 或者不设 | string | `default` | | vertical | 是否垂直 | boolean | false | ## 开发 ```sh yarn run start ``` ## 例子 http://localhost:6006 ## 测试 ``` yarn run test ``` ## 开源许可 xy-button is released under the MIT license. --- _Source: https://npm.io/package/xy-button · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._