@capawesome-team/capacitor-file-opener

Capacitor plugin to open a file with the default application.

Features

We are proud to offer one of the most complete and feature-rich Capacitor plugins for opening files. Here are some of the key features:

• 🖥️ Cross-platform: Supports Android, iOS, and Web.
• 📄 Multiple file formats: Open various file types with their default applications.
• 🌐 Web support: Open files using Blob objects on Web platform.
• 📱 Native integration: Uses system file associations on mobile platforms.
• 📁 Flexible paths: Support for file paths and content URIs on Android.
• 🔍 MIME type detection: Automatic MIME type detection or manual specification.
• 🔁 Up-to-date: Always supports the latest Capacitor version.

Missing a feature? Just open an issue and we'll take a look!

Newsletter

Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our Capawesome Newsletter.

Compatibility

| Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | >=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated |

Installation

npm install @capawesome-team/capacitor-file-opener
npx cap sync

Android

You need to specify the directories that contain the files you want to open. To do this, create a new file named file_paths.xml in the res/xml directory of your Android project (e.g. android/app/src/main/res/xml/file_paths.xml). Here is an example of the content of the file:

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="files" path="." />
    <cache-path name="cache" path="." />
    <external-files-path name="external-files" path="." />
    <external-cache-path name="external-cache" path="." />
    <external-path name="external" path="." />
</paths>

More information can be found in the Android documentation.

Variables

If needed, you can define the following project variable in your app’s variables.gradle file to change the default version of the dependency:

• $androidxDocumentFileVersion version of androidx.documentfile:documentfile (default: 1.1.0)

This can be useful if you encounter dependency conflicts with other plugins in your project.

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

| Android | iOS | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | | |

Usage

import { FileOpener } from '@capawesome-team/capacitor-file-opener';

const open = async () => {
  await FileOpener.openFile({
    path: 'content://com.android.providers.downloads.documents/document/msf%3A1000000073',
  });
};

API

• openFile(...)
• Interfaces

openFile(...)

openFile(options: OpenFileOptions) => Promise<void>

Open a file with the default application.

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | OpenFileOptions |

Since: 0.0.1

Interfaces

OpenFileOptions

| Prop | Type | Description | Since | | -------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------- | ----- | | blob | Blob | The blob instance of the file to open. Only available on Web. | 6.1.0 | | path | string | The path of the file. Only available on Android and iOS. | 0.0.1 | | mimeType | string | The mime type of the file. If not specified, the mime type will be determined. Only available on Android and iOS. | 0.0.1 |

Changelog

See CHANGELOG.md.

License

See LICENSE.