Interface IOptions

The options for creating a file browser using a file browser factory.

Notes

In future versions of JupyterLab, some of these options may disappear, which is a backward-incompatible API change and will necessitate a new version release. This is because in future versions, there will likely be an application-wide notion of a singleton command registry and a singleton state database.

interface IOptions {
    allowFileUploads?: boolean;
    auto?: boolean;
    driveName?: string;
    refreshInterval?: number;
    restore?: boolean;
    state?: null | IStateDB<ReadonlyPartialJSONValue>;
}

Properties

allowFileUploads? auto? driveName? refreshInterval? restore? state?

Properties

OptionalallowFileUploads

allowFileUploads?: boolean

Whether to allow file uploads. Defaults to true.

Optionalauto

auto?: boolean

Whether a file browser automatically loads its initial path.

Notes

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.

OptionalrefreshInterval

refreshInterval?: number

The time interval for browser refreshing, in ms.

Optionalrestore

restore?: boolean

Whether a file browser automatically restores state when instantiated. The default is true.

Notes

The file browser model will need to be restored before for the file browser to start saving its state.

Optionalstate

state?: null | IStateDB<ReadonlyPartialJSONValue>

The state database to use for saving file browser state and restoring it.

Notes

Unless the value null is set for this option, the application state database will be automatically passed in and used for state restoration.

Settings

Member Visibility

On This Page

Notes
Properties