# @bbc/psammead-embed-error 中文文档

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

版本：3\.0\.37
npm 元数据更新时间：2026-04-16T10:49:09.715Z
中文译文更新时间：2026-11-08T14:48:39.460Z
软件包许可：Apache-2\.0

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

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

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

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

## 中文简介

精益错误消息组件,为嵌入式内容所设计.

## 安装

```sh
npm install @bbc/psammead-embed-error
```

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

## README

# 沙姆米德-嵌入物-错误 - [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Fcomponents%2Fpsammead-embed-error%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Fcomponents%2Fpsammead-embed-error%2Fpackage.json) [![Dependency Status](https://david-dm.org/bbc/psammead.svg?path=packages/components/psammead-embed-error)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-embed-error) [![peerDependencies Status](https://david-dm.org/bbc/psammead/peer-status.svg?path=packages/components/psammead-embed-error)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-embed-error&type=peer) [![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg?sanitize=true)](https://bbc.github.io/psammead/?path=/story/embed-error--containing-image) [![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-embed-error.svg)](https://www.npmjs.com/package/@bbc/psammead-embed-error) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)

## 说明

`EmbedError` 是一个为嵌入内容设计的精益错误信息组件,例如iframe中的内容。 它将填充母容器,并可选择填充取景口,同时相应定位其内容.

## 安装

```jsx
npm install @bbc/psammead-embed-error --save
```

## 道具

| 参数 | 类型 | 需求 | 默认 | 示例 |
| --- | --- | --- | --- | --- |
| `service` | 字符串 | 没有 | `news` | `arabic` |
| `fillViewport` | 布尔 | 没有 | `false` | `true` |
| `message` | 字符串 | 对 | \- 说吧 | `Sorry, we can't display this content.` |
| `link` | 对象 | 没有 | `null` | 见: [链接](https://npmcn.com/package/%40bbc/psammead-embed-error/#readme-link)。 。 。 . |

### `link`

| 参数 | 类型 | 需求 | 默认 | 示例 |
| --- | --- | --- | --- | --- |
| `text` | 字符串 | 对 | 无 | `View alternate content.` |
| `href` | 字符串 | 对 | 无 | `https://www.bbc.co.uk/news/av-embed/a-video-about-dogs` |

## 使用量

如果您在 iframe 中服务内容, 并且希望用户有无缝错误体验, 此组件特别有用 。 考虑以下例子:

```js
// An article with an iframe.
<iframe src="https://www.bbc.co.uk/news/av-embed/a-video-about-cats"></iframe>
```

```js
// iframe content.
import EmbedError from '@bbc/psammead-embed-error';

const Page = () => {
  if (error) {
    return
    <EmbedError
      message="Sorry, we can't display this content."
      link={{
        text: 'View alternate content.',
        href: 'https://www.bbc.co.uk/news/article/all-about-dogs',
      }}
      fillViewport
    />;
  }
};
```

注意使用 `fillViewport`,可以确保错误将填充文章中的 iframe.

### 何时使用此组件

当您想要显示填充容器或取景口的错误消息时,应当使用此组件.

### 不使用此组件时

此组件不应用于显示错误以外的信件 .

### 无障碍说明

此组件的错误消息被包裹在一个 `<strong>` 元素,向辅助技术的用户表明这是一种重要信息。 这与媒体玩家的"占位符"中使用的"指导"组件类似.

### 路线图

预计这一构成部分的所需经费将发生变化。 莫扎特错误报告的发展将影响未来如何(和在何处)使用这个组件.

## 捐款

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-embed-error 是什么？

精益错误消息组件,为嵌入式内容所设计\.

### 如何安装 @bbc/psammead-embed-error？

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

### @bbc/psammead-embed-error 支持 TypeScript 吗？

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

### @bbc/psammead-embed-error 支持 ESM 还是 CommonJS？

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

### @bbc/psammead-embed-error 可以商用吗？

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

### @bbc/psammead-embed-error 的下载量有多少？

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

### @bbc/psammead-embed-error 还在维护吗？

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