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,否則這些控制項只會宣告為未標示的「button」元素。

範例:基本社群分享按鈕

分享按鈕會為某些預先設定的供應商猜測一些預設值。它假設目前的標準網址是您想要分享的網址,而頁面標題是您想要分享的文字。

<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 app_id,是 Facebook 分享對話方塊的必要參數。
  • data-param-href:選填,預設值為:rel=canonical URL
  • data-param-quote:選填。可用於分享引言或文字。
LinkedIn linkedin
  • data-param-url:選填,預設值為:rel=canonical URL
Pinterest pinterest
  • data-param-media:選填 (但強烈建議設定),預設值為:無。要在 Pinterest 上分享的媒體網址。若未設定,系統會要求終端使用者透過 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:選填,預設值為:「目前頁面標題 - 目前頁面網址」
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 則會替換為文件的標準網址。

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

屬性

type (必要)

選取供應商類型。預先設定和未設定的供應商皆為必要。

data-target

指定開啟目標的目標位置。除了 iOS 上的電子郵件/簡訊之外,所有情況的預設值皆為 _blank,在 iOS 上的電子郵件/簡訊中,目標會設定為 _top

請注意,我們僅建議針對電子郵件使用此覆寫。

data-share-endpoint

未設定的供應商需要此屬性。

某些熱門供應商具有預先設定的分享端點。如需詳細資訊,請參閱「預先設定的供應商」章節。對於未設定的供應商,您需要指定分享端點。

data-param-*

所有 data-param-* 前綴屬性都會轉換為網址參數,並傳遞至分享端點。

aria-label

根據預設,aria-label 屬性會填入 Share by type,其中 'type' 是提供給元件的 type 屬性。如果傳遞至 aria-label 的值為非空值,則會覆寫預設值。

樣式

預設樣式

根據預設,amp-social-share 包含一些熱門的預先設定供應商。這些供應商的按鈕會以供應商的官方色彩和標誌設定樣式。預設寬度為 60 像素,預設高度為 44 像素。

請造訪 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 元素上的焦點指示器。第二個規則集指定紅色外框 (而非預設藍色),並將 outline-offset 設定為 3px,適用於具有類別 custom-focus 的所有 amp-social-share 元素。

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