Overlay Manager

Used for programmatically controlling overlay components

Manage overlay identity, results and close paths while retaining native context. Do not update stale overlay instances after their owner unmounts.

Installation and initialization

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

Initialize ChakraProvider with defaultSystem and Emotion before rendering. Preserve the host React version and inspect peer compatibility. Official npm installation supplies components, not these example source files. Use the resource setup guide for locale, next-themes and framework-specific SSR; copy the selected example source separately from npm installation.

Complete native usage example

This is the actual pinned example, not a generic API mock. Copy its source closure and retain the named export. Additional imports are listed per example below.

"use client"

import { Button, Dialog, Portal, createOverlay } from "@chakra-ui/react"

interface DialogProps {
  title: string
  description?: string
  content?: React.ReactNode
}

const dialog = createOverlay<DialogProps>((props) => {
  const { title, description, content, ...rest } = props
  return (
    <Dialog.Root {...rest}>
      <Portal>
        <Dialog.Backdrop />
        <Dialog.Positioner>
          <Dialog.Content>
            {title && (
              <Dialog.Header>
                <Dialog.Title>{title}</Dialog.Title>
              </Dialog.Header>
            )}
            <Dialog.Body spaceY="4">
              {description && (
                <Dialog.Description>{description}</Dialog.Description>
              )}
              {content}
            </Dialog.Body>
          </Dialog.Content>
        </Dialog.Positioner>
      </Portal>
    </Dialog.Root>
  )
})

export const OverlayBasic = () => {
  return (
    <>
      <Button
        onClick={() => {
          dialog.open("a", {
            title: "Dialog Title",
            description: "Dialog Description",
          })
        }}
      >
        Open Modal
      </Button>
      <dialog.Viewport />
    </>
  )
}

All examples and reproduction requirements

Names identify demos, not component variant props. Copy every sourceFiles entry for the selected example. The compositions alias denotes local files, not a package. Preserve relative imports or rewrite the alias to your project's actual path. React peers are inspected separately; editor examples retain the coherent pinned Tiptap extension family.

Basic

overlay-basic · Named export OverlayBasic · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-basic.tsx

With Drawer

overlay-with-drawer · Named export OverlayWithDrawer · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-with-drawer.tsx

With Update

overlay-with-update · Named export OverlayWithUpdate · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-with-update.tsx

With Return Value

overlay-with-return-value · Named export OverlayWithReturnValue · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-with-return-value.tsx

With Menu Item

overlay-with-menu-item · Named export OverlayWithMenuItem · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-with-menu-item.tsx

With Form

overlay-with-form · Named export OverlayWithForm · original upstream example

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

• vendor/apps/compositions/src/examples/overlay-with-form.tsx

Native API and source references

The source viewer retains original declarations, imports and inheritance. Ark UI event contracts, Chakra style props and recipe types stay in their native packages; this guide does not flatten or invent their defaults. Code comments remain original source, not translated prose.

• npm/@chakra-ui/react@3.37.0/dist/types/hooks/use-overlay.d.ts

State and installation checks

Run strict types, the target production build and real interactions. Test labels/focus/keyboard, both themes, narrow layout, empty/loading/error states where supported and cleanup after unmount. Remote demo endpoints, uploads and downloads are constrained in the preview; configure your own services. Copying a command or reaching preview-ready does not prove installation or backend success.

Provenance and license boundaries

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

These are JGuang practical bilingual notes, not a full translation of upstream MDX. Original documentation and example bytes remain in vendor. Preserve repository MIT, compositions ISC metadata and separate dependency notices. The original metadata discrepancy and any missing full notices remain explicit review items; paid Chakra Pro is excluded.