Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface ApplicationConfiguration

    interface ApplicationConfiguration {
        actions: Record<
            string,
            | ApplicationClickAction
            | { buttons: number[]; handler: ApplicationClickAction },
        >;
        classes: string[];
        form?: ApplicationFormConfiguration;
        id: string;
        position: Partial<ApplicationPosition>;
        tag: string;
        uniqueId: string;
        window: ApplicationWindowConfiguration;
    }
    Index

    Properties

    actions: Record<
        string,
        | ApplicationClickAction
        | { buttons: number[]; handler: ApplicationClickAction },
    >

    Click actions supported by the Application and their event handler functions. A handler function can be defined directly which only responds to left-click events. Otherwise, an object can be declared containing both a handler function and an array of buttons which are matched against the PointerEvent#button property.

    classes: string[]

    An array of CSS classes to apply to the Application

    Configuration used if the application top-level element is a form or dialog

    id: string

    An HTML element identifier used for this Application instance

    position: Partial<ApplicationPosition>

    Default positioning data for the application

    tag: string

    The HTMLElement tag type used for the outer Application frame

    uniqueId: string

    A string discriminator substituted for {id} in the default HTML element identifier for the class

    Configuration of the window behaviors for this Application