Interface IOptions

An options object for initializing a file browser widget.

interface IOptions {
    handleOpenFile?: (path: string) => void;
    id: string;
    model: FilterFileBrowserModel;
    renderer?: DirListing.IRenderer;
    restore?: boolean;
    state?: IStateDB<ReadonlyPartialJSONValue>;
    translator?: ITranslator;
}

Properties

handleOpenFile? id model renderer? restore? state? translator?

Properties

OptionalhandleOpenFile

handleOpenFile?: (path: string) => void

Callback overriding action performed when user asks to open a file. The default is to open the file in the main area if it is not open already, or to reveal it otherwise.

id

id: string

The widget/DOM id of the file browser.

model

model: FilterFileBrowserModel

A file browser model instance.

Optionalrenderer

renderer?: DirListing.IRenderer

An optional renderer for the directory listing area.

The default is a shared instance of DirListing.Renderer.

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 manually for the file browser to be able to save its state.

Optionalstate

state?: IStateDB<ReadonlyPartialJSONValue>

An optional state database. If provided, the widget will restore the columns sizes

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties