@bbc/psammead-heading-index

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

用于索引页的h1

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

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

说明

这个 HeadingIndex 使用a h1 HTML元素并被用在索引页面上,例如IDX,FIX和Most Read.

安装

npm install @bbc/psammead-heading-index

道具

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

使用量

import HeadingIndex from '@bbc/psammead-heading-index';
import { latin } from '@bbc/gel-foundations/scripts';

const Wrapper = () => (
  <Fragment>
    <HeadingIndex script={latin} service="news">
      Heading
    </HeadingIndex>
  </Fragment>
);

何时使用此组件

此组件被设计为一次在页面上方使用.

这个 HeadingIndex 可以选择 id 属性,在引用内容时可用作锚.

<HeadingIndex id="content" script={latin} service="news">
  Heading
</HeadingIndex>

无障碍说明

这个 HeadingIndex 组件的标签索引 -1,这保证了它可以被静态技术聚焦.

捐款

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

行为守则

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

许可证

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

版本与发布记录

@bbc/psammead-heading-index 共发布 46 个版本,首次发布于 2020/05/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.30latest2022/03/304 年前
3.0.292022/03/294 年前
3.0.282022/01/064 年前
3.0.272021/10/065 年前
3.0.262021/09/305 年前
3.0.252021/09/225 年前

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

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

@bbc/psammead-heading-index 是什么?

用于索引页的h1

如何安装 @bbc/psammead-heading-index?

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

@bbc/psammead-heading-index 支持 TypeScript 吗?

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

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

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

@bbc/psammead-heading-index 可以商用吗?

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

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

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

@bbc/psammead-heading-index 还在维护吗?

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