Interface IFileOptions

Options for the open file dialog

interface IFileOptions {
    checkbox?: null | Partial<ICheckbox>;
    defaultPath?: string;
    filter?: (value: Contents.IModel) => null | Partial<IScore>;
    focusNodeSelector?: string;
    hasClose?: boolean;
    host?: HTMLElement;
    label?: string;
    manager: IDocumentManager;
    renderer?: Dialog.IRenderer;
    root?: string;
    title?: Header;
    translator?: ITranslator;
}

Hierarchy (View Summary)

Properties

checkbox? defaultPath? filter? focusNodeSelector? hasClose? host? label? manager renderer? root? title? translator?

Properties

Optionalcheckbox

checkbox?: null | Partial<ICheckbox>

The checkbox to display in the footer. Defaults no checkbox.

OptionaldefaultPath

defaultPath?: string

Default path to open

Optionalfilter

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

Filter function on file browser item model

OptionalfocusNodeSelector

focusNodeSelector?: string

A selector for the primary element that should take focus in the dialog. Defaults to an empty string, causing the [[defaultButton]] to take focus.

OptionalhasClose

hasClose?: boolean

When "false", disallows user from dismissing the dialog by clicking outside it or pressing escape. Defaults to "true", which renders a close button.

Optionalhost

host?: HTMLElement

The host element for the dialog. Defaults to document.body.

Optionallabel

label?: string

Text to display above the file browser.

manager

manager: IDocumentManager

Document manager

Optionalrenderer

renderer?: Dialog.IRenderer

An optional renderer for dialog items. Defaults to a shared default renderer.

Optionalroot

root?: string

The root path for navigation.

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

Optionaltitle

title?: Header

The top level text for the dialog. Defaults to an empty string.

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties