Type Alias FVTTFilePickerBrowseOptions

  • Foundry fvtt.FilePicker w/ expanded FVTTFilePickerControl options.
type FVTTFilePickerBrowseOptions = {
    activeSource?: string;
    allowUpload?: boolean;
    callback?: Function;
    current?: string;
    displayMode?: string;
    favorites?: Map<string, FavoriteFolder>;
    glasspaneId?: string;
    id?: string;
    modal?: boolean;
    modalOptions?: {
        background: string;
        closeOnInput: boolean;
        styles: { [key: string]: string };
        transition: TransitionFunction;
        transitionOptions: { [key: string]: any };
    };
    onURLString?: ({ urlString: string }: any) => void;
    onValidateURLString?: ({ urlString: string }: any) => Promise<boolean>;
    redirectToRoot?: string[];
    store?: MinimalWritable<string>;
    tileSize?: boolean;
    type?: string;
    zIndex?: number;
}
Index

Properties

activeSource? allowUpload? callback? current? displayMode? favorites? glasspaneId? id? modal? modalOptions? onURLString? onValidateURLString? redirectToRoot? store? tileSize? type? zIndex?

Properties

activeSource?: string

A current file source in 'data', 'public', or 's3'.

allowUpload?: boolean

A flag which permits explicitly disallowing upload, true by default.

callback?: Function

A callback function to trigger once a file has been selected.

current?: string

The current file path being modified, if any.

displayMode?: string

The picker display mode in FilePicker.DISPLAY_MODES.

favorites?: Map<string, FavoriteFolder>

A map of favorite folder configuration objects.

glasspaneId?: string

Provide the CSS ID of the glasspane to move the file picker app to after opening.

id?: string

A specific unique CSS app ID.

modal?: boolean

When true a modal file picker will be opened.

modalOptions?: {
    background: string;
    closeOnInput: boolean;
    styles: { [key: string]: string };
    transition: TransitionFunction;
    transitionOptions: { [key: string]: any };
}

Options for the modal glasspane / TJSGlasspane component.

onURLString?: ({ urlString: string }: any) => void

Optional function invoked when URL string changes.

onValidateURLString?: ({ urlString: string }: any) => Promise<boolean>

Optional validation function of selected URL string.

redirectToRoot?: string[]

Redirect to the root directory rather than starting in the source directory of one of these files.

store?: MinimalWritable<string>

A minimal writable store that is set with result.

tileSize?: boolean

Display the tile size configuration.

type?: string

A type of file to target, in 'audio', 'image', 'video', 'imagevideo', 'folder', 'font', 'graphics', 'text', or 'any'.

zIndex?: number

Provides an explicit z-index for the file picker app.

Settings

Member Visibility

On This Page

Properties