Interface IOptions

Constructor options

interface IOptions {
    allowFileUploads?: boolean;
    auto?: boolean;
    driveName?: string;
    includeHiddenFiles?: boolean;
    manager: IDocumentManager;
    refreshInterval?: number;
    refreshStandby?: Standby | () => boolean | Standby;
    root?: string;
    state?: IStateDB<ReadonlyPartialJSONValue>;
    translator?: ITranslator;
}

Hierarchy (View Summary)

Properties

allowFileUploads? auto? driveName? includeHiddenFiles? manager refreshInterval? refreshStandby? root? state? translator?

Properties

OptionalallowFileUploads

allowFileUploads?: boolean

Whether to allow file uploads. Defaults to true.

Optionalauto

auto?: boolean

Whether a file browser automatically loads its initial path. The default is true.

OptionaldriveName

driveName?: string

An optional Contents.IDrive name for the model. If given, the model will prepend driveName: to all paths used in file operations.

OptionalincludeHiddenFiles

includeHiddenFiles?: boolean

Whether hidden files should be included in the items.

manager

manager: IDocumentManager

A document manager instance.

OptionalrefreshInterval

refreshInterval?: number

The time interval for browser refreshing, in ms.

OptionalrefreshStandby

refreshStandby?: Standby | () => boolean | Standby

When the model stops polling the API. Defaults to when-hidden.

Optionalroot

root?: string

The root path for navigation restriction.

When set, navigation will be restricted to this path and its subdirectories. Users will not be able to navigate above this path.

Optionalstate

state?: IStateDB<ReadonlyPartialJSONValue>

An optional state database. If provided, the model will restore which folder was last opened when it is restored.

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties