Web Share API

Web Share API 允许网站调用主机平台的本机共享功能的一种方法。

平常我们要分享网页的内容到其他应用,需要通过自己实现分享接口。而该 API 正是为了解决这个问题提出的,用于将数据(文本、URL、图像或文件)从 Web 共享到用户选择的应用程序。

该 API 不仅可以改善网页性能,只需要一个按钮,就可以实现多种分享方式,而且不限制分享目标的数量和类型。您平常使用分享的都可以使用到该 API,包括:社交媒体应用、电子邮件、即时消息、以及本地系统安装的、且接受分享的应用,都会出现在系统的分享弹窗,这对手机网页尤其有用

注意:Web Share API 只有通过 HTTPS 提供内容时才能使用。

以下是 Can I Use 给出 Web Share API 的支持情况:

Web Share API 支持情况

目前,支持程度相对较低,桌面的 Safari 浏览器,手机的安卓 Chrome、Firefox 浏览器和 iOS Safari 浏览器支持该 API。

基本用法

const sharePromise = navigator.share(data)

data 为要分享的数据的对象。至少需要指定以下一个字段。可选配置包括:

  • url —— 要分享的 URL。
  • text —— 要分享的文本内容。
  • title —— 要分享的标题。
  • files —— 要分享的文件。

在使用时,可以先检查本机系统是否支持该接口。在不支持 Web Share API 的情况下,navigator.share 方法为将返回 undefined

if (navigator.share) {
  // 支持
}

以下是一个简单的例子,展示了一个基本的共享操作。作为对按钮单击的响应,此 JavaScript 代码共享当前页面的 URL

const text = { 
  title: document.title, // 获取当前标题
  url: document.querySelector('link[rel=canonical]') ?
    document.querySelector('link[rel=canonical]').href : document.location.href, // 获取当前网站
  text: 'Hello World'
}

shareBtn.addEventListener('click', async () => {
  navigator.share(text)
    .then(() => {
      console.log('谢谢分享!')
    })
    .catch(err => {
      console.error('Error:', err)
    })
})

navigator.share 方法将会返回一个 Promise 对象。调用该方法后,会立即弹出系统的分享弹窗,一旦用户完成分享,这个 Promise 对象就会变为 resolved 状态。如果指定的共享数据格式不正确, promise 将会立即拒绝;如果用户取消了分享,promise 也会拒绝。

因为其返回的是 Promise 对象,所以也可以使用更简便的 async/await 方法

const text = {
  title: 'Web Share API',
  url:'https://www.jianshu.com/u/3f644e66afa3'
}

shareBtn.addEventListener('click', async () => {
  try {
    await navigator.share(text)
    console.log('已成功分享数据')
  } catch (err) {
    console.error('分享失败:', err.message)
  }
})

大致效果如下:

Chorme 浏览器
IOS Safari 浏览器

分享文件

上面介绍可选配置时,我们还看到了一个分享文件的 files 字段。

在分享文件之前,我们还需要使用 navigator.canShare() 方法,判断这个文件是可以否被分享。

注意:因为不是所有文件都允许分享的,目前只有图像,视频,音频和文本文件可以分享。

如果 navigator.canShare() 调用成功,将返回一个布尔值 true,表示该文件可以被分享。

const text = {
  files: filesArray,
  title: 'Picture',
  text:'I am Superman'
}

if (navigator.canShare && navigator.canShare({ files: filesArray })) {
  navigator.share(text)
    .then(() => console.log('分享成功'))
    .catch(err => console.log('分享失败', err))
} else {
  console.log('您的系统不支持共享文件。')
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,607评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,239评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,960评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,750评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,764评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,604评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,347评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,253评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,702评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,893评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,015评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,734评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,352评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,934评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,052评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,216评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,969评论 2 355

推荐阅读更多精彩内容