Git Product home page Git Product logo

capacitor-sharing's Introduction

Capacitor Sharing

Description

Provides a way to share one or more files at a time.

Installation

Capacitor 2

Capacitor 3

  • npm i capacitor-sharing

Usage

import { Plugins } from "@capacitor/core";

const { Sharing } = Plugins;

Sharing.share({
  fileNames: ["myImage.jpg", "myDocument.pdf", "myOtherImag.png"],
  base64Values: ["..."],
  contentType: "*/*",
}).then(
  () => {
    //your code
  },
  (error) => {
    console.log(error);
  }
);

Methods

Method Default Type Description
share(options: SharingOptions) Promise<any> Prompts the user with sharing options for the provided file(s)

Interfaces

SharingOptions

Properties Default Type Description
fileNames string[] Array containing the names of the files.
base64Values string[] Array containing the corresponding bas64 strings of the files.
mimeType? "*/*" string MIME type of the provided file. Define only when one file is provided.

Android

Gradle

Decalre AndroidX Core Library dependency in your apps build.gradle if not already declared:

dependencies {
  implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
}

or

dependencies {
  implementation "androidx.core:core:$core_version"
}

Manifest

Make sure you have the following provider in your app's Manifest.xml:

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

File Paths

If you not already created, create an xml folder with a file_paths.xml witht he following content:

<paths xmlns:android="http://schemas.android.com/apk/res/android">
  <files-path
    name="sharing_tmp"
    path="sharing_tmp/"/>
</paths>

capacitor-sharing's People

Contributors

epicshaggy avatar jmartinezehp avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

dmitryskripkin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.