romone183-capacitor-share v1.0.0

romone183-capacitor-share

This plugin handles sharing both file and text via WhatsApp on iOS.

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.

Install

npm install romone183-capacitor-share
npx cap sync

Android

By default, Capacitor apps only allow to share files from caches folder. To make other Android folders shareable, they have to be added in android/app/src/main/res/xml/file_paths.xml file. Check the Specifying Available Files section in FileProvider docs for the available locations.

Example

import { Share } from 'romone183-capacitor-share';

await Share.share({
  title: 'See cool stuff',
  text: 'Really awesome thing you need to see right meow',
  url: 'http://ionicframework.com/',
  dialogTitle: 'Share with buddies',
});

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

Configuration

These config values are available:

Examples

In capacitor.config.json:

{
  "plugins": {
    "Share": {
      "whatsAppStep1Msg": "WhatsApp can't share both File and Text. Step 1: Share File",
      "whatsAppStep2Msg": "Step 2: Share Text"
    }
  }
}

In capacitor.config.ts:

/// <reference types="@capacitor/share" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    Share: {
      whatsAppStep1Msg: "WhatsApp can't share both File and Text. Step 1: Share File",
      whatsAppStep2Msg: "Step 2: Share Text",
    },
  },
};

export default config;

API

• canShare()
• share(...)
• Interfaces

canShare()

canShare() => Promise<CanShareResult>

Check if sharing is supported.

Returns: Promise<CanShareResult>

Since: 1.0.0

share(...)

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

Show a Share modal for sharing content with other apps

Returns: Promise<ShareResult>

Since: 1.0.0

Interfaces

CanShareResult

ShareResult

ShareOptions