">文档:<amp-social-share> - amp.dev - AMP 框架
AMP

amp-social-share

实验性
Bento

描述

用法

 

必需脚本

<script async custom-element="amp-social-share" src="https://cdn.ampproject.org/v0/amp-social-share-1.0.js"></script>

用法

amp-social-share 组件为社交平台显示社交分享按钮。

当前,amp-social-share 生成的所有按钮(包括预先配置的提供商的按钮)都没有向辅助技术(如屏幕阅读器)公开的标签/可访问名称。请务必包含带有描述性标签的 aria-label,否则这些控件将仅仅被播报为未标记的“按钮”元素。

示例:基本社交分享按钮

分享按钮会为您猜测一些预先配置的提供商的默认值。它假定当前文档规范 URL 是您要分享的 URL,页面标题是您要分享的文本。

<amp-social-share
  type="twitter"
  aria-label="Share on Twitter"
></amp-social-share>

示例:传递参数

当您想向分享端点传递参数时,您可以指定 data-param-<attribute>,它将附加到分享端点。

<amp-social-share
  type="linkedin"
  width="60"
  height="44"
  data-param-text="Hello world"
  data-param-url="https://example.com/"
  aria-label="Share on LinkedIn"
>
</amp-social-share>

Linkedin 是预先配置的提供商之一,因此您无需提供 data-share-endpoint 属性。

在有效的 AMP 文档外部独立使用

Bento 允许您在非 AMP 页面中使用 AMP 组件,而无需完全提交到有效的 AMP。您可以使用这些组件并将它们放置在不支持 AMP 的框架和 CMS 的实现中。在我们的指南 在非 AMP 页面中使用 AMP 组件 中阅读更多信息。

要查找 amp-social-share 的独立版本,请参阅 bento-social-share

预配置的提供商

amp-social-share 组件提供 一些预先配置的提供商,它们知道自己的分享端点以及一些默认参数。

提供商 类型 参数
Web Share API(触发操作系统分享对话框) system
  • data-param-text:可选,默认为:“当前页面标题”
  • data-mode:可选,如果设置为 replace,则会移除所有其他分享选项。
电子邮件 email
  • data-param-subject:可选,默认为:当前页面标题
  • data-param-body:可选,默认为:rel=canonical URL
  • data-param-recipient:可选,默认为:''(空字符串)
Facebook facebook
  • data-param-app_id必需,默认为:无。此参数是 Facebook 分享对话框 所需的 Facebook app_id
  • data-param-href:可选,默认为:rel=canonical URL
  • data-param-quote:可选。可用于分享引述或文本。
LinkedIn linkedin
  • data-param-url:可选,默认为:rel=canonical URL
Pinterest pinterest
  • data-param-media:可选(但强烈建议设置),默认为:无。在 Pinterest 上分享媒体的 URL。如果未设置,Pinterest 会要求最终用户上传媒体。
  • data-param-url:可选,默认为:rel=canonical URL
  • data-param-description:可选,默认为:当前页面标题
Tumblr tumblr
  • data-param-url:可选,默认为:rel=canonical URL
  • data-param-text:可选,默认为:当前页面标题
Twitter twitter
  • data-param-url:可选,默认为:rel=canonical URL
  • data-param-text:可选,默认为:当前页面标题
Whatsapp whatsapp
  • data-param-text:可选,默认为:“当前页面标题 - 当前页面 URL”
LINE line
  • data-param-url:可选,默认为:rel=canonical URL
  • data-param-text:可选,默认为:当前页面标题
SMS sms
  • data-param-body:可选,默认为:rel=title - rel=canonical URL

未配置的提供商

除了预先配置的提供商外,你还可以通过在 amp-social-share 组件中指定其他属性来使用未配置的提供商。

示例:为未配置的提供商创建分享按钮

以下示例通过将 data-share-endpoint 属性设置为 Facebook Messenger 自定义协议的正确端点,通过 Facebook Messenger 创建一个分享按钮。

<amp-social-share
  type="facebookmessenger"
  data-share-endpoint="fb-messenger://share"
  data-param-text="Check out this article: TITLE - CANONICAL_URL"
  aria-label="Share on Facebook Messenger"
>
</amp-social-share>

由于这些提供商未预先配置,因此你需要为提供商创建合适的按钮图像和样式。

变量替换

你可以在 <amp-social-share> 元素中使用 全局 AMP 变量替换。在下面的示例中,TITLE 会替换为页面标题,CANONICAL_URL 会替换为文档的规范 URL。

