# @bbc/psammead-visually-hidden-text 中文文档

规范地址：https://npmcn.com/package/%40bbc/psammead-visually-hidden-text/

版本：2\.0\.7
npm 元数据更新时间：2025-03-06T15:54:30.107Z
中文译文更新时间：2026-11-07T18:48:39.562Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：14.2 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：@emotion/styled ^11\.0\.0
- 首次发布：2018-12-05T12:03:09.994Z
- 最新版本发布：2021-05-27T09:07:06.508Z
- 近 30 天下载量：9181（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 0 个）

## 中文简介

视觉隐藏文本的反射组件( 屏幕阅读器)

## 安装

```sh
npm install @bbc/psammead-visually-hidden-text
```

也可以使用：`pnpm add @bbc/psammead-visually-hidden-text`、`yarn add @bbc/psammead-visually-hidden-text`、`bun add @bbc/psammead-visually-hidden-text`

## README

# 暗影 隐藏的文字 [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Fcomponents%2Fpsammead-visually-hidden-text%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Fcomponents%2Fpsammead-visually-hidden-text%2Fpackage.json) [![Dependency Status](https://david-dm.org/bbc/psammead.svg?path=packages/components/psammead-visually-hidden-text)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-visually-hidden-text) [![peerDependencies Status](https://david-dm.org/bbc/psammead/peer-status.svg?path=packages/components/psammead-visually-hidden-text)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-visually-hidden-text&type=peer) [![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg?sanitize=true)](https://bbc.github.io/psammead/?path=/story/visuallyhiddentext--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-visually-hidden-text.svg)](https://www.npmjs.com/package/@bbc/psammead-visually-hidden-text) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)

## 说明

在页面上添加非可见文本,供屏幕阅读器和其他辅助技术使用.

## 安装

`npm install @bbc/psammead-visually-hidden-text`

## 道具

| 参数 | 类型 | 需求 | 默认 | 示例 |
| --- | --- | --- | --- | --- |
| 没有道具. |  |  |  |  |

## 使用量

```jsx
import VisuallyHiddenText from '@bbc/psammead-visually-hidden-text';

const WrappingComponent = () => (
  <VisuallyHiddenText>Some offscreen text</VisuallyHiddenText>
);
```

请记住,如果CSS被禁用,任何 `children` 将显示内含。 测试组件的用法应包括禁用页面样式.

### 何时使用此组件

视觉隐藏的文本应当与任何依赖视觉辅助或造型来传播其目的的组件一起使用,因为这些辅助工具可能不用于依赖辅助技术的用户.

例如,如果在一页上看到图像,图像上的源/拷贝右上方可能似乎在目的上显而易见,但当在图像的替代文字之后立即说出来时,这种组件的内容可能令人费解或困惑。 因此,它利用这一组成部分在读取其正文内容之前提供额外上下文.

### 不使用此组件时

避免使用带有会造成不必要的重复的文本的这个组件。 例如,不需要在“图像”旁边添加视觉隐藏文字 `img` 标记,因为辅助技术已经明确告知图像的存在,而这很可能只会证明给用户带来混乱或刺激.

类似地,在添加将通过一篇文章局部出现的隐藏文本时,避免使用可能暗示主体已完结的短语. 突然听到"在\[subject\]上多读"这样的短语可能会向用户暗示他们已经完成了文章. 为了缓解这种情况,您不妨将内容包装为 [`aside` ARIA 地标](https://www.w3.org/TR/2017/NOTE-wai-aria-practices-1.1-20171214/examples/landmarks/complementary.html) 或包括a ["斯基普链接"](https://www.w3.org/TR/WCAG20-TECHS/G1.html),给予用户在辅助技术读取插管的全部内容之前跳出回主体的选择.

## 捐款

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-visually-hidden-text 是什么？

视觉隐藏文本的反射组件\( 屏幕阅读器\)

### 如何安装 @bbc/psammead-visually-hidden-text？

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

### @bbc/psammead-visually-hidden-text 支持 TypeScript 吗？

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

### @bbc/psammead-visually-hidden-text 支持 ESM 还是 CommonJS？

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

### @bbc/psammead-visually-hidden-text 可以商用吗？

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

### @bbc/psammead-visually-hidden-text 的下载量有多少？

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

### @bbc/psammead-visually-hidden-text 还在维护吗？

最新版本 2\.0\.7 发布于 2021/05/27（5 年前）；至今共发布 38 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/12/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。