Interface IFileOptions

Options for the open file dialog

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

Hierarchy (view full)

Properties

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

Properties

Optional checkbox

checkbox?: null | Partial<ICheckbox>

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

Optional defaultPath

defaultPath?: string

Default path to open

Optional filter

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

Filter function on file browser item model

Type declaration

Optional focusNodeSelector

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.

Optional hasClose

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.

Optional host

host?: HTMLElement

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

Optional label

label?: string

Text to display above the file browser.

manager

manager: IDocumentManager

Document manager

Optional renderer

renderer?: Dialog.IRenderer

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

Optional title

title?: Header

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

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

checkboxdefaultPathfilterfocusNodeSelectorhasClosehostlabelmanagerrenderertitletranslator