<amp-social-share
  type="whatsapp"
  data-param-text="Check out this article: TITLE - CANONICAL_URL"
>
</amp-social-share>

属性

type(必需)

选择提供商类型。对于预先配置的提供商和未配置的提供商,此项都是必需的。

data-target

指定打开目标的 target。对于 iOS 上的电子邮件/短信以外的所有情况,默认值为 _blank,在这种情况下,target 会设置为 _top

请注意,我们仅建议对电子邮件使用此覆盖。

data-share-endpoint

对于未配置的提供商,此属性是必需的。

一些热门提供商已预先配置分享端点。有关详细信息,请参阅预先配置的提供商部分。对于未配置的提供商,你需要指定分享端点。

data-param-*

所有以 data-param-* 为前缀的属性都会变成 URL 参数,并传递给分享端点。

aria-label

默认情况下,aria-label 属性会填充为 按类型分享,其中“类型”是提供给组件的 type 属性。如果向 aria-label 传递非空值,它将覆盖默认值。

样式

默认样式

默认情况下,amp-social-share 包含一些热门的预先配置提供商。这些提供商的按钮会使用提供商的官方颜色和徽标进行样式化。默认宽度为 60px,默认高度为 44px。

访问 AMP Start,了解可在 AMP 页面中使用的响应式预设样式分享链接。

自定义样式

有时你希望提供自己的样式。你可以简单地覆盖提供的样式,如下所示

amp-social-share[type='twitter'] {
  color: blue;
  background: red;
}

自定义 amp-social-share 图标样式时,请确保自定义图标符合提供商(例如 Twitter、Facebook 等)制定的品牌准则。

辅助功能

焦点指示

amp-social-share 元素默认为蓝色轮廓,作为可见焦点指示符。它还默认为 tabindex=0,使用户可以轻松地通过一个页面上同时使用的多个 amp-social-share 元素进行切换。

默认焦点指示符通过以下 CSS 规则集实现。

amp-social-share:focus {
  outline: #0389ff solid 2px;
  outline-offset: 2px;
}

可以通过为焦点定义 CSS 样式并将其包含在 AMP HTML 页面上的 style 标签中来覆盖默认焦点指示符。在下面的示例中,第一个 CSS 规则集通过将 outline 属性设置为 none,来移除所有 amp-social-share 元素上的焦点指示符。第二个规则集为所有具有 custom-focus 类的 amp-social-share 元素指定了一个红色轮廓(而不是默认的蓝色),还将 outline-offset 设置为 3px

amp-social-share:focus{
  outline: none;
}

amp-social-share.custom-focus:focus {
  outline: red solid 2px;
  outline-offset: 3px;
}

使用这些 CSS 规则,amp-social-share 元素不会显示可见焦点指示符,除非它们包含 custom-focus 类,在这种情况下它们将具有红色轮廓指示符。

颜色对比度

请注意,type 值为 twitterwhatsapplineamp-social-share 将显示一个按钮,其前景/背景颜色组合低于 WCAG 2.1 SC 1.4.11 非文本对比度 中为非文本内容定义的 3:1 阈值。

如果没有足够的对比度,内容可能难以感知,因此难以识别。在极端情况下,对比度低的内容对于颜色感知障碍的人来说可能根本不可见。对于上述分享按钮,用户可能无法正确感知/理解分享控件是什么,它们与什么服务相关。

版本说明

amp-social-share1.0 版本有一些附加功能,使其与 0.1 版本不同。

  1. 已更新预配置提供商的默认图标,以反映其关联公司的最新徽标和颜色,因此在迁移到 1.0 时会看到一组新徽标。
  2. 现在可以使用 CSS 设置默认图标的前景和背景颜色。有关更多信息,请参阅上面的“样式”部分。
  3. 现在支持在默认图标上使用自定义徽标或文本。如果 amp-social-share 组件有任何子元素,它们现在将显示在默认图标的替代位置。(在 0.1 中,它们将覆盖在现有图标上。)
需要更多帮助?

您已经阅读了本文档十几次,但它并没有真正涵盖您的所有问题?也许其他人也有同感:在 Stack Overflow 上联系他们。

转到 Stack Overflow
发现了一个错误或缺少某个功能?

AMP 项目强烈鼓励您参与和贡献!我们希望您能成为我们开源社区的持续参与者,但我们也欢迎您对您特别热衷的问题进行一次性贡献。

转到 GitHub