Interface ProfileSwitcherPublicApi

The object mounted on GeoLeaf.ProfileSwitcher.

interface ProfileSwitcherPublicApi {
    list(): AvailableProfileEntry[];
    current(): string | null;
    switchTo(id: string): void;
    isEnabled(): boolean;
    getConfig(): ProfileSwitcherCapabilityConfig;
}

Index

Methods

list current switchTo isEnabled getConfig

Methods

list

list(): AvailableProfileEntry[]
Profiles offered by the switcher (empty when none were harvested at build).

Returns AvailableProfileEntry[]
- Defined in src/capabilities/profile-switcher/public-api.ts:27

current

current(): string | null
Active profile id, or null before the config has loaded.

Returns string | null
- Defined in src/capabilities/profile-switcher/public-api.ts:29

switchTo

switchTo(id: string): void
Persists the choice and reloads onto that profile.
Parameters
- id: string
Returns void
- Defined in src/capabilities/profile-switcher/public-api.ts:31

isEnabled

isEnabled(): boolean
true when the selector is enabled (modules.profile-switcher.enabled === true).

Returns boolean
- Defined in src/capabilities/profile-switcher/public-api.ts:33

getConfig

getConfig(): ProfileSwitcherCapabilityConfig
The resolved modules.profile-switcher config (merged over the built-in defaults).

Returns ProfileSwitcherCapabilityConfig
- Defined in src/capabilities/profile-switcher/public-api.ts:35