@nativescript/social-share

``cli
npm install @nativescript/social-share
`

Usage

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

`JavaScript
// ------------ JavaScript ------------------
var SocialShare = require("@nativescript/social-share");

// ------------- TypeScript ------------------
import * as SocialShare from "@nativescript/social-share";
`

API

$3

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

`JavaScript
// ------------ JavaScript ------------------
var SocialShare = require("@nativescript/social-share");
var imageSourceModule = require("@nativescript/core");

var image = imageSourceModule.fromFile("~/path/to/myImage.jpg");
SocialShare.shareImage(image);

// ------------- TypeScript ------------------
import * as SocialShare from "@nativescript/social-share";
import { ImageSource } from "@nativescript/core";

let image = ImageSource.fromFile("~/path/to/myImage.jpg");
SocialShare.shareImage(image);
`

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

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

$3

The shareText() method expects a simple string:

`js
SocialShare.shareText('I love NativeScript!')
`

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

`js
SocialShare.shareText('I love NativeScript!', 'How would you like to share this text?')
`

$3

The sharePdf() method expects a File instance:

`js
let pdf = File.fromPath("~/path/to/myPdf.pdf");
SocialShare.sharePdf(pdf)
`

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

`js
SocialShare.sharePdf(pdf, 'How would you like to share this text?')
`

$3

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

`js
SocialShare.shareUrl('https://www.nativescript.org/', 'Home of NativeScript')
`

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

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

$3

Share text or url via Twitter.

`js
SocialShare.shareViaTwitter('Home of NativeScript', 'https://www.nativescript.org/')
`

$3

Share url via Facebook. Note that text will usually be suppressed due to Facebook security/abuse prevention, but the url will come through.

`js
SocialShare.shareViaFacebook('Home of NativeScript', 'https://www.nativescript.org/')
`

- Android Only NOTE:

If you are already using the Facebook Share SDK in your project you likely do _not_ have to add the following.

If you are not using the sdk explicitly in your project yet, add to your app.gradle:

`
dependencies {
implementation 'com.facebook.android:facebook-share:5,6)'
}
`

- Add a meta-data section and provider section ot your AndroidManifest.xml so it becomes similar to this:

`xml

xmlns:tools="http://schemas.android.com/tools"
...>
android:name="com.tns.NativeScriptApplication"
..>

android:name="com.facebook.FacebookContentProvider"
android:exported="true"
tools:replace="android:authorities"/>

android:name="com.tns.NativeScriptActivity"
..>
`

- Create a file facebooklogin.xml in App_Resources/Android/src/main/res/values/. Add this to the file (replace the id):

`xml


126035687816994

``

Tutorials

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

- [Social Media Sharing in a Vanilla NativeScript Application
- Social Media Sharing in a NativeScript with Angular Application

License

Apache License Version 2.0