AMP

重要提示:此文档不适用于你当前选择的格式故事

amp-social-share

 
现在,你可以使用此组件在有效的 AMP 文档之外,使用此组件的 Bento 版本。 在 Bento 指南中了解更多信息。

描述

用法

 

必需脚本

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

用法

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

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

示例:基本社交分享按钮

对于某些预配置的提供商,分享按钮会为你猜测一些默认值。它假设当前文档的规范网址是你想要分享的网址,而页面标题是你想要分享的文本。

<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-social-share 组件提供了 一些预配置的提供商,这些提供商知道其共享端点以及一些默认参数。

提供商 类型 参数
Web Share API(触发 OS 分享对话框) 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 app_idFacebook 分享对话框需要此参数。
  • 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

指定在其中打开目标的目标。对于除 iOS 上的电子邮件/SMS 之外的所有情况,默认值为 _blank,在 iOS 上,目标设置为 _top

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

data-share-endpoint

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

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

data-param-*

所有带有 data-param-* 前缀的属性都会转换为 URL 参数并传递到分享端点。

aria-label

默认情况下,aria-label 属性将使用 Share by type 填充,其中“type”是提供给组件的 type 属性。如果将非空值传递到 aria-label,它将覆盖默认值。

样式

默认样式

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

访问 AMP Start,获取你可以在 AMP 页面中使用的响应式、预先设置样式的共享链接。

自定义样式

有时你想要提供自己的样式。你可以像下面这样简单地覆盖提供的样式

amp-social-share[type='twitter'] {
  background: red;
  background-image: url(datauri:svg/myownsvgicon);
}

在自定义 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-focusamp-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 验证器规范中的 amp-social-share 规则

需要更多帮助?

您已经阅读这份文档很多遍了,但它并没有真正涵盖您的所有问题?也许其他人也有同感:请在 Stack Overflow 上联系他们。

前往 Stack Overflow
发现错误或缺少功能?

AMP 项目强烈鼓励您的参与和贡献!我们希望您能成为我们开源社区的长期参与者,但我们也欢迎您针对自己特别关注的问题进行一次性贡献。

前往 GitHub