@chakra-ui/button

中文文档
2.1.0发布于 2023/07/19MITTypeScriptESM + CJS近 30 天下载 131.5万

A React component that is a base button.

原始使用文档
文档目录7 节
  1. Installation
  2. Import component
  3. Usage
  4. Button Sizes
  5. Button Variant
  6. Button with Icon
  7. Button loading state

Button

Buttons are used as triggers for actions. They are used in forms, toolbars, dialog footers and as stand-alone action triggers.

Installation

yarn add @chakra-ui/button

# or

npm i @chakra-ui/button

Import component

import { Button } from "@chakra-ui/button"

Usage

<Button colorScheme="green">Button</Button>

Button Sizes

Use the size prop to change the size of the button. You can set the value to xs, sm, md, or lg.

<Stack>
  <Button size="xs">Button</Button>
  <Button size="sm">Button</Button>
  <Button size="md">Button</Button>
  <Button size="lg">Button</Button>
</Stack>

Button Variant

Use the variant prop to change the visual style of the Button. You can set the value to solid, ghost, outline, or link.

<ButtonGroup>
  <Button variant="solid">Button</Button>
  <Button variant="outline">Button</Button>
  <Button variant="ghost">Button</Button>
  <Button variant="link">Button</Button>
</ButtonGroup>

Button with Icon

You can add left and right icons to the Button components.

<ButtonGroup>
  <Button leftIcon={<EmailIcon />} variant="solid">
    Email
  </Button>
  <Button rightIcon={<ArrowForwardIcon />} variant="outline">
    Call us
  </Button>
</ButtonGroup>

Button loading state

Pass isLoading prop to the Button component to show its loading state. You can optionally pass loadingText prop.

You can also use a custom spinner to render your own spinner component.

<Stack>
  <Button isLoading colorScheme="teal" variant="solid">
    Email
  </Button>

  <Button
    isLoading
    colorScheme="teal"
    variant="outline"
    spinner={<BarSpinner />}
  >
    Submit
  </Button>
</Stack>

版本与发布记录

@chakra-ui/button 共发布 456 个版本,首次发布于 2020/06/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.1.0latest2023/07/193 年前
0.0.0-dev-20230718132637dev2023/07/183 年前
0.0.0-dev-202307181307422023/07/183 年前
0.0.0-dev-202307181247172023/07/183 年前
0.0.0-dev-202307181223362023/07/183 年前
2.0.182023/03/313 年前

其他发布通道:canary → 0.0.0-canary-2021118164051,pr → 0.0.0-pr-202212011232,next → 2.0.0-next.3,next-dev → 0.0.0-next-dev-202241614737,dev → 0.0.0-dev-20230718132637。

关于 @chakra-ui/button 的常见问题

@chakra-ui/button 是什么?

A React component that is a base button.

如何安装 @chakra-ui/button?

在项目目录运行 npm install @chakra-ui/button,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18)、@chakra-ui/system(>=2.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@chakra-ui/button 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@chakra-ui/button 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@chakra-ui/button 可以商用吗?

@chakra-ui/button 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@chakra-ui/button 的下载量有多少?

根据 npm 官方下载统计,@chakra-ui/button 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,314,695 次,日均约 43,823 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@chakra-ui/button 还在维护吗?

最新版本 2.1.0 发布于 2023/07/19(3 年前);至今共发布 456 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/06/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。