Merge branch 'dev' of https://github.com/siata13/sp-dev-fx-controls-react into siata13-dev

Author: estruyf

docs/documentation/docs/assets/FilePickerBreadcrumb.gif

@@ -0,0 +1,90 @@
+# FilePicker control
+
+File picker control allows to browse and select a file from various places.
+Currently supported locations
+- Recent files - tab allows to select a file from recently modified files based on the search results.
+- Web search - tab uses Bing cognitive services to look for a file. (Only images)
+- OneDrive - tab allows to select a file from the user's One Drive.
+- Site document libraries - tab allows to select a file from the existing site document libraries.
+- Upload - tab allows to upload a file from local drive.
+- From a link - tab allows to paste a link to the document.
+
+## Overview
+The control supports all types of file, however it also allows to specify list of extensions for the files that are going to be looked displayed. Currently, only single file selection is supported. 
+![File Picker overview](../assets/FilePickerOverview.png)
+
+
+## Different display types
+File picker support 3 types of views : List, Compact list and Tiles. In case Tiles view is selected, the control shows the thumbnail of the file.
+![File Picker views](../assets/FilePickerViews.gif)
+
+
+## Breadcrumb support
+The control displays breadcrumb navigation that allows to easily switch folders or document libraries.
+![File Picker breadcrumb](../assets/FilePickerBreadcrumb.gif)
+
+## Paged data load
+File picker doesn't load all the files that exist in the folder. Instead, it allows to specify how many results are loaded in a batch, and executes paged requests when new data is required.
+![File Picker paged data load](../assets/FilePickerPaging.gif)
+
+
+## How to use this control
+
+- Check that you installed the `@pnp/spfx-controls-react` dependency. Check out the [getting started](../#getting-started) page for more information about installing the dependency.
+- Import the following module to your component:
+
+```TypeScript
+import { FilePicker, IFilePickerResult } from '@pnp/spfx-controls-react/lib/FilePicker';
+```
+
+- Use the `FilePicker` control in your code as follows:
+
+```TypeScript
+<FilePicker
+  bingAPIKey="<BING API KEY>"
+  accepts= ".gif,.jpg,.jpeg,.bmp,.dib,.tif,.tiff,.ico,.png,.jxr,.svg"
+  buttonIcon="FileImage"
+  onSave={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
+  onChanged={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
+  webPartContext={this.props.context}
+/>
+```
+
+## Implementation
+
+The FilePicker component can be configured with the following properties:
+
+| Property | Type | Required | Description |
+| ---- | ---- | ---- | ---- |
+| label | string | no | Specifies the text describing the file picker. |
+| buttonLabel | string | no | Specifies the label of the file picker button. |
+| buttonIcon | string | no | In case it is provided the file picker will be rendered as an action button. |
+| onSave | (filePickerResult: IFilePickerResult) => void | yes | Handler when the file has been selected and picker has been closed. |
+| onChange | (filePickerResult: IFilePickerResult) => void | yes | Handler when the file selection has been changed. |
+| webPartContext | WebPartContext | yes | Current context. |
+| accepts | string[] | no | Array of strings containing allowed files extensions. E.g. [".gif", ".jpg", ".jpeg", ".bmp", ".dib", ".tif", ".tiff", ".ico", ".png", ".jxr", ".svg"] |
+| required | boolean | no | Sets the label to inform that the value is required. |
+| bingAPIKey | string | no | Used to execute WebSearch. If not provided SearchTab will not be available. |
+| disabled | boolean | no | Specifies if the picker button is disabled |
+| itemsCountQueryLimit | number | no | Number of items to obtain when executing REST queries. Default 100. |
+| hideRecentTab | boolean | no | Specifies if RecentTab should be hidden. |
+| hideWebSearchTab | boolean | no | Specifies if WebSearchTab should be hidden. |
+| hideOrganisationalAssetTab | boolean | no | Specifies if OrganisationalAssetTab should be hidden. |
+| hideOneDriveTab | boolean | no | Specifies if OneDriveTab should be hidden. |
+| hideSiteFilesTab | boolean | no | Specifies if SiteFilesTab should be hidden. |
+| hideLocalUploadTab | boolean | no | Specifies if LocalUploadTab should be hidden. |
+| hideLinkUploadTab | boolean | no | Specifies if LinkUploadTab should be hidden. |
+
+interface `IFilePickerResult`
+
+Provides options for carousel buttons location.
+
+| Value | Description |
+| ---- | ---- |
+| fileName | string | yes | File namr of the result with the extension. |
+| fileNameWithoutExtension | string | yes | File namr of the result without the extension. |
+| fileAbsoluteUrl | string | yes | Absolute URL of the file. Null in case of file upload. |
+| file | File | yes | JS Object representing File. Will be set in case of file upload. |
+
+
+![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/filePicker/FilePicker)

docs/documentation/docs/assets/FilePickerOverview.png

@@ -0,0 +1 @@
+export * from "./controls/filePicker/index";

docs/documentation/docs/assets/FilePickerPaging.gif

@@ -6,6 +6,8 @@ import * as _ from '@microsoft/sp-lodash-subset';
 
 import * as strings from 'ControlStrings';
 
+export const IMG_SUPPORTED_EXTENSIONS = ".gif,.jpg,.jpeg,.bmp,.dib,.tif,.tiff,.ico,.png,.jxr,.svg";
+
 /**
  * Helper with general methods to simplify some routines
  */
@@ -217,6 +219,82 @@ export class GeneralHelper {
         return xml;
     }
 
+    /**
+     * Returns absoulute domain URL.
+     * @param url
+     */
+    public static getAbsoluteDomainUrl(url: string): string  {
+      if (url !== undefined) {
+        const myURL = new URL(url.toLowerCase());
+        return myURL.protocol + "//" + myURL.host;
+      } else {
+        return undefined;
+      }
+    }
+
+    public static formatBytes(bytes, decimals) {
+      if (bytes == 0) {
+        return strings.EmptyFileSize;
+      }
+
+      const k: number = 1024;
+      const dm = decimals <= 0 ? 0 : decimals || 2;
+      const i = Math.floor(Math.log(bytes) / Math.log(k));
+      return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + strings.SizeUnit[i];
+    }
+
+    /**
+     * Returns file name without extension.
+     */
+    public static getFileNameWithoutExtension(itemUrl : string) {
+      const fileNameWithExtension = GeneralHelper.getFileNameFromUrl(itemUrl);
+      const fileNameTokens = fileNameWithExtension.split(".");
+      const fileName = fileNameTokens[0];
+
+      return fileName;
+    }
+
+    /**
+     * Returns file name with the extension
+     */
+    public static getFileNameFromUrl(itemUrl : string) {
+      const urlTokens = itemUrl.split("?");
+      const url = urlTokens[0];
+      const tokens = url.split("/");
+      const fileNameWithExtension = tokens[tokens.length - 1];
+
+      return fileNameWithExtension;
+    }
+
+    public static isImage(fileName: string): boolean {
+      const acceptableExtensions: string[] = IMG_SUPPORTED_EXTENSIONS.split(",");
+      // const IMG_SUPPORTED_EXTENSIONS = ".gif,.jpg,.jpeg,.bmp,.dib,.tif,.tiff,.ico,.png,.jxr,.svg"
+
+      const thisExtension: string = GeneralHelper.getFileExtension(fileName);
+      return acceptableExtensions.indexOf(thisExtension) > -1;
+    }
+
+    /**
+     * Returns extension of the file
+     */
+    public static getFileExtension(fileName): string {
+
+      // Split the URL on the dots
+      const splitFileName = fileName.toLowerCase().split('.');
+
+      // Take the last value
+      let extensionValue = splitFileName.pop();
+
+      // Check if there are query string params in place
+      if (extensionValue.indexOf('?') !== -1) {
+        // Split the string on the question mark and return the first part
+        const querySplit = extensionValue.split('?');
+        extensionValue = querySplit[0];
+      }
+
+      return `.${extensionValue}`;
+    }
+
     private static _getEncodedChar(c): string {
         const o = {
             "<": "&lt;",
@@ -228,4 +306,4 @@ export class GeneralHelper {
         };
         return o[c];
     }
-}
+}