Skip to content

mpat8121/capacitor-plugin-filesharer

Repository files navigation

FileSharer

Uses Capacitor 3.0

Capacitor plugin for Android and iOS that enables sharing of files


Maintainers

Maintainer GitHub Social
Mick Patterson mpat8121 @Mick_Patterson_
G. Starr g-starr

Install

npm install capacitor-plugin-filesharer
npm run build or ionic build
npx cap sync
npx cap add android
npx cap add ios

API

share(...)

share(opts: FileShareSingleOptions) => Promise<FileShareResult>

Open share activity card with an attached base64Data string

Param Type
opts FileShareSingleOptions

Returns: FileShareResult

Since: 1.0.0


shareMultiple(...)

shareMultiple(opts: FileShareMultiOptions) => Promise<FileShareResult>

Open share activity with multiple base64Data strings

Param Type
opts FileShareMultiOptions

Returns: FileShareResult

Since: 1.0.0


Interfaces

FileShareSingleOptions

Prop Type Description
header string Title of the share window popup

FileShareResult

Prop Type
result boolean
message string

FileShareMultiOptions

Prop Type Description
header string Title of the share window popup
files FileShareOptions[] Array of files for uploading

FileShareOptions

Prop Type Description
filename string Filename
base64Data string base64Data string
contentType string Content type using FileShareContentType of string for advanced types

Supported Methods

Name Android iOS Web
share
shareMultiple

Contributors


Mick Patterson

💻

Graham Starr

💻

This project follows the all-contributors specification. Contributions of any kind welcome!