@bbc/psammead-caption

中文文档
4.1.27发布于 2022/03/30Apache-2.0ESM + CJS近 30 天下载 7253

重现标题的样式组件

中文使用文档
文档目录10 节
  1. 说明
  2. 安装
  3. 道具
  4. 使用量
  5. 何时使用此组件
  6. 无障碍说明
  7. 路线图
  8. 捐款
  9. 行为守则
  10. 许可证

护身符 Known Vulnerabilities Dependency Status peerDependencies Status Storybook GitHub license npm version PRs Welcome

说明

这个 psammead-caption 组件为样式 figcaption 键.

安装

npm install @bbc/psammead-caption

道具

参数类型需求默认示例
脚本对象对拉丁语{可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指:
服务字符串对不详'news'

使用量

psammead-caption 可与 psammead-figure 财务报告和审定财务报表 psammead-visually-hidden-text 以这种方式实现组件。 此可视化隐藏文本是为了给辅助技术的用户上下文.

import Caption from '@bbc/psammead-caption';
import Figure from '@bbc/psammead-figure';
import VisuallyHiddenText from '@bbc/psammead-visually-hidden-text';
import { arabic } from '@bbc/gel-foundations/scripts';

const Wrapper = captionText => (
  <Figure>
    ...
    <Caption script={arabic} service="news">
      <VisuallyHiddenText>Image caption, </VisuallyHiddenText>
      {captionText}
    </Caption>
  </Figure>
);

何时使用此组件

这个 Caption 组件只应在 a 内使用 figure 键。 它的设计是在图像或视频组件后放置.

无障碍说明

因为这只是一个 <figcaption> 标记带有相关样式,当您使用此组件时,它具有与常规虚构元素相同的语义意义.

字体和背景-颜色选择符合WCAG AA色彩对比指引.

路线图

当这个标题用于不支持斜体文字的脚本时,我们可以考虑创建一个道克来切换 font-style: italic。 。 。 .

捐款

Psammead完全开源. 我们感谢任何贡献,无论是新的组件、错误修正还是总体改进。 请参看我们的主要贡献指南,可查阅: psammead 仓库的根。 。 。 .

行为守则

我们欢迎对这项工作的反馈和帮助。 通过参与这个项目,你同意遵守 行为守则请稍候再读一下.

许可证

萨姆米德 Apache 2.0 许可。 。 。 .

版本与发布记录

@bbc/psammead-caption 共发布 117 个版本,首次发布于 2018/12/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.1.27latest2022/03/304 年前
4.1.262022/03/294 年前
4.1.252022/03/104 年前
4.1.242022/01/064 年前
4.1.232021/10/065 年前
4.1.222021/09/305 年前

其他发布通道:alpha → 3.0.0-alpha.0。

关于 @bbc/psammead-caption 的常见问题

@bbc/psammead-caption 是什么?

重现标题的样式组件

如何安装 @bbc/psammead-caption?

在项目目录运行 npm install @bbc/psammead-caption,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@emotion/styled(^11.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@bbc/psammead-caption 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/bbc__psammead-caption 是否存在。

@bbc/psammead-caption 支持 ESM 还是 CommonJS?

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

@bbc/psammead-caption 可以商用吗?

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

@bbc/psammead-caption 的下载量有多少?

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

@bbc/psammead-caption 还在维护吗?

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