useShare

类别

Browser

导出体积

360 B

上次更改

2 months ago

响应式 Web Share API。浏览器提供了可以分享文本或文件内容的功能。

必须在用户操作 (如按钮点击) 之后调用 share 方法。不能在页面加载时简单地调用它。这是为了防止滥用而设定的。

Demo

source playground (beta)

用法

import { useShare
 } from '@vueuse/core'

const { share
, isSupported
 } = useShare
()

function startShare
() {
  share
({
    title
: 'Hello',
    text
: 'Hello my friend!',
    url
: location
.href
,
  })
}

传递源引用

你可以传递一个 ref，源引用的更改将反映到你的分享选项中。

TypeScript

import { ref
 } from 'vue'

const shareOptions
 = ref
<ShareOptions
>({ text
: 'foo' })
const { share
, isSupported
 } = useShare(shareOptions
)

shareOptions
.value.text = 'bar'

share
()

import { ref } from 'vue'
const shareOptions = ref({ text: 'foo' })
const { share, isSupported } = useShare(shareOptions)
shareOptions.value.text = 'bar'
share()

类型声明

export interface UseShareOptions {
  title
?: string
  files
?: File[]
  text
?: string
  url
?: string
}
/**
 * 响应式 Web Share API.
 * 浏览器提供了可以分享文本或文件内容的功能。
 *
 * @see https://vueuse.org/useShare
 * @param shareOptions
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useShare
(
  shareOptions
?: MaybeRefOrGetter
<UseShareOptions>,
  options
?: ConfigurableNavigator
,
): {
  isSupported
: ComputedRef
<boolean>
  share
: (overrideOptions
?: MaybeRefOrGetter
<UseShareOptions>) => Promise
<void>
}
export type UseShareReturn
 = ReturnType
<typeof useShare
>