Firemitt - v0.1.9
    Preparing search index...

    Class ConfigHelper

    Helper class for configuring Firemitt and Fireguard settings.

    This class provides static methods to construct and validate configuration objects for Firemitt and Fireguard. It handles dimensions, positions, URLs, and Fireguard specific configurations including theme and Firebase settings.

    Index
    constructor
    getFlags init

    • Constructs a string representing window features (flags) for window.open based on the given Firemitt configuration.

      Parameters

      Returns string

      A string of window feature flags for use in window.open.

    • Initializes and returns a TFiremittConfig object based on the provided Firemitt options.

      Parameters

      • options: {
            config?: {
                firebase?: {
                    apiKey: string;
                    appId: string;
                    authDomain: string;
                    measurementId?: string;
                    messagingSenderId?: string;
                    projectId: string;
                    storageBucket?: string;
                };
                logo?: string;
                name?: string;
                provider?: string;
                theme?: {
                    background?: string;
                    primary?: string;
                    secondary?: string;
                    text?: string;
                };
            };
            dim?: { height?: number; width?: number };
            iframe?:
                | { container?: undefined; element: HTMLIFrameElement }
                | { container: HTMLElement; element?: undefined };
            mode?: "popup" | "iframe";
            pos?: { x?: number; y?: number };
            url: string;
        }

        The Firemitt options to initialize the configuration.

      Returns TFiremittConfig

      The initialized Firemitt configuration object.

      If the URL is invalid.

      If the dimensions are invalid.

      If the application name is invalid.

      If the Firebase configuration is missing or invalid.

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods