Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

nativescript-social-share

1.6.0 • Public • Published

NativeScript Social Share Plugin

A NativeScript plugin to use the native social sharing widget on Android and iOS. Currently this module supports image and text sharing.

Installation

Run the following command from the root of your project:

$ tns plugin add nativescript-social-share

This command automatically installs the necessary files, as well as stores nativescript-social-share as a dependency in your project's package.json file.

Usage

To use the social share module you must first require() it. After you require() the module you have access to its APIs.

// ------------ JavaScript ------------------
var SocialShare = require("nativescript-social-share");
 
// ------------- TypeScript ------------------
import * as SocialShare from "nativescript-social-share";

API

shareImage(ImageSource image, [optional] String subject)

The shareImage() method expects an ImageSource object. The code below loads an image from the app and invokes the share widget with it:

// ------------ JavaScript ------------------
var SocialShare = require("nativescript-social-share");
var imageSourceModule = require("image-source");
 
var image = imageSourceModule.fromFile("~/path/to/myImage.jpg");
SocialShare.shareImage(image);
 
// ------------- TypeScript ------------------
import * as SocialShare from "nativescript-social-share";
import { ImageSource } from "image-source";
 
let image = ImageSource.fromFile("~/path/to/myImage.jpg");
SocialShare.shareImage(image);

You can optionally provide a second argument to configure the subject on Android:

SocialShare.shareImage(image, "How would you like to share this image?");

shareText(String text, [optional] String subject)

The shareText() method expects a simple string:

SocialShare.shareText("I love NativeScript!");

Like shareImage(), you can optionally pass shareText() a second argument to configure the subject on Android:

SocialShare.shareText("I love NativeScript!", "How would you like to share this text?");

shareUrl(String url, String text, [optional] String subject)

The shareUrl() method excepts a url and a string.

SocialShare.shareUrl("https://www.nativescript.org/", "Home of NativeScript");

You can optionally pass shareUrl() a second argument to configure the subject on Android:

SocialShare.shareUrl("https://www.nativescript.org/", "Home of NativeScript", "How would you like to share this url?");

Tutorials

Looking for some extra help getting social sharing working in your mobile application? Check out these resources:

Install

npm i nativescript-social-share

DownloadsWeekly Downloads

3,430

Version

1.6.0

License

MIT

Unpacked Size

14 kB

Total Files

10

Last publish

Collaborators

  • avatar
  • avatar