Ioniconf 2022 logo

Uniting our global community of Ionic developers and contributors. May 25, 2022.



The Share API provides methods for sharing content in any sharing-enabled apps the user may have installed.

The Share API works on iOS, Android, and the Web (using the new Web Share API), though web support is currently spotty.


npm install @capacitor/share
npx cap sync


import { Share } from '@capacitor/share';

await Share.share({
  title: 'See cool stuff',
  text: 'Really awesome thing you need to see right meow',
  url: '',
  dialogTitle: 'Share with buddies',

Each platform uses a different set of fields, but you should supply them all.



canShare() => Promise<CanShareResult>

Check if sharing is supported.

Returns: Promise<CanShareResult>

Since: 1.1.0


share(options: ShareOptions) => Promise<ShareResult>

Show a Share modal for sharing content with other apps

Param Type
options ShareOptions

Returns: Promise<ShareResult>

Since: 1.0.0



Prop Type Description Since
value boolean Whether sharing is supported or not. 1.1.0


Prop Type Description Since
activityType string Identifier of the app that received the share action. Can be an empty string in some cases. On web it will be undefined. 1.0.0


Prop Type Description Since
title string Set a title for any message. This will be the subject if sharing to email 1.0.0
text string Set some text to share 1.0.0
url string Set a URL to share, can be http, https or file:// URL 1.0.0
dialogTitle string Set a title for the share modal. This option is only supported on Android. 1.0.0
<- Screen Reader
Splash Screen ->
Contribute ->