Interface IOptions

An options object for initializing a file browser.

Hierarchy

Properties

auto? driveName? 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.

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.

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

Generated using TypeDoc