@kloudless/file-explorer NPM

Kloudless File Explorer

Sign up for a free account at https://kloudless.com to obtain a Kloudless App ID to initialize the File Explorer with. The File Explorer is built on our unified Storage API abstraction layer (Cloud Storage REST API docs here).

The Kloudless File Explorer is a JavaScript library that allows your users to browse and select files and folders from the following storage services:

Click here to visit our File Explorer demo!

Usage

Initializing a File Explorer

The File Explorer JavaScript library can be imported into web applications and launched when a user clicks an element.

Import from a script tag

Include the Kloudless File Explorer JavaScript library on your HTML page using a script tag that points to our CDN:

<script type="text/javascript"
 src="https://static-cdn.kloudless.com/p/platform/sdk/kloudless.explorer.js"></script>

This exposes a global Kloudless.fileExplorer object you can use to initialize a File Explorer. Check out the Configuration Options section further below for a full list of configuration options.

<script type="text/javascript">
  var explorer = window.Kloudless.fileExplorer.explorer({
    // Explorer Initialization options here.
    app_id: "Your App ID", // Get your own at https://kloudless.com
  });
</script>

Import from an ES6 module

You can also install the File Explorer package from NPM:

npm install @kloudless/file-explorer

import fileExplorer from '@kloudless/file-explorer';

const explorer = fileExplorer.explorer({
  app_id: "YOUR_APP_ID"
});

Launching the Explorer

Here is a basic example of a button that launches the File Explorer given the JavaScript above that creates an explorer object.

<body>
  <button id="choose-files">Choose Files</button>

  <script src="https://static-cdn.kloudless.com/p/platform/sdk/kloudless.explorer.js"></script>
  <script>
    var explorer = window.Kloudless.fileExplorer.explorer({ app_id: "APP_ID" });
    explorer.choosify(document.getElementById('choose-files'));
  </script>
</body>

The HTML above adds a specific id to an element so that we can reference it later in our JavaScript that launches the File Explorer when the element is clicked. A more complete example is present below after the full list of configuration options as well as on our demo page.

