Interface IOptions

Constructor options

interface IOptions {
    auto?: boolean;
    driveName?: string;
    filter?: ((value) => null | Partial<IScore>);
    filterDirectories?: boolean;
    includeHiddenFiles?: boolean;
    manager: IDocumentManager;
    refreshInterval?: number;
    refreshStandby?: Standby | (() => boolean | Standby);
    state?: IStateDB<ReadonlyPartialJSONValue>;
    translator?: ITranslator;
}

Hierarchy (view full)

Properties

auto? driveName? filter? filterDirectories? includeHiddenFiles? manager refreshInterval? refreshStandby? state? translator?

Properties

Optional auto

auto?: boolean

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

Optional driveName

driveName?: string

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

Optional filter

filter?: ((value) => null | Partial<IScore>)

Filter function on file browser item model

Type declaration

Optional filterDirectories

filterDirectories?: boolean

Filter directories

Optional includeHiddenFiles

includeHiddenFiles?: boolean

Whether hidden files should be included in the items.

manager

manager: IDocumentManager

A document manager instance.

Optional refreshInterval

refreshInterval?: number

The time interval for browser refreshing, in ms.

Optional refreshStandby

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

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

Type declaration

    • (): boolean | Standby

    • Returns boolean | Standby

Optional state

state?: IStateDB<ReadonlyPartialJSONValue>

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

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

autodriveNamefilterfilterDirectoriesincludeHiddenFilesmanagerrefreshIntervalrefreshStandbystatetranslator