Picker Configuration Schema

This outlines the full schema available to configure the picker. These options are passed as shown in the samples.

{
   sdk: "8.0";
   /**
    * Establishes the messaging parameters used to setup the post message communications between
    * picker and host application
    */
   messaging: {
      /**
       * A unique id assigned by the host app to this File Picker instance.
       */
      channelId: string;
      /**
       * The host app's authority, used as the target origin for post-messaging.
       */
      origin: string;
   };
   /**
    * Configuration for the entry location to which the File Picker will navigate on load.
    * The File Picker app will prioritize path-based navigation if provided, falling back to other address forms
    * on error (in case of Site redirection or content rename) or if path information is not provided.
    */
   entry: {
      sharePoint?: {
         /**
         * Specify an exact SharePoint content location by path segments.
         */
         byPath?: {
            /**
             * Full URL to the root of a Web, or server-relative URL.
             * @example
             *  'https://contoso-my.sharepoint.com/personal/user_contoso_com'
             * @example
             *  '/path/to/web'
             * @example
             *  'subweb'
             */
            web?: string;
            /**
             * Full URL or path segement to identity a List.
             * If not preceded with a `/` or a URL scheme, this is assumed to be a list in the specified web.
             * @example
             *  'Shared Documents'
             * @example
             *  '/path/to/web/Shared Documents'
             * @example
             *  'https://contoso.sharepoint.com/path/to/web/Shared Documents'
             */
            list?: string;
            /**
             * Path segment to a folder within a list, or a server-relative URL to a folder.
             * @example
             *  'General'
             * @example
             *  'foo/bar'
             * @example
             *  '/path/to/web/Shared Documents/General'
             */
            folder?: string;
         };
      };
      /**
       * Indicates that the File Picker should start in the user's OneDrive.
       */
      oneDrive?: {
         /**
         * Indicates that File Picker should start in the user's recent files.
         */
         recent?: {};
         /**
         * Specifies that File Picker should start in the user's Files tab.
         */
         files?: {
            /**
             * Path segment for sub-folder within the user's OneDrive.
             * @example
             *  'Pictures'
             * @example
             *  '/personal/user_contoso_com/Documents/Attachments'
             */
            folder?: string;
         }
      };
   };
   /**
    * Specifies how to enable a Search behavior.
    */ 
   search?: {
      enabled: boolean;
   },
   /**
    * Providing this object indicates that the host app can provide OAuth tokens
    * via the existing messaging support.
    */
   authentication: {};
   /**
    * Specifies what types of items may be picked and where they come from. Support for these features is inconsistent currently for external applications.
    */
   typesAndSources?: {
      /**
       * Specifies the general category of items picked. Switches between 'file' vs. 'folder' picker mode,
       * or a general-purpose picker.
       * @default 'all'
       */
      mode?: "files" | "folders" | "all";
      /**
       * Set of file extensions or 'item types'.
       * File extensions should be lower-case and prefixed with a `.`.
       * Item types should be lowercase and come from the following set:
       * 
       * - photo
       * - video
       * - audio
       * - folder
       * - file
       * 
       * @default `['folder']` if `itemTypes` is 'folders', otherwise `[]`
       */
      filters?: string[];
      /**
       * Configures whether or not specific pivots may be browsed for content by the user.
       */
      pivots?: {
         recent?: boolean;
         oneDrive?: boolean;
         sharedLibraries?: boolean;
      };
   };
   /**
    * Specified how many items may be picked.
    */
   selection?: {
      /**
       * @default 'single'
       */
      mode?: "single" | "multiple" | "pick";
   };
   /**
    * Specifies what happens when users pick files and what the user may do with files in the picker.
    */
   commands?: {
      /**
       * Sets the default 'pick' behavior once the user selects items.
       */
      pick?: {
         /**
         * A custom label to apply to the button to pick the items.
         * The default varies based on `action`, but is typically 'Select'.
         * This string must be localized if provided.
         */
         label?: string;
      };
      close?: {
         /**
         * A custom label to apply to the button to close the picker.
         * The default is 'Cancel'.
         * This string must be localized if provided.
         */
         label?: string;
      };
   };
   /**
    * Specifies accessibility cues such as auto-focus behaviors.
    */
   accessibility?: {
      /**
       * The File Picker can provide a 'tab-loop' behavior within its frame or window.
       */
      enableFocusTrap?: boolean;
      /**
       * The File Picker can automatically grab focus once it loads.
       */
      trapFocusOnLoad?: boolean;
      /**
       * By default, the File Picker does not initialally highlight the focused elements,
       * but does so once a user starts using the keyboard. Set this option to force
       * an initial highlight.
       */
      showFocusOnLoad?: boolean;
   };
   tray?: {
      /**
      * Configures a component to render in the picker tray to the left of the commands.
      * @default 'selection-summary'
      */
      prompt?: "selection-summary" | "save-as";
      /**
      * Configures use of the 'save-as' prompt.
      */
      saveAs?: {
         /**
          * Default file name to show in 'save-as' prompt.
          */
         fileName?: string;
      };
   };
}