Share Files & Text with Other Apps

Use this component to share any files or text with apps on the device.

To get started using it, you must use KmpShare.

To share any plain text with any app, please use the following function

 KmpShare.shareTextWithAnyApp(text: String, optionalTitle: String = "")

In order to share files you must configure your file type. You can do so via method chaining like so:

KmpShare
     .setFileType(Mimes.csv)   // set the file type (Mimes is an object provided by KmpEssentials to simplify configuration)
     .shareFileWithAnyApp(filePath: String, optionalTitle: String = "")

Custom Intent Flags (Android Only)

You also have the option to add your own custom Intent Flags like so:

KmpShare
     .setFileType(Mimes.csv)
     .addOptionalFlags(Intent.ACTION_PICK)
     .shareFileWithAnyApp(filePath: String, optionalTitle: String = "")

If you want to reset this configuration, please use:

KmpShare
     .setFileType(Mimes.csv)
     .addOptionalFlags(Intent.ACTION_PICK)
    
      // resets and removes (Intent.ACTION_PICK) before showing the IntentChooser
     .resetOptionalFlags()
     .shareFileWithAnyApp(filePath: String, optionalTitle: String = "")

Android Setup

Before being able to share files you must configure the FileProvider that KmpEssentials requires to provide access to other apps, the files that you will be sharing with them.

In your manifest file please paste the following inside the application tag.

    <application
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <provider
            android:name="androidx.core.content.FileProvider"
            android:authorities="${applicationId}.fileprovider"
            android:grantUriPermissions="true"
            android:exported="false">
            <meta-data
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/file_paths" />
        </provider>
        ....
    </application>

You must also add an xml file inside the xml folder of your android resource directory. This file will be used by the file provider to scope and control which directories the external apps have access to when sharing files.

Because the url being passed into KmpEssentials can be anywhere or anything, you will need to configure the directories the file provider has access to. Here (as an example) we are providing access to external storage directory, scoped to the app's package Id.

This means the file provider will provide access to any app, to use any file used in this directory.

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-cache-path name="projection" path="." />
</paths>

For better security, it's better if you create a directory inside external storage (or the root directory you are configuring in the xml file), and specify that any app only has access to a specific subdirectory instead of the root directory. So for example, if I have a folder called devices inside my external storage directory scoped to my package, I would use:

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-cache-path name="projection" path="devices/" />
</paths>

Then only the files inside externalStorage/devices will be accessible to Sharing.

You can read more on the available directories of FileProvider here

iOS Setup

None required

Share Files & Text with Other Apps

Share Plain text​

Share Files​

Custom Intent Flags (Android Only)​

Android Setup​

iOS Setup​

Share Plain text

Share Files

Custom Intent Flags (Android Only)

Android Setup

iOS Setup