Global Functions

Functions for managing instances and global configuration.

Instance Management

getInstances()

Get all active mount instances.

function getInstances(): MountInstance[]

import { getInstances } from 'vue-mount-plugin'

const instances = getInstances()
console.log(`Active instances: ${instances.length}`)

// Access each instance
instances.forEach(instance => {
  console.log(instance.id, instance.mounted)
})

getInstanceById()

Get a specific instance by its ID.

function getInstanceById(id: string): MountInstance | undefined

import { getInstanceById } from 'vue-mount-plugin'

const instance = getInstanceById('mount-1-abc123')
if (instance) {
  instance.unmount()
}

unmountAll()

Unmount all active instances.

function unmountAll(): void

import { unmountAll } from 'vue-mount-plugin'

// Cleanup all instances
unmountAll()

isMounted()

Check if an instance is currently mounted.

function isMounted(id: string): boolean

import { isMounted } from 'vue-mount-plugin'

if (isMounted('mount-1-abc123')) {
  console.log('Instance is mounted')
}

getActiveInstanceIds()

Get all active instance IDs.

function getActiveInstanceIds(): string[]

import { getActiveInstanceIds } from 'vue-mount-plugin'

const ids = getActiveInstanceIds()
console.log('Active instance IDs:', ids)

Singleton Management

getSingleton()

Get a singleton instance by key.

function getSingleton(key: string | symbol): MountInstance | undefined

import { getSingleton } from 'vue-mount-plugin'

const toast = getSingleton('my-toast')
if (toast) {
  toast.setProps({ message: 'Updated!' })
}

setSingleton()

Set a singleton instance.

function setSingleton(key: string | symbol, instance: MountInstance): void

import { setSingleton } from 'vue-mount-plugin'

setSingleton('my-toast', instance)

hasSingleton()

Check if a singleton exists.

function hasSingleton(key: string | symbol): boolean

import { hasSingleton } from 'vue-mount-plugin'

if (hasSingleton('my-toast')) {
  console.log('Toast already exists')
}

removeSingleton()

Remove a singleton by key.

function removeSingleton(key: string | symbol): void

import { removeSingleton } from 'vue-mount-plugin'

removeSingleton('my-toast')

clearSingletons()

Clear all singleton instances.

function clearSingletons(): void

import { clearSingletons } from 'vue-mount-plugin'

clearSingletons()

Configuration

setGlobalConfig()

Set global configuration defaults.

function setGlobalConfig(config: Partial<GlobalConfig>): void

import { setGlobalConfig } from 'vue-mount-plugin'

setGlobalConfig({
  zIndex: 2000,
  tagName: 'section',
  transition: 'fade'
})

// All instances inherit these defaults
mount(Modal) // Uses global config

globalConfig

The global configuration object.

const globalConfig: GlobalConfig

import { globalConfig } from 'vue-mount-plugin'

console.log(globalConfig.zIndex)
console.log(globalConfig.installed)

Type Definitions

interface GlobalConfig extends Partial<MountOptions> {
  zIndex?: number
  container?: string | Element | null
  transition?: string | TransitionOptions
  context?: ContextOptions
  installed?: boolean
}