@bbc/psammead-headings

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

对标题和子标题重排样式组件

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

沙米德头 Known Vulnerabilities Dependency Status peerDependencies Status Storybook GitHub license npm version PRs Welcome

说明

标题是一组两个组件, Headline 财务报告和审定财务报表 SubHeading他们使用 h1 财务报告和审定财务报表 h2 HTML 元素分别为: Headline 用于页面上的单一用途 SubHeading 旨在重复使用.

安装

npm install @bbc/psammead-headings

道具

参数类型需求默认示例
脚本对象对拉丁语{可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指: {可以指:
服务字符串对不详'news'
暗号嘘没有虚假真实

使用量

import { Headline, SubHeading } from '@bbc/psammead-headings';
import { latin } from '@bbc/gel-foundations/scripts';

const Wrapper = () => (
  <Fragment>
    <Heading script={latin} service="news">
      Some headline
    </Heading>
    <SubHeading script={latin} service="news">
      Some subheadline
    </SubHeading>
  </Fragment>
);

SubHeading 组件在通过时可作为页面锁定 id 道具 (英语). 以上述用法为例:

<SubHeading id="some-subheadline" script={latin} service="news">
  Some subheadline
</SubHeading>

此用法将允许页面锁定 : www.bbc.com/news/articles/articleID#some-subheadline

何时使用此组件

这些组件可在页面上的任何一点使用,但 Headline 被设计为页面上方使用一次。 这个 SubHeading 选择 id 价值并传递到 h2 ,在引用内容时可用作锚.

无障碍说明

这个 SubHeading 组件的标签索引 -1 当它通过跳过链接导航到屏幕读取器时, 它能正确工作.

捐款

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

行为守则

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

许可证

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

版本与发布记录

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

版本发布日期距今
5.0.30latest2022/03/304 年前
5.0.292022/03/294 年前
5.0.282022/01/064 年前
5.0.272021/10/065 年前
5.0.262021/09/305 年前
5.0.252021/09/225 年前

其他发布通道:beta → 0.1.1,alpha → 4.0.0-alpha.0。

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

@bbc/psammead-headings 是什么?

对标题和子标题重排样式组件

如何安装 @bbc/psammead-headings?

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

@bbc/psammead-headings 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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