GeoLeaf Core API - v3.19.0
    Preparing search index...

    Interface UIConfig

    UI configuration section All flags come from profile.json → ui (or the root geoleaf.config.json → ui).

    interface UIConfig {
        theme?: string;
        language?: string;
        syncDocumentLang?: boolean;
        showBaseLayerControls?: boolean;
        showLayerManager?: boolean;
        showCredentialButton?: boolean;
        showPrint?: boolean;
        showMeasure?: boolean;
        showGeocoding?: boolean;
        showEditor?: boolean;
        showPanelThemeToggle?: boolean;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    theme? language? syncDocumentLang? showBaseLayerControls? showLayerManager? showCredentialButton? showPrint? showMeasure? showGeocoding? showEditor? showPanelThemeToggle?
    theme?: string

    Active colour theme.

    • "light" / "dark": explicit, persisted in localStorage.
    • "auto": follows prefers-color-scheme; user toggle overrides until localStorage is cleared. Default "auto".
    language?: string

    UI language code (e.g. "fr", "en").

    syncDocumentLang?: boolean

    Publish the resolved language to the page's <html lang> attribute. Default true (opt-out).

    Set false when GeoLeaf is embedded in a host that owns <html lang> for its own session: the attribute is page-wide, so a map mounted inside such a host would otherwise rewrite the locale of everything around it. Suppresses only the write — the language still resolves from ?lang=, the stored preference and UIConfig.language exactly as before.

    showBaseLayerControls?: boolean

    Show the basemap switcher control. Default true.

    showLayerManager?: boolean

    Show the layer manager panel. Default true.

    showCredentialButton?: boolean

    Show the credential/login button (injected by @geoleaf-plugins/connector plugin). Default false.

    showPrint?: boolean

    Show the print/export button (requires @geoleaf-plugins/print). Default true.

    Alias of modules.print.showButton, the canonical key: read only when that key is absent.

    showMeasure?: boolean

    Show the measure & annotation button (requires @geoleaf-plugins/measure). Default true.

    Alias of modules.measure.showButton, the canonical key: read only when that key is absent.

    showGeocoding?: boolean

    Show the geocoding button of the mobile toolbar (requires @geoleaf-plugins/geocoding). Default true.

    Alias of modules.geocoding.showButton, the canonical key: read only when that key is absent.

    showEditor?: boolean

    Show the geometry editor button (requires @geoleaf-plugins/editor). Default false.

    showPanelThemeToggle?: boolean

    Show the light/dark theme toggle owned by the desktop side panel. Default true (opt-out).

    Governs BOTH of its placements — the bottom of the tab strip and the copy injected into the mobile toolbar — because they are one logical control in two layouts.

    It governs none of the three other theme settings: the map control (modules.theme-toggle.enabled), an integrator-supplied [data-gl-role="theme-toggle"] button, and the initial theme (ui.theme).

    ⚠️ Hiding the button does not reclaim the theme: the stored choice keeps priority over ui.theme, so a visitor who already toggled stays where they are — with no UI trigger left to come back if the map control is also off.

    Settings
    Member Visibility

    On This Page
    Properties