@affino/overlay-host

Stability: Stable

Tiny helpers for creating a shared overlay portal host, toggling scroll lock, and wiring a single global keydown listener.

Overview

Use overlay-host for DOM-facing overlay utilities when you need host provisioning and global listeners around headless overlay controllers.

Installation

npm install @affino/overlay-host

Quick start

import {
  ensureOverlayHost,
  createScrollLockController,
  createGlobalKeydownManager,
} from "@affino/overlay-host"

ensureOverlayHost()

const scrollLock = createScrollLockController()
const keydown = createGlobalKeydownManager((event) => {
  if (event.key === "Escape") {
    // close the active surface
  }
})

scrollLock.lock()
keydown.activate()

API

• ensureOverlayHost(options?) - creates/returns a portal root (<div id="affino-overlay-host">).
• createScrollLockController(options?) - locks body scroll and restores it safely.
• createGlobalKeydownManager(handler, options?) - attaches/detaches a single keydown listener.

All helpers no-op when document/window are missing, so they are safe in SSR contexts.

Related packages

• @affino/overlay-kernel
• @affino/dialog-core
• @affino/popover-core

Used by adapters

• Laravel runtime: /adapters/laravel
• Vue runtime: /adapters/vue

License

MIT