Be sure to serve the page via a web server, as pages opened via the file URI scheme (file://) cannot receive postMessage messages from the iframe created to display the File Explorer due to security concerns.

File Explorer Modes

The File Explorer can be configured to either be a file chooser to select files and folders from cloud storage or the local computer, or a file saver to export a specific file to cloud storage.

Chooser

The Chooser allows your application to prompt a user to select files or a folder, and retrieves metadata about the files or folder selected. It supports choosing files from the local machine as well as cloud storage. Your application can also upload files to users' cloud storage using the Upload API endpoint after prompting users to select a folder to upload data to.

The Chooser is therefore a popular option for both importing files to your application as well as exporting them to specific destinations in cloud storage.

Dropzone

The Dropzone is a variety of the Chooser that opens when files are dragged and dropped into it rather than only when clicked. See the Dropzone section for more information.

Saver

The Saver allows your application to prompt a user to select a folder to save a specific file to. This lets your application save some work over the Chooser by automatically handling the upload to cloud storage given a link to the file. However, only a single file is supported at a time.

The Saver returns metadata on the newly uploaded file to the application.

Configuration

The File Explorer has several configuration options. Below, we've included options that can be set on the library inclusion tag itself, options that apply to both the Chooser and Saver modes, and options that are specific to a particular mode.

Script tag

The following attributes can be set on the <script> tag used to include the File Explorer JavaScript on the page.

data-kloudless-object : string
Optional. By default, the fileExplorer object will be exposed to window.Kloudless.fileExplorer.
Specifies a different name for the fileExplorer object bound to window. e.g. data-kloudless-object="fileExplorer2" would make the fileExplorer object accessible via window.fileExplorer2. Do not use the async attribute on the script tag if this is used.

Chooser and Saver

app_id : string
Chooser: Required
Saver: Required
The application ID is specific to the developer's application and is located in the developer portal on the App Details page.
retrieve_token : boolean
Chooser: Optional (default: false)
Saver: Optional (default: false)
This option will include Bearer Tokens in addition to the other response data, to allow you to make further requests to the API or save the OAuth Tokens for future use.
```
// Example response with an OAuth Token in the metadata.
[{
  bearer_token: {
    key: "the_token",
  },
  ...
}]
```
Only File Explorers launched from Trusted Domains can make use of this option. You can add a Trusted Domain on the App Details page.
In addition, care should be taken to ensure no malicious JavaScript or XSS vulnerabilities are present on the page, as the Bearer Token provides complete access to that user's account.
persist : string
Chooser: "none", "local", "session" (default: "local")
Saver: "none", "local", "session" (default: "local")
This option specifies account persistence for the explorer in either localStorage, sessionStorage, or no storage. The explorer will always fall back to localStorage if an invalid option is given.
services : array
Chooser: Optional (default: 'file_store')
Saver: Optional (default: 'file_store')
This option specifies which services to allow a user to explore. You can enumerate the specific services or use a service group listed below as a shortcut. The default is the file_store service group. If you specify an empty array, no services will show up.
Service groups:
- file_store: All File Storage services.
- object_store: All Object Storage services.
- construction: All Construction services.
- all: All storage services.
account_management : boolean
Chooser: Optional (default: true)
Saver: Optional (default: true)
If false, hides the Account menu entry in the dropdown. This can be combined with the tokens option to ensure a user only browses a pre-defined list of accounts and also does not disconnect any of the accounts. If account disconnection is permitted, set services to [] rather than disabling the account_management option.
display_backdrop : boolean
Chooser: Optional (default: false)
Saver: Optional (default: false)
If true, displays a shadow backdrop behind the File Explorer, and prevents the page body from scrolling.
custom_css : string
Chooser: Optional (default: null)
Saver: Optional (default: null)
An optional stylesheet URL to load to override existing styles. Supports (http|https)://domain.com/path/to.css, //domain.com/path/to.css, and /path/to.css formats.
The domain the File Explorer is launched from must be added to the application's list of Trusted Domains for the custom_css property to be used.
locale : string
Chooser: Optional (default: "en")
Saver: Optional (default: "en")
The Kloudless File Explorer supports i18n/l10n. You can specify any of the following ISO-639-1 codes:
ar, az, bs, cs, cy, da, de, el, en, es, et, fa, fi, fr, he, hr, hu, hy, id, it, ja, ka, kk, km, ko, lt, lv, mn, ms, nl, pl, pt, ro, ru, sk, sq, sr, sr, sv, th, tr, uk, zh-CN, zh-TW
The locale is used to identify the data to retrieve from either the data provided in the translations option below or from the out-of-the-box translation data in the messages directory. If no translation data is found, the File Explorer uses the en locale.
translations : string or object
Chooser: Optional (default: "")
Saver: Optional (default: "")
This option specifies either an object with translation data or a URL that returns the translation data as a JSON string. The locale option indicates which locale's translation data to use. Any translation data provided here overrides Kloudless' default translation data included in the messages directory. See translations-suite-sample.json for an example of the translation file format. Any strings not translated will default to the en locale's representation.
dateTimeFormat : string
Chooser: Optional (default: "MMMdHm")
Saver: Optional (default: "MMMdHm")
This option specifies a date-time format for the locale above. Please refer to the skeleton values in the globalize JS module for the formats supported.
create_folder : boolean
Chooser: Optional (default: true)
Saver: Optional (default: true)
If true, the user will be able to create folders in their cloud storage accounts.
account_key : boolean
This option is deprecated as OAuth 2.0 Tokens are used to authenticated accounts now instead of Account Keys. Please use the retrieve_token option below instead. Existing Account Keys can be converted to OAuth Tokens using this endpoint.
keys : array
This option is deprecated as OAuth 2.0 Tokens are used to authenticated accounts now instead of Account Keys. Please use the tokens option below instead. Existing Account Keys can be converted to OAuth Tokens using this endpoint.
tokens : array
Chooser: Optional (default: [])
Saver: Optional (default: [])
This option should list OAuth 2.0 Tokens for accounts the File Explorer should be initialized with. The File Explorer will make API requests for additional information on the accounts and display them in the list of accounts the user has connected.
```
{
  tokens: ["abcdefghijklmn", "opqrstuvwxyz"],
  ... // other options
}
```
enable_logout : boolean (default: true)
If true, allows users to log out of their accounts, which deletes the account from Kloudless servers. API requests will no longer be possible to the account.
delete_accounts_on_logout : boolean (default: false)
If false, the File Explorer only removes tokens from the storage configured in persist option when users log out. If true, it also deletes the accounts from the Kloudless server and invalidates the OAuth tokens.
oauth : function (default: see below)
Use this parameter to customize the query parameters used in the first leg of the Kloudless OAuth flow when authenticating users. A full list of parameters supported is available on the OAuth docs.
By default, the scope the File Explorer uses is "<service_id>:normal.storage <service_id>:normal.basic". Note that the following options cannot be overridden for consistency or security reasons:
- client_id,
- response_type
- redirect_uri
- origin
- state
Set the value of the oauth option to a function that accepts a string. The function will be called when a user attempts to connect an account, with the string argument being the identifier of the service the user is attempting to connect. For example, gdrive.
The function should return an object representing the attributes to include as query parameters in the OAuth flow. Don't URL-encode the values; the File Explorer handles that. Here is an example that customizes the OAuth permissions requested if a user attempts to connect a Google Drive account, and also pre-fills the server URL if a user chooses to connect an FTP account:
```
{
  oauth: (service) => {
    const authOptions = {};

    switch (service) {
      case 'gdrive':
        // Ask for read-only access to Google Drive data instead.
        authOptions.scope = 'gdrive.storage."https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/drive.readonly":raw';
        // Pass additional query parameters to Google Drive.
        authOptions.raw = {
          'query_name': 'query_value'
        };
        break;
      case 'ftp':
        // Set a default domain when connecting an FTP account.
        authOptions.form_data = {
          domain: 'ftps://ftp.example.com:21',
        };
        break;
    }

    return authOptions;
  },
  ... // other options
}
```
If you're familiar with the configuration options accepted by the Kloudless Authenticator, the File Explorer requires options returned in the same format that the Authenticator accepts. For convenience, the following supported parameters can be specified as objects as shown in the example above:
- form_data (converted to a URL-encoded JSON string)
- custom_properties (converted to a URL-encoded JSON string)
- raw (converted to the raw[key]=value format described in the docs)

Chooser Options

multiselect : boolean
Chooser: Optional (default: false)
This option allows a user to select multiple files using the Chooser. The Chooser will return a list of one or more entries.

computer : boolean
Chooser: Optional (default: false)
Dropzone: Always true
This option allows users to upload files directly from their computer.
Configuring the Chooser's Upload Location
The Chooser will upload files to the developer's Upload Location. The Upload Location can be set in the developer portal. Under 'UI Tools' tab, click 'File Explorer' and follow the instructions for selecting a folder in a storage service such as Amazon S3. All local files from a user will be uploaded there.
link : boolean
Chooser: Optional (default: false)
This option adds an additional parameter to the Chooser's response with a link to the file chosen in the file explorer.
Use with the copy_to_upload_location to generate a link to the newly copied file that is returned in the callback.
The Kloudless File Explorer will fire the error event when the link generation is not fully successful.
```
// Example response of selecting a file
[{
  "link": "https://<the file link>",
  ...
}]
```
link_options : Object
Chooser: Optional (default: {})
The link_options object provides parameters to use when the File Explorer creates links. See the documentation for creating links for a full list of the possible options available. Note that links to selected files are only created if the link configuration option is set to true.
For example:
```
{
  link_options: {
    direct: true,
    expiration: "2020-10-12T00:00:00"
  },
  ... // other options
}
```
copy_to_upload_location : string
Chooser: Optional (default: null)
If this option is set, it will copy any file or non-root folder selected by the user from cloud storage to the location that files uploaded from the user's computer are placed in. An Upload Location must be configured via the developer portal to make use of this option.
This option accepts two values:
- 'async': Triggers an asynchronous copy and immediately returns a Task ID in the success event callback that can be checked using the Kloudless Task API for the copied file or folder's metadata.
- 'sync': Triggers a synchronous API request to copy the file or folder and polls till the copying is complete. The success event callback receives the newly uploaded file or folder's metadata.
The deprecated true option is only available for copying files and will return the new file's hypothetical metadata even though the copy has not yet completed. Please migrate to using 'sync' instead for similar behavior with a guarantee that the copy is successful.
The Kloudless File Explorer will fire the error event when the copy operation is not completely successful.
upload_location_account : string
Chooser: Optional (default: null)
If multiple Upload Locations are configured via the developer portal, this specifies the Account ID of the Upload Location to use. This option is not required if only one Upload Location is configured. The Account ID is a number that can be found in the File Explorer Upload Locations section of the App Details page. upload_location_folder must also be provided.
upload_location_folder : string
Chooser: Optional (default: null)
If multiple Upload Locations are configured via the developer portal, this specifies the Folder ID of the Upload Location to use. This option is not required if only one Upload Location is configured. The Folder ID is an encoded string that can be found on the File Explorer Upload Locations section of the App Details page. upload_location_account must also be provided.
uploads_pause_on_error : boolean
Chooser: Optional (default: true)
If true, uploads using the Computer option will pause if errors are encountered, giving the user the option to retry the upload by clicking 'Resume'. The user could also remove the file that is failing to upload from the queue. If false, the file that encounters errors will be skipped and excluded from the list of files returned in the success callback.
types : array
Chooser: Default: 'all'
This option specifies which types of elements the explorer will show to the user. You can filter based on file extension or by the following categories:
- all This configures the explorer to show all file types and folders. The user can select either files or folders. Do not combine with other options.
- folders This configures the explorer to gray out files and show folders. The user can only select folders.
- files This configures the explorer to show all file types. The user can only select files.
- text
- documents
- images
- videos
- audio

To filter by file extension, include the extension in the array without the period (.) prefix. For example, ['pdf', 'jpg', 'jpeg', 'png'].

Saver Options

files : array
Saver: Optional (default: [])
This option should list files for the File Explorer to save. The format should be an array of Javascript Objects containing a file url and name. You can specify up to 100 files. Each file will be uploaded via the Kloudless API's upload endpoint, using the url attribute.
```
{
  files: [{
    url: "http://<your image url>",
    name: "filename.extension"
  }, {
    url: "http://<your image url>",
    name: "filename.extension"
  }],
  ... // other options
}
```

Events

success(files)
The success event handler will fire when the user's operation succeeds. files is an array of file/folder metadata. The File Explorer will be closed on success.
cancel()
Fired if the user decides to cancel an operation. The File Explorer will be closed on cancellation.
error(files)
Fired in the event of an unrecoverable error with any of the items selected. The success event will not be fired even if the selection partially succeeds. Unlike the result provided for the success event, files includes an extra error key within the metadata of failed selections that contains the error response from the Kloudless API. Here is an example of the error sub-object that may be present:
```
{
  "status_code": 404,
  "message": "File not found: 1D-QuGwx7acbeGQ3STSCphysJsQs8YHJR",
  "error_code": "not_found",
  "id": "9b62d9d8-7bc7-495b-b97a-33b43720274d"
}
```
This information helps your application identify selections that failed to be copied over to upload locations, or have links generated.
open()
Fired when the File Explorer is displayed to the user. This occurs when the Chooser or Saver are opened.
close()
Fired when the File Explorer is hidden from the user. This occurs when the File Explorer is closed. This could be due to either a user action, such as choosing files or cancelling, or due to the close() method being called (not to be confused with this close event handler). The success() or cancel() events will also trigger if appropriate.
selected(files)
The selected event handler is fired when the user selects files from the explorer, but before sending the list to the Kloudless API for additional processing. It fires before the success handler, and can allow you to perform an action while waiting to get the final list.
If copy_to_upload_location and link are both false, then this event is equivalent to the success event (since nothing needs to happen on the server after the selections are made), so this event probably isn't useful for you.
files is an array of files, formatted the same way as the array passed to success.
This event is not fired when the user uses the Chooser's Computer option or the Saver. See startFileUpload and finishFileUpload for those.
addAccount(account)
Fired when a user successfully adds an account. account is an object containing the account id, name, and service.
deleteAccount(accountId)
Fired when a user successfully removes an account.
startFileUpload(file)
Fired when a file upload starts, or is requested to be retried by a user after encountering errors (see the uploads_pause_on_error option). This event is only fired when the user uploads a file via the Chooser's Computer option or the Saver. For the Chooser, file is an object containing keys id, name, size and mime_type. For the Saver, it contains url and name. This event is fired per file and not per chunk.
finishFileUpload(file)
Fired when a file upload completes successfully (once per file being uploaded). file contains the same information as in startFileUpload above, with an additional field metadata that contains the full metadata of the file provided by the Kloudless API in response to the upload. The metadata is the same as the file metadata provided via the success event for each file.
This event is only fired when the user uploads a file via the Chooser's Computer option or the Saver.
logout()
Fired when the user clicks the logout link in the File Explorer, which clears the local state of accounts connected to the File Explorer.
drop()
Fired when drops files into Dropzone.

Methods

fileExplorer.explorer(options)
You can initialize a Kloudless Explorer using the options mentioned above.
fileExplorer.getGlobalOptions()
Get build options. These are options configured when the File Explorer JavaScript library was initially built. See the Self-Hosting section for more information.
fileExplorer.setGlobalOptions(buildOptions)
Change build options during run-time. The widget is configured to work with default values, so these options should only be set when needed.
explorer.choose()
This method allows you to launch a Chooser.
explorer.choosify(element)
This method binds a click handler that launches the Chooser to the DOM element.
explorer.save(files)
This method allows you to launch a Saver. See Saver Options for more information on the format for files.
explorer.savify(element, files)
This method binds a click handler that launches the Saver for files to the DOM element.
explorer.on(event, callback)
Invokes a callback method on a particular event. See the Events section above for a list of event names, as well as the arguments the corresponding callback methods will be invoked with.
explorer.close()
This method closes the explorer window.

explorer.update(options)
Updates the configuration options the explorer was initialized with. The explorer will immediately begin using the new configuration. options is an Object with the new configuration. Not all options can be updated in this manner. The following are not supported:
- app_id
- custom_css
- types
- services
- persist
- create_folder
- account_key
explorer.logout(deleteAccount=false)
Removes all authentication tokens for the accounts connected to the File Explorer as configured via the persist option. If deleteAccount is set to true, it also deletes the accounts from the Kloudless server and invalidates the OAuth tokens, rendering them unusable and the accounts inaccessible.
This method isn't impacted by the delete_accounts_on_logout option.

Script tag example

To start using the File Explorer, simply include the JavaScript file in your HTML file. You can then create an element on the page to launch the explorer.

<body>
  <button id="file-explorer">Explore!</button>
  <script type="text/javascript" src="https://static-cdn.kloudless.com/p/platform/sdk/kloudless.explorer.js"></script>
  <script type="text/javascript">
      // Explorer initialization JS here.
  </script>
</body>

The next step is to customize the file explorer according to the developer's needs. In this example, we've decided to disable multiselect, return links, and allow for a few types of files. All of this is contained within the initialization.

// Explorer initialization JS
var explorer = window.Kloudless.fileExplorer.explorer({
  app_id: 'YOUR_APP_ID',
  multiselect: false,
  link: true,
  types: ['images', 'documents', 'text']
});

The final step is to launch the explorer and handle the events returned from the explorer based on a user's actions.

Visit our demo of the File Explorer!

// When a user successfully selects or saves a file
explorer.on('success', function(files) {
  // files is an array of JS objects that contain file metadata.
  console.log('Successfully selected files: ', files);
});

// When a user cancels the explorer
explorer.on('cancel', function() {
  console.log('File selection cancelled.');
});

// Launching the explorer to choose when a user clicks the Explore! button
explorer.choosify(document.getElementById('file-explorer-chooser'));

// In addition, you can launch the explorer programmatically with choose()
explorer.choose();

// Launching the explorer to save when a user clicks the Explore! button
// Note: you can pass in an array of files instead of using the configuration option
var files = [{
  url: 'http://<your image url>',
  name: 'filename.extension'
}, {
  url: 'http://<your image url>',
  name: 'filename.extension'
}];

explorer.savify(document.getElementById('file-explorer-saver'), files);

// In addition, you can launch the explorer programmatically with save()
var files = [{
  url: 'http://<your image url>',
  name: 'filename.extension'
}, {
  url: 'http://<your image url>',
  name: 'filename.extension'
}];

explorer.save(files);

Dropzone

The Dropzone is a variety of the Chooser that allows users to drop files into it from their Computer rather than only click on it to launch the File Explorer. It opens in place when files are dropped into it.

Configuration

The configuration is similar to the Chooser's, but with an extra option elementId as described below. The computer option is always set to true, and an Upload Location must be configured as described for the Chooser.

elementId : string
Chooser: Required
The ID of the DOM element to bind the drop zone to. The drop zone will occupy the entire height and width of the element and provide an area for the user to drag and drop files in.

Methods

fileExplorer.dropzone(options)
Initialize a Dropzone using the options mentioned above.
dropzone.on(event, callback)
See explorer.on(event, callback) for more information.
dropzone.close()
See explorer.close() for more information.

Example

Visit our JSBin example of the Dropzone!

HTML

<div id="dropzone" style="width:600px; height:100px"></div>

JavaScript

var dropzone = window.Kloudless.fileExplorer.dropzone({
  app_id: 'Your App ID',
  elementId: 'dropzone',
  multiselect: true, // To upload more than 1 file.

  // Chooser options below:
  computer: true,
  link: true,
  services: ['all'],
  types: ['all'],
});

// All of the Chooser's events are supported.
// For example:
dropzone.on('success', function(files) {
  console.log('Successfully selected files: ', files);
});

// See the File Explorer's Example section for other events.

File Explorer with Vue

See File Explorer with Vue.

File Explorer with React

See File Explorer with React.

Browser Support

Chrome 56+
Firefox 56+
IE 11+
Edge 12+
Safari 8+
Opera 49+

Work with mobile devices

To use the Kloudless File Explorer on devices with narrow screens, please add a Viewport meta tag to the web page launching the File Explorer. This ensures the File Explorer uses styling appropriate for mobile screen sizes.

The meta tag assumes that your entire web page renders well in narrow screens since it applies to your page as a whole and not just the File Explorer. Please test out your page's usability if you are adding the meta tag for the first time.

Here is an example meta tag:

<meta name="viewport" content="width=device-width, initial-scale=1">

If your page benefits from preventing some devices such as iPhones from zooming in on input fields, you can also add in the user-scalable=no option as shown below. Input fields such as <input> and <select> are used in the File Explorer as well.

<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">

Migration Guide

From v1.0.0 to v1.0.1

For script tag usage, we change exposing target from window.Kloudless to window.Kloudless.fileExplorer to better scope our UI tools. All the exports under window.Kloudless are deprecated and moved to window.Kloudless.fileExplorer.

Contributing

Contributions are welcome and appreciated. We'd love to discuss any ideas you have to improve or extend the File Explorer. We recommend contacting us at support@kloudless.com first for major modifications that you would like merged in so we can offer feedback on its implementation.

Requirements

Install Node.js (sudo apt-get install nodejs or equivalent)
Make sure you have nodejs >= 10.16.0 and npm >= 6.9.0. Then run the following commands:

npm install
npm run install-deps

Development

Use the following command to set a Kloudless App ID and run the local development server:

KLOUDLESS_APP_ID=<your_app_id> npm run dev

The File Explorer that launches on the test page uses the App ID to connect accounts. It must therefore be the ID of a valid Kloudless Application on the Kloudless API server the File Explorer accesses.

By default, the development server points to https://api.kloudless.com. However, you can point it to an alternate Kloudless API server using the BASE_URL environment variable build option as shown below.

# Export this environment variable before the `npm run dev` command above.
export BASE_URL=<your_kloudless_api_server_url>

The development server supports automatically rebuilding the source files whenever changes are saved. However, hot reloading scripts is not supported yet; you will need to reload the page to view your changes.

Typescript Definition

Be sure to update src/loader/js/interface.d.ts if the corresponding interface is changed.

Build

The command below generates a minified production build at /dist.

npm run build

Here is an explanation of the dist folder's structure:

Folder	Purpose
`loader`	Contains the script that an application includes to load the File Explorer.
`explorer`	Contains the File Explorer assets that the `loader` loads in an iframe. Only customize this when self-host the File Explorer.

Build options

The options below can be set during the build process as environment variables to customize the build, or sometimes at run-time as well.

Build-time Env Var	Run-time option	Description	Default
`BASE_URL`	N.A.	URL to the Kloudless API Server	https://api.kloudless.com
`EXPLORER_URL`	`explorerUrl`	The URL that the loader loads the explorer iframe from.	https://static-cdn.kloudless.com/p/platform/explorer/explorer.html

Check out the Self-hosting section below for an example that changes the EXPLORER_URL in order to self-host a customized fork of the File Explorer.

In addition, here is an example that directs API requests from the File Explorer to an alternate Kloudless server:

BASE_URL=<your_kloudless_api_server_url> npm run build

Testing

To test the build generated by npm run build, run the following command:

KLOUDLESS_APP_ID=<your_app_id> npm run dist-test

To test TypeScript definition file, run the following command:

npm run test:ts

Self-hosting

Self-hosting the File Explorer is one way to customize all aspects of the File Explorer's layout, styling, and functionality beyond what the configuration and theming options provide.

You can fork the File Explorer to make the changes you need before building the File Explorer, which results in a JS file at dist/loader/loader.min.js. This file must be included in any page you would like to use the File Explorer on. It serves as a light-weight wrapper to load the actual File Explorer page via an iframe.

Both the loader file and the rest of the File Explorer's structure are discussed in more detail in the Build section above.

Hosting the explorer page

The build contains an explorer folder which includes the actual HTML and functionality of the widget. By default, this is hosted by Kloudless.

If you would like to host this page yourself to customize the core File Explorer source code or styles, follow the steps below:

Rebuild the assets while setting EXPLORER_URL to specify the file explorer page URL. For example, if you'd like to host the File Explorer assets at https://example.com/kloudless/explorer.html, run the following command:
```
EXPLORER_URL=https://example.com/kloudless/explorer.html npm run build
```
Optionally, you can also set Kloudless.fileExplorer.setGlobalOptions at run-time instead of re-building the loader:
```
Kloudless.fileExplorer.setGlobalOptions({
  explorerUrl: 'https://example.com/kloudless/explorer.html',
});
```
Copy the entire dist/explorer folder into your web application's assets so the dist/explorer/explorer.html page can be found at the URL specified in the step above. In the example above, copy dist/explorer to /kloudless for https://example.com/kloudless/explorer.html to exist.
Add your web app's domain to your Kloudless App's list of Trusted Domains on the App Details Page. This allows the hosted explorer to receive access tokens to the Kloudless API.
Include dist/loader/loader.min.js in your pages that will launch File Explorer as shown in the script tag example above.

Extending the explorer template

This section contains advanced concepts that are not usually required in a fork of the File Explorer.

The template/explorer.ejs template contains necessary styles and scripts for the File Explorer as well as the compiled HTML snippets.

Feel free to add additional styles, scripts, or HTML elements you need. You can then run npm run build:template to build your customized explorer template. The built page will be available at dist/custom-explorer.html. Replace dist/explorer/explorer.html with this file, and follow the steps in the section above to host this page instead.

For an example, run npm run build:template without any changes and check the result at dist/custom-explorer.html.

Misc. Development Notes

In order to switch folders, we change the current() pointer and then refresh(). refresh() will abort any currently active requests to prevent race conditions
Put buttons that can be clicked repeatedly into data-bind clicks instead of the router, because the hash will prevent the route from being fired twice consecutively. Use the hash to switch between pages of the application.

Security Vulnerabilities

If you have discovered a security vulnerability with this library or any other part of Kloudless, we appreciate your help in disclosing it to us privately by emailing security@kloudless.com.