# @bbc/psammead-play-button 中文文档

规范地址：https://npmcn.com/package/%40bbc/psammead-play-button/

版本：3\.0\.37
npm 元数据更新时间：2026-04-16T10:54:00.675Z
中文译文更新时间：2026-11-07T19:00:43.793Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bbc/psammead-play-button
原文对照：https://npmcn.com/package/%40bbc/psammead-play-button/?lang=original
项目主页：https://github.com/bbc/psammead/blob/latest/packages/components/psammead-play-button/README.md
源码仓库：https://github.com/bbc/psammead/tree/latest/packages/components/psammead-play-button

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：64.9 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- peer 依赖：react \>=16\.9\.0，@emotion/styled ^11\.0\.0
- 首次发布：2019-10-07T07:56:24.419Z
- 最新版本发布：2022-04-13T12:15:27.070Z
- 近 30 天下载量：3726（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 0 个）

## 中文简介

为可播放媒体提供可选择的播放按钮.

## 安装

```sh
npm install @bbc/psammead-play-button
```

也可以使用：`pnpm add @bbc/psammead-play-button`、`yarn add @bbc/psammead-play-button`、`bun add @bbc/psammead-play-button`

## README

# 萨姆米德游戏按钮 - [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Fcomponents%2Fpsammead-play-button%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Fcomponents%2Fpsammead-play-button%2Fpackage.json) [![Dependency Status](https://david-dm.org/bbc/psammead.svg?path=packages/components/psammead-play-button)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-play-button) [![peerDependencies Status](https://david-dm.org/bbc/psammead/peer-status.svg?path=packages/components/psammead-play-button)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-play-button&type=peer) [![Storybook](https://raw.githubusercontent.com/storybooks/play-button/master/badge/badge-storybook.svg?sanitize=true)](https://bbc.github.io/psammead/?path=/story/play-button--default) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/bbc/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-play-button.svg)](https://www.npmjs.com/package/@bbc/psammead-play-button) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)

## 说明

这个 `PlayButton` 组件生成带有“video”或“autio”图标和可选持续时间时间戳的按钮。 显示的图标由 `type` 道具 (英语). 组件默认显示“ video” 图标 。 本部分有显示持续时间戳的选项,如果不提供,则将优雅无用。 点击时,函数传递给 `onClick` 将召入.

## 安装

`npm install @bbc/psammead-play-button`

## 道具

| 参数 | 类型 | 需求 | 默认 | 示例 |
| --- | --- | --- | --- | --- |
| 服务 | 字符串 | 对 | 不详 | `'news'` |
| 标题 | 字符串 | 对 | 不详 | `'Foo.'` |
| 点击 | 函数 | 对 | 不详 | `() => {}` |
| 会期 | 字符串 | 没有 | `null` | `'2:30'` |
| 持续时间 | 字符串 | 没有 | `null` | `'2 minutes 30 seconds'` |
| 约会时间 | 字符串 | 没有 | `null` | `'PT2M30S'` |
| 类型 | 字符串 | 没有 | `'video'` | `'audio'` |
| 类Name | 字符串 | 没有 | `null` | `'bar'` |
| 指导 | 字符串 | 没有 | `null` | `'Contains strong language.'` |

### 支助 `type`编号

-   `'video'`
-   `'audio'`

## 使用量

这个组件的典型用法是向用户说明媒体资产占位符包含可玩媒体,即"视频"或"音频",如果适用的话,其持续时间. 触发回放的函数将传递给按钮 `onClick` 道具 (英语).

```jsx
import PlayButton from '@bbc/psammead-play-button';

<PlayButton
  service="news"
  title="Dog barks at cat."
  onClick={handleClick}
  duration="2:30"
  durationSpoken="2 minutes 30 seconds"
  datetime="PT2M30S"
  type="audio"
  guidanceMessage="Contains strong language."
/>;
```

### 何时使用此组件

这个 `PlayButton` 组件设计用于含有可播放介质的媒体资产占位符。 它向用户表示期望"video"或"adio"的内容,以及如果适用的话其持续时间.

### 无障碍说明

预计这一构成部分将为屏幕阅读器和其他辅助技术提供关于可播放媒体的信息。 媒体的名称必须传递给 `title` 道具,如果需要显示持续时间,则使用方便人的版本 `durationSpoken`。如果视频有指导信息,在静态文本中也会读出这些信息。 用于构建字符串, 以 [视觉 隐藏文字](https://github.com/bbc/psammead/tree/latest/packages/components/psammead-visually-hidden-text) 键。 图标标记为 `aria-hidden="true"`,这意味着它应该被屏幕阅读器忽略.

## 捐款

Psammead完全开源. 我们感谢任何贡献,无论是新的组件、错误修正还是总体改进。 请参看我们的主要贡献指南,可查阅: [psammead 仓库的根](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)。 。 。 .

### [行为守则](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)

我们欢迎对这项工作的反馈和帮助。 通过参与这个项目,你同意遵守 [行为守则](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)请稍候再读一下.

### 许可证

萨姆米德 [Apache 2.0 许可](https://github.com/bbc/psammead/blob/latest/LICENSE)。 。 。 .

## 常见问题

### @bbc/psammead-play-button 是什么？

为可播放媒体提供可选择的播放按钮\.

### 如何安装 @bbc/psammead-play-button？

在项目目录运行 npm install @bbc/psammead-play-button，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.9\.0）、@emotion/styled（^11\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bbc/psammead-play-button 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bbc\_\_psammead-play-button 是否存在。

### @bbc/psammead-play-button 支持 ESM 还是 CommonJS？

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

### @bbc/psammead-play-button 可以商用吗？

@bbc/psammead-play-button 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bbc/psammead-play-button 的下载量有多少？

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

### @bbc/psammead-play-button 还在维护吗？

最新版本 3\.0\.37 发布于 2022/04/13（4 年前）；至今共发布 84 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/10/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。