useShare

v0.0.14testeddemo

Reactive Web Share API wrapper to invoke the native share sheet.

Examples

const { share, isSupported } = useShare({ title: 'Hello', url: location.href });
share();

// Override the default payload per call
const { share } = useShare({ title: 'Default' });
share({ text: 'One-off message' });

Loading demo…

export function useShare(
  shareOptions: MaybeRefOrGetter<UseShareOptions> ={ ... }

Parameter	Type	Default	Description
`shareOptions`?	`MaybeRefOrGetter<UseShareOptions>`	`{}`	Default share payload (title, text, url, files)
`options`?	`ConfigurableNavigator`	`{}`	Options

UseShareReturnisSupported flag and a share method

Property	Type	Default	Description
`isSupported`	`Readonly<Ref<boolean>>`	—	Whether the Web Share API is available
`share`	`(overrideData?: MaybeRefOrGetter<UseShareOptions>) => Promise<void>`	—	Invoke the native share sheet, optionally merging `overrideData` over the default share options. Resolves once sharing finishes (or is skipped when unsupported / the payload cannot be shared).