@nativescript-community/ui-share-file
Version:
Send/share file to other apps.
93 lines (61 loc) • 2.08 kB
Markdown
# Nativescript Share File
Send/Share files to other apps.
Android Intent, IOS InteractionController:
<img src="https://github.com/nativescript-community/ui-share-file/blob/master/preview/preview-android.png?raw=true" width="250"> . <img src="https://github.com/nativescript-community/ui-share-file/blob/master/preview/preview-ios.png?raw=true" width="250">
## Installation
Install the plugin in your app.
~~~
npm install @nativescript-community/ui-share-file
~~~
## Usage
Info: Shared files should be in the `documents` path.
```TypeScript
import { ShareFile } from '@nativescript-community/ui-share-file';
import * as fs from '@nativescript/core/file-system';
export class TestClass{
shareFile;
fileName;
documents;
path;
file;
constructor() {
this.fileName = 'text.txt';
this.documents = fs.knownFolders.documents();
this.path = fs.path.join(this.documents.path, this.fileName);
this.file = fs.File.fromPath(this.path);
this.shareFile = new ShareFile();
this.shareFile.open( {
path: this.path,
title: 'Open text file with:', // optional Android
rect: { // optional iPad
x: 110,
y: 110,
width: 0,
height: 0
},
options: true, // optional iOS
animated: true // optional iOS
});
}
}
```
### Arguments
#### path
Path to the file which will be shared.
`String`: Required
#### title
Title for the intent on Android.
`String`: (Optional)
Default: `Open file:`.
#### rect
Positioning the view for iPads. On iPhones it's always shown on the bottom.
`Object`: (Optional)
Default: `{x: 0, y: 0, width: 0, height: 0 }`.
#### options
Show additional opening options for iOS devices.
`Boolean`: (Optional)
Default: `false`.
#### animated
Opening animation for iOS devices.
`Boolean`: (Optional)
Default: `false`.