@bbc/psammead-assets

中文文档
3.3.0发布于 2022/04/13Apache-2.0零依赖近 30 天下载 9674

收集许多Psammead组件或用户可能要求的共同资产,如SVG或小脚本.

中文使用文档
文档目录14 节
  1. 出口
  2. 安装
  3. 使用量
  4. 服务 SVG
  5. 使用量
  6. 核心图标 SVGs
  7. 使用量
  8. 媒体图标 SVGs
  9. 使用量
  10. 导航图标 SVGs
  11. 使用量
  12. 捐款
  13. 行为守则
  14. 许可证

沙姆米德资产 - Known Vulnerabilities Dependency Status peerDependencies Status GitHub license npm version PRs Welcome

这个软件包提供了许多Psammead组件或用户可能要求的常见资产的集合,例如SVG或小脚本.

出口

/amp-boilerplate - 帮助者,允许使用Psammead的项目方便地取出一个版本的拷贝 AMP所需的锅炉板脚本。 。 。 . /svgs - Psammead项目通常需要的SVG图标.

安装

npm install @bbc/psammead-assets --save

使用量

import { BBC_BLOCKS, news } from '@bbc/psammead-assets/svgs';

import { AMP_SCRIPT } from '@bbc/psammead-assets/amp-boilerplate';

服务 SVG

服务品牌SVG,比如 news,是包含 svg 组,取景箱,比例和高;

该套装目前为BBC新闻世界服务公司以及BBC新闻公司,BBC苏格兰分公司设有品牌SVG.

财产类型需求默认示例
group节点对不详<g fillrule="evenodd"><path d="M84.32" /></g>
viewbox对象对不详{ height: 24, width: 167.95 }
ratio编号对不详6.9979

您的 SVG 的宽度可以用您想要的高度乘以 ratio 数值.

使用量

const WrappingContainer = () => (
  <svg viewBox={`0 0 ${news.viewbox.width} ${news.viewbox.height}`}>{news.group}</svg>
);

核心图标 SVGs

核心图标是包含GEL Iconography Core所出风格的SVG图标的一个对象. 默认情况下, Core 图标的大小与文本一起良好 GEL BodyCopy 排字组.

使用量

import { coreIcons } from '@bbc/psammead-assets/svgs';

<p>{coreIcons.info} Did you know, in Switzerland it's illegal to own just one guinea pig?</p>

媒体图标 SVGs

媒体图标是包含有风格的SVG图标的一个对象,用于视频,音频,相片采集和引导. 媒体图标的大小与打印组的特定文本并行良好 GEL Minion。它们被用于 psammead-media-indicator 财务报告和审定财务报表 psammead-media-player 组件.

使用量

import { mediaIcons } from '@bbc/psammead-assets/svgs';

<span>
  {mediaIcons.audio}
  {duration && datetime && (<time dateTime={datetime}>{duration}</time>)}
</span>

导航图标 SVGs

导航图标是一个包含有样式的SVG图标用于汉堡和十字架的对象. 它们被用于 psammead-navigation 组件.

使用量

import { navigationIcons } from '@bbc/psammead-assets/svgs';

<span>
  {navigationIcons.cross}
</span>

捐款

何时 添加 向此工具包新导出 出口测试 还需要更新。 何时 删除 从此工具包中导出 出口测试 软件包版本需要更新,需要作重大修改(EG:1.2.1 - > 2.0.0),因为这将被视为由于功能被去除而导致的突破性修改.

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

行为守则

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

许可证

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

版本与发布记录

@bbc/psammead-assets 共发布 62 个版本,首次发布于 2018/11/29;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.3.0latest2022/04/134 年前
3.2.02022/04/084 年前
3.1.102021/11/304 年前
3.1.92021/05/275 年前
3.1.82021/03/105 年前
3.1.72021/03/025 年前

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

@bbc/psammead-assets 是什么?

收集许多Psammead组件或用户可能要求的共同资产,如SVG或小脚本.

如何安装 @bbc/psammead-assets?

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

@bbc/psammead-assets 支持 TypeScript 吗?

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

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

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

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

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

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

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