@bbc/psammead-brand

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

提供 BBC 新闻标志(作为 SVG),嵌入一个硬码链接 https://www.bbc.co.uk/news (中文(简体) )

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

沙姆米德品牌(英语: Known Vulnerabilities Dependency Status peerDependencies Status Storybook GitHub license npm version PRs Welcome

说明

这个 Brand 组件提供BBC服务标志(作为SVG),嵌入于一个有样式的链接和div. 该链接目前被硬码为"https://www.bbc.co.uk/news".

Brand 使用一个 product, (中文(简体) ), svgHeight, (中文(简体) ), minWidth, (中文(简体) ), maxWidth, (中文(简体) ), url, (中文(简体) ), serviceLocalisedName, (中文(简体) ), backgroundColour, (中文(简体) ), logoColour 财务报告和审定财务报表 svg 作为道具.

这个 product 转至 视觉 隐藏文字 组件,嵌入 Brand 内.

这个 serviceLocalisedName 是一个可选的道克, 指的是服务 eg 的本地名称 Yoruba。它也传递给 视觉 隐藏文字 在品牌组件中.

这个 svg 道具必须包含 group, (中文(简体) ), viewbox 价值和a ratio中,用于 svg 键。 实例 svg 对象可见于 @bbc/psammead-资产。 。 。 .

这个 minWidth 财务报告和审定财务报表 maxWidth 需要数值,以便实现 svg 随着取景口变得非常小的EG:功能手机,元素到动态尺度.

这个 svgHeight 值充当 svg 元素 表示整体横幅高度不会随着动态缩放而变化,同时也是 height 允许打开 svg 元素在旗帜中始终保持垂直中心.

这个 backgroundColour 是背景颜色,并且 logoColour 是SVG的颜色和在品牌上徘徊/聚焦时的下划线.

这个 url 值是链接,指向与该值相关的服务首页 svg。 。 。 .

这个 scriptLink 可用于渲染 脚本链接 组件,它是与服务变体的链接.

出口

/skip-link - 使用跳过链接组件帮助键盘用户跳到页面上的主要内容.

安装

npm install @bbc/psammead-brand

道具

参数类型需求默认示例
产品字符串对不详'BBC News'
svg 宽度数目对不详24
微风数目对不详240
最大宽度数目对不详380
常规对象对不详{组 : (<g fillrule="evenodd"><path d="M84.32" /></g>),收视框:{高:24,宽:167.95},比例:6.9979}
背景颜色字符串对不详${C_POSTBOX} 或相关的字符串六进制码
标志颜色字符串对不详${C_WHITE} 或相关的字符串六进制码
url 密码字符串没有不详https://www.bbc.co.uk/news
本地化服务Name字符串没有不详'Yoruba'
边框Top布尔没有falsetrue
边框布尔没有falsetrue
脚本链接节点没有null<ScriptLink service='news' script={latin} href='https://www.bbc.com/serbian/lat'> Lat </ScriptLink>
跳过链接节点没有null<SkipLink service='news' script={latin} href='#content'> Skip to content </SkipLink>
链接ID字符串没有null'brandLink'

使用量

此组件的典型使用大小写在页的顶端 header 元素。在完成这项工作时,建议将组件包成一个 banner 角色不过,a header 带有 banner 角色只应在一页上出现一次.

使用时 Brand 在页眉中,您应确保 borderBottom 道具设定为真. 同样,当在脚印上使用品牌时,你应该设置 borderTop 真实的。 这保证了当在PC上的高对比度模式下,当用户在FireFox中更改色彩偏好时,该模式的上/下 Brand 组件可见.

ScriptLink 组件应传递至 scriptLink 仅当链接到服务变量时.

import Brand from '@bbc/psammead-brand';
import SkipLink from '@bbc/psammead-brand/skip-link';
import { igbo } from '@bbc/psammead-assets/svgs';
import ScriptLink from '@bbc/psammead-script-link';
import { C_POSTBOX, C_WHITE } from '@bbc/psammead-styles/colours';
import { latin } from '@bbc/gel-foundations/scripts';

const scriptLink = (
  <ScriptLink
    service="news"
    script={latin}
    href="https://www.bbc.com/serbian/lat"
  >
    Lat
  </ScriptLink>
);

const skipLink = (
  <SkipLink service="news" script={latin} href="#content">
    Skip to content
  </SkipLink>
);

const Header = (product, serviceName) => (
  <header role="banner">
    <Brand
      product={product}
      serviceLocalisedName={serviceName}
      svgHeight={24}
      maxWidth={280}
      minWidth={180}
      svg={igbo}
      url="https://www.bbc.co.uk/news"
      backgroundColour={backgroundColour}
      logoColour={logoColour}
      borderBottom
      scriptLink={scriptLink}
      skipLink={skipLink}
    />
  </header>
);

何时使用此组件

这个 Brand 组件被设计用于需要BBC标志作为SVG时. Brand 用于 品牌管理员,它使用它传递给 Brand。 。 。 .

无障碍说明

  • 提供可视隐藏文本(例如供屏幕阅读器用户使用)
  • Brand 是键盘可访问的,并提供徘徊和焦点样式
  • 品牌SVG对cs被禁用或高对比模式启用的用户有支持.

补充说明

  • width: 100% 两者都需要 <a> 编辑 <svg> 允许品牌在 Firefox 浏览器上动态缩放

捐款

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

行为守则

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

许可证

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

版本与发布记录

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

版本发布日期距今
7.3.18latest2022/03/304 年前
7.3.172022/03/294 年前
7.3.162022/01/064 年前
7.3.152021/11/174 年前
7.3.142021/11/164 年前
7.3.132021/11/025 年前

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

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

@bbc/psammead-brand 是什么?

提供 BBC 新闻标志(作为 SVG),嵌入一个硬码链接 https://www.bbc.co.uk/news (中文(简体) )

如何安装 @bbc/psammead-brand?

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

@bbc/psammead-brand 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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