@bufferapp/ui

中文文档
9.8.5发布于 2024/08/19MITTypeScriptCommonJS近 30 天下载 1.4万

Shared UI components for buffer apps

原始使用文档
文档目录6 节
  1. Installation
  2. Usage
  3. Component Documentation / Reference
  4. Contributing
  5. Changelog
  6. License

✨ Buffer UI Components ✨


Buffer's UI components library and Style Guide for the Buffer Platform and the community

npm package Build Status Test Coverage

Welcome to the official Buffer UI library 🎉! This is where we host all the components used by the Buffer applications (Publish, Analyze and Engage, as well as our official Style Documentation). This library is open source and free for you to explore and use!

Installation

Buffer UI is available as an @bufferapp/ui npm package.

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react'
import ReactDOM from 'react-dom'
import Button from '@bufferapp/ui/Button'

function App() {
  return <Button type="primary" label="Hello, world!" />
}

ReactDOM.render(<App />, document.querySelector('#app'))

For usage instructions and how to add, update, and work with the components, see our CONTRIBUTING.md doc!

Component Documentation / Reference

Check out our ➡️ documentation website.

Contributing

Want to contribute to this project? That's awesome 🙌! Please check out our contribution doc. :)

Changelog

Curious about the latest changes? Please read the changelog and check the latest releases.

License

This project is licensed under the terms of the MIT license.

版本与发布记录

@bufferapp/ui 共发布 491 个版本,首次发布于 2018/12/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
9.8.5latest2024/08/192 年前
9.8.42024/08/082 年前
9.8.32024/08/082 年前
9.8.22024/08/062 年前
9.8.12024/08/052 年前
9.6.232024/07/172 年前

其他发布通道:v3-support → 3.18.3-beta.1,beta → 9.1.2-beta.d0685950f8。

关于 @bufferapp/ui 的常见问题

@bufferapp/ui 是什么?

Shared UI components for buffer apps

如何安装 @bufferapp/ui?

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

@bufferapp/ui 支持 TypeScript 吗?

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

@bufferapp/ui 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@bufferapp/ui 可以商用吗?

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

@bufferapp/ui 的下载量有多少?

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

@bufferapp/ui 还在维护吗?

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