DocumentPicker

API Reference: Device.DocumentPicker

DocumentPicker component allows you to select a file from your device to the application. While picking documents you can restrict the selection with following file types; Pdf, Audio, Image, Plain Text and All Files.

TypeScript code blocks include examples of how to implement, override and components within the theme. You can create page with the UI Editor to make your page compatible with theming and then you can implement themable components programmatically. Once the page is created with the UI Editor, it generates a class under scripts/generated/pages. You can then extend that class with the following TypeScript classes.

File selector:

Files are selected from file explorer/manager app. Please notice that if there is no file explorer app installed on the device, then the picker operation may fail.

TypeScript
JavaScript
TypeScript
import PageSampleDesign from 'generated/pages/pageSample';
import FlexLayout = require('sf-core/ui/flexlayout');
import Application = require('sf-core/application');
import Button = require('sf-core/ui/button');
import DocumentPicker = require("sf-core/device/documentpicker");
//You should create new Page from UI-Editor and extend with it.
export default class Sample extends PageSampleDesign {
myButton: Button;
constructor() {
super();
// Overrides super.onShow method
this.onShow = onShow.bind(this, this.onShow.bind(this));
// Overrides super.onLoad method
this.onLoad = onLoad.bind(this, this.onLoad.bind(this));
this.layout.flexDirection = FlexLayout.FlexDirection.COLUMN;
this.layout.justifyContent = FlexLayout.JustifyContent.CENTER;
this.layout.alignItems = FlexLayout.AlignItems.CENTER;
}
}
/**
* @event onShow
* This event is called when a page appears on the screen (everytime).
* @param {function} superOnShow super onShow function
* @param {Object} parameters passed from Router.go function
*/
function onShow(superOnShow: () => void) {
const { headerBar } = this;
superOnShow();
Application.statusBar.visible = false;
headerBar.visible = false;
}
/**
* @event onLoad
* This event is called once when page is created.
* @param {function} superOnLoad super onLoad function
*/
function onLoad(superOnLoad: () => void) {
superOnLoad();
this.myButton = new Button({
text: "Button",
onPress: () => {
DocumentPicker.pick({
page: this,
type: [DocumentPicker.Types.ALLFILES],
onSuccess: (file) => {
console.log("onSuccess : ", file.path);
},
onFailure: function () {
console.log("onFailure");
},
onCancel: () => {
console.log("onCancel");
}
});
}
});
this.layout.addChild(this.myButton, "myButton", ".sf-button", {
width: 100,
height: 50,
textColor: "#000000",
backgroundColor: "#00A1F1"
});
}
JavaScript
const Page = require("sf-core/ui/page");
const extend = require("js-base/core/extend");
const FlexLayout = require('sf-core/ui/flexlayout');
const Color = require('sf-core/ui/color');
const Button = require('sf-core/ui/button');
const DocumentPicker = require("sf-core/device/documentpicker");
var Page1 = extend(Page)(
function(_super) {
_super(this, {
onShow: function(params) {
this.headerBar.visible = false;
}
});
this.layout.flexDirection = FlexLayout.FlexDirection.ROW;
this.layout.justifyContent = FlexLayout.JustifyContent.CENTER;
this.layout.alignItems = FlexLayout.AlignItems.CENTER;
const page = this;
var myButton = new Button({
width: 100,
height: 50,
text: "Button",
textColor:Color.BLACK,
backgroundColor: Color.create("#00A1F1"),
onPress: function() {
DocumentPicker.pick({
page,
type: [DocumentPicker.Types.ALLFILES],
onSuccess: function (file) {
console.log("onSuccess : ",file.path);
},
onCancel: function () {
console.log("onCancel");
}
});
}
});
this.layout.addChild(myButton);
}
);
module.exports = Page1;