Tauri Plugin sharetarget

A plugin for Tauri applications to appear as a share target under Android. Desktop OSes are unsupported (they lack the feature). Behaviour on iOs is indeterminate.

Installation

In src-tauri/Cargo.toml :

1[dependencies]
2tauri-plugin-sharetarget = "LATEST_VERSION_HERE"

In src-tauri/src/lib.rs, add the plugin entry :

1#[cfg_attr(mobile, tauri::mobile_entry_point)]
2pub fn run() {
3    tauri::Builder::default()
4        .plugin(tauri_plugin_sharetarget::init())
5        .run(tauri::generate_context!())
6        .expect("error while running tauri application");
7}

To build for Android, you must first tauri android init successfully. This gets some files generated. To signal your app as a share target to Android, you then need to modify your AndroidManifest.xml. In src-tauri/gen/android/app/src/main/AndroidManifest.xml, add your intent-filters :

1<?xml version="1.0" encoding="utf-8">
2<manifest ...>
3    ...
4    <application ...>
5        ...
6        <activity ...>
7            <intent-filter>
8                <!-- Support receiving share events. -->
9                <action android:name="android.intent.action.SEND" />
10                <category android:name="android.intent.category.DEFAULT" />
11                <!-- You can scope any MIME type here. You'll see what Intent Android returns. -->
12                <data android:mimeType="text/*" />
13            </intent-filter>
14        </activity ...>
15        ...

Permissions

First you need permissions in tauri, just to get ipc events in javascript. In src-tauri/capabilities/default.json, add sharetarget to the permissions :

1{
2    "$schema": "../gen/schemas/desktop-schema.json",
3    "identifier": "anything_you_like",
4    "windows": ["main"],
5    "permissions": [
6        ...
7        "sharetarget:default"
8    ]
9}

Usage

Use the provided API in javascript/typescript. For example in React, in src/main.tsx :

1import { useEffect, useState } from 'react';
2import { listenForShareEvents, type ShareEvent } from 'tauri-plugin-sharetarget-api';
3import { PluginListener } from '@tauri-apps/api/core';
4
5function App() {
6    const [logs, setLogs] = useState('');
7    useEffect(() => {
8        let listener: PluginListener;
9        const setupListener = async () => {
10            listener = await listenForShareEvents((intent: ShareEvent) => {
11                setLogs(intent.uri);
12            });
13        };
14        return () => { listener?.unregister(); };
15    };
16    return (<>
17        <h3>Share this</h3>
18        <p>{ logs }</p>
19        <button onClick={ yourCallbackFunction }>share</button>
20    </>);
21}

Receive attached stream (images, etc)

To receive shared images, you need

• an intent targeting image/*
• @tauri-apps/plugin-fs in package.json dependencies to read the sent data
• fs:default in the capabilities of your app
• in javascript, use readFile() from @tauri-apps/plugin-fs on the intent's stream.

Here is the previous example revamped to fetch binary contents. Upload({ file }) is not implemented because users may do whatever they like with the File object. This just showcases how to grab the binary data.

1import { useEffect, useState } from 'react';
2import { listenForShareEvents, type ShareEvent } from 'tauri-plugin-sharetarget-api';
3import { PluginListener } from '@tauri-apps/api/core';
4import { readFile } from '@tauri-apps/plugin-fs';
5
6function App() {
7    const [logs, setLogs] = useState('');
8    const [file, setFile] = useState<File>();
9    useEffect(() => {
10        let listener: PluginListener;
11        const setupListener = async () => {
12            listener = await listenForShareEvents(async (intent: ShareEvent) => {
13                if(event.stream) {
14                    const contents = await readFile(intent.stream).catch((error: Error) => {
15                        console.warn('fetching shared content failed:');
16                        throw error;
17                    });
18                    setFile(new File([contents], intent.name, { type: intent.content_type }));
19                } else {
20                    // This intent contains no binary bundle.
21                    console.warn('unused share intent', intent.uri);
22                }
23                setLogs(intent.uri);
24            });
25        };
26        setupListener();
27        return () => { listener?.unregister(); };
28    };
29    return (<>
30        <h3>Sharing { intent.name }</h3>
31        <Upload file={ file } />
32    </>);
33}

Caveats

Unfortunately, multiple files in a single share intent are not supported right now. iOs is also unsupported - I don't have the platform. PRs welcome !