Dialog

In Nyte

import { Dialog } from "@nyte-ai/ui/dialog";

@nyte-ai/ui/dialog re-exports the Base UI namespace unchanged. There is no Nyte styling on this subpath; the consumer owns every class, StyleX style, and layout decision. Base UI owns the interaction model, keyboard handling, focus management, and ARIA below.

Consumed by:

• desktop/src/renderer/src/chrome/about-dialog.tsx
• desktop/src/renderer/src/chrome/open-workspace.tsx
• desktop/src/renderer/src/conversation/image-preview.tsx

The rest of this page is Base UI's documentation for @base-ui/react/dialog, reproduced verbatim under the MIT license, © Material-UI SAS. Component paths in examples refer to the Base UI package; in Nyte, import from the subpath above.

Usage guidelines

• Dialog doesn't support gestures: Use Drawer when you need gesture support or snap points. A panel that slides in from the edge of the screen and doesn't need gesture support is a positioned Dialog.

Anatomy

Import the component and assemble its parts:

import { Dialog } from '@base-ui/react/dialog';

<Dialog.Root>
  <Dialog.Trigger />
  <Dialog.Portal>
    <Dialog.Backdrop />
    <Dialog.Viewport>
      <Dialog.Popup>
        <Dialog.Title />
        <Dialog.Description />
        <Dialog.Close />
      </Dialog.Popup>
    </Dialog.Viewport>
  </Dialog.Portal>
</Dialog.Root>;

Examples

State

By default, Dialog is an uncontrolled component that manages its own state.

<Dialog.Root>
  <Dialog.Trigger>Open</Dialog.Trigger>
  <Dialog.Portal>
    <Dialog.Popup>
      <Dialog.Title>Example dialog</Dialog.Title>
      <Dialog.Close>Close</Dialog.Close>
    </Dialog.Popup>
  </Dialog.Portal>
</Dialog.Root>

Use open and onOpenChange props if you need to access or control the state of the dialog. For example, you can control the dialog state in order to open it imperatively from another place in your app.

const [open, setOpen] = React.useState(false);
return (
  <Dialog.Root open={open} onOpenChange={setOpen}>
    <Dialog.Trigger>Open</Dialog.Trigger>
    <Dialog.Portal>
      <Dialog.Popup>
        <form
          // Close the dialog once the form data is submitted
          onSubmit={async () => {
            await submitData();
            setOpen(false);
          }}
        >
          ...
        </form>
      </Dialog.Popup>
    </Dialog.Portal>
  </Dialog.Root>
);

It's also common to use onOpenChange if your app needs to do something when the dialog is closed or opened. This is recommended over React.useEffect when reacting to state changes.

<Dialog.Root
  open={open}
  onOpenChange={(open) => {
    // Do stuff when the dialog is closed
    if (!open) {
      doStuff();
    }
    // Set the new state
    setOpen(open);
  }}
>

Open from a menu

In order to open a dialog using a menu, control the dialog state and open it imperatively using the onClick handler on the menu item.

Nested dialogs

You can nest dialogs within one another normally.

Use the [data-nested-dialog-open] selector and the var(--nested-dialogs) CSS variable to customize the styling of the parent dialog. Backdrops of the child dialogs won't be rendered so that you can present the parent dialog in a clean way behind the one on top of it.

Close confirmation

This example shows a nested confirmation dialog that opens if the text entered in the parent dialog is going to be discarded.

To implement this, both dialogs should be controlled. The confirmation dialog may be opened when onOpenChange callback of the parent dialog receives a request to close. This way, the confirmation is automatically shown when the user clicks the backdrop, presses the Esc key, or clicks a close button.

Custom focus management

You can control where the focus goes when the dialog opens and closes using the initialFocus and finalFocus props on the <Dialog.Popup> component.

You can also set these props to false to prevent focus from moving when the dialog opens or closes, or to a function that returns the element to focus based on the interaction type.

Outside scroll dialog

The dialog can be made scrollable by using <Dialog.Viewport> as an outer scrollable container for <Dialog.Popup> while the popup can extend past the bottom edge. The scrollable area uses the Scroll Area component to provide custom scrollbars.

Inside scroll dialog

The dialog can be made scrollable by making an inner container scrollable while the popup stays fully on screen. <Dialog.Viewport> is used as a positioning container for <Dialog.Popup>, while an inner scrollable area is created using the Scroll Area component.

Placing elements outside the popup

When adding elements that should appear "outside" the colored popup area, continue to place them inside <Dialog.Popup>, but create a child element that has the popup styles. This ensures they are kept in the tab order and announced correctly by screen readers.

<Dialog.Popup> has pointer-events: none, while inner content (the colored popup and close button) has pointer-events: auto so clicks on the backdrop continue to be registered.

Detached triggers

A dialog can be controlled by a trigger located either inside or outside the <Dialog.Root> component. For simple, one-off interactions, place the <Dialog.Trigger> inside <Dialog.Root>, as shown in the example at the top of this page.

However, if defining the dialog's content next to its trigger is not practical, you can use a detached trigger. This involves placing the <Dialog.Trigger> outside of <Dialog.Root> and linking them with a handle created by the Dialog.createHandle() function.

The imperative methods on the handle, such as open() and openWithPayload(), require a <Dialog.Root> using the same handle to be mounted. Calls made while no root is attached to the handle — before one mounts, or after it unmounts — are ignored. Each time a root mounts, it starts from fresh state: a call made while no root was attached is not replayed, and no open state carries over from a previous mount.

const demoDialog = Dialog.createHandle();

// @highlight
// @highlight-text "handle={demoDialog}"
<Dialog.Trigger handle={demoDialog}>Open</Dialog.Trigger> {/* @highlight-text "handle={demoDialog}" */}

// @highlight
// @highlight-text "handle={demoDialog}"
<Dialog.Root handle={demoDialog}>
  ...
</Dialog.Root>

Multiple triggers

A single dialog can be opened by multiple trigger elements. You can achieve this by using the same handle for several detached triggers, or by placing multiple <Dialog.Trigger> components inside a single <Dialog.Root>.

<Dialog.Root>
  <Dialog.Trigger>Trigger 1</Dialog.Trigger>
  <Dialog.Trigger>Trigger 2</Dialog.Trigger>
  ...
</Dialog.Root>

const demoDialog = Dialog.createHandle();

<Dialog.Trigger handle={demoDialog}>Trigger 1</Dialog.Trigger>
<Dialog.Trigger handle={demoDialog}>Trigger 2</Dialog.Trigger>
<Dialog.Root handle={demoDialog}>
  ...
</Dialog.Root>

The dialog can render different content depending on which trigger opened it. This is achieved by passing a payload to the <Dialog.Trigger> and using the function-as-a-child pattern in <Dialog.Root>.

The payload can be strongly typed by providing a type argument to the createHandle() function:

// @highlight
const demoDialog = Dialog.createHandle<{ text: string }>();

// @highlight
// @highlight-text "payload"
<Dialog.Trigger handle={demoDialog} payload={{ text: 'Trigger 1' }}>
  Trigger 1
</Dialog.Trigger>

// @highlight
// @highlight-text "payload"
<Dialog.Trigger handle={demoDialog} payload={{ text: 'Trigger 2' }}>
  Trigger 2
</Dialog.Trigger>

<Dialog.Root handle={demoDialog}>
  {({ payload }) => ( // @highlight-text "payload"
    <Dialog.Portal>
      <Dialog.Popup>
        <Dialog.Title>Dialog</Dialog.Title>
        {payload !== undefined && ( // @highlight-text "payload"
          <Dialog.Description>
            This has been opened by {payload.text} {/* @highlight-text "payload" */}
          </Dialog.Description>
        )}
      </Dialog.Popup>
    </Dialog.Portal>
  )}
</Dialog.Root>

Controlled mode with multiple triggers

You can control the dialog's open state externally using the open and onOpenChange props on <Dialog.Root>. This allows you to manage the dialog's visibility based on your application's state. When using multiple triggers, you have to manage which trigger is active with the triggerId prop on <Dialog.Root> and the id prop on each <Dialog.Trigger>.

Note that there is no separate onTriggerIdChange prop. Instead, the onOpenChange callback receives an additional argument, eventDetails, which contains the trigger element that initiated the state change.

API reference

Root

Groups all parts of the dialog. Doesn't render its own HTML element.

Root Props:

Root.Props

Re-export of Root props.

Root.State

type DialogRootState = {};

Root.Actions

type DialogRootActions = { unmount: () => void; close: () => void };

Root.ChangeEventReason

type DialogRootChangeEventReason =
  | 'trigger-press'
  | 'outside-press'
  | 'escape-key'
  | 'close-press'
  | 'focus-out'
  | 'imperative-action'
  | 'none';

Root.ChangeEventDetails

type DialogRootChangeEventDetails = (
  | { reason: 'trigger-press'; event: KeyboardEvent | MouseEvent | TouchEvent | PointerEvent }
  | { reason: 'outside-press'; event: MouseEvent | TouchEvent | PointerEvent }
  | { reason: 'escape-key'; event: KeyboardEvent }
  | { reason: 'close-press'; event: KeyboardEvent | MouseEvent | PointerEvent }
  | { reason: 'focus-out'; event: FocusEvent | KeyboardEvent }
  | { reason: 'imperative-action'; event: Event }
  | { reason: 'none'; event: Event }
) & {
  /** Cancels Base UI from handling the event. */
  cancel: () => void;
  /** Allows the event to propagate in cases where Base UI will stop the propagation. */
  allowPropagation: () => void;
  /** Indicates whether the event has been canceled. */
  isCanceled: boolean;
  /** Indicates whether the event is allowed to propagate. */
  isPropagationAllowed: boolean;
  /** The element that triggered the event, if applicable. */
  trigger: Element | undefined;
  preventUnmountOnClose: preventUnmountOnClose;
};

Trigger

A button that opens the dialog. Renders a <button> element.

Trigger Props:

Trigger Data Attributes:

Trigger.Props

Re-export of Trigger props.

Trigger.State

type DialogTriggerState = {
  /** Whether the trigger is currently disabled. */
  disabled: boolean;
  /** Whether the dialog is currently open and was opened by this trigger. */
  open: boolean;
};

Portal

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>. Renders a <div> element.

Portal Props:

Portal.Props

Re-export of Portal props.

Portal.State

type DialogPortalState = {};

Backdrop

An overlay displayed beneath the popup. Renders a <div> element.

Backdrop Props:

Backdrop Data Attributes:

Backdrop.Props

Re-export of Backdrop props.

Backdrop.State

type DialogBackdropState = {
  /** Whether the dialog is currently open. */
  open: boolean;
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
};

Popup

A container for the dialog contents. Renders a <div> element.

Popup Props:

Popup Data Attributes:

Popup CSS Variables:

Popup.Props

Re-export of Popup props.

Popup.State

type DialogPopupState = {
  /** Whether the dialog is currently open. */
  open: boolean;
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
  /** Whether the dialog is nested within a parent dialog. */
  nested: boolean;
  /** Whether the dialog has nested dialogs open. */
  nestedDialogOpen: boolean;
};

Title

A heading that labels the dialog. Renders an <h2> element.

Title Props:

Title.Props

Re-export of Title props.

Title.State

type DialogTitleState = {};

Description

A paragraph with additional information about the dialog. Renders a <p> element.

Description Props:

Description.Props

Re-export of Description props.

Description.State

type DialogDescriptionState = {};

Close

A button that closes the dialog. Renders a <button> element.

Close Props:

Close Data Attributes:

Close.Props

Re-export of Close props.

Close.State

type DialogCloseState = {
  /** Whether the button is currently disabled. */
  disabled: boolean;
};

Viewport

A positioning container for the dialog popup that can be made scrollable. Renders a <div> element.

Viewport Props:

Viewport Data Attributes:

Viewport.Props

Re-export of Viewport props.

Viewport.State

type DialogViewportState = {
  /** Whether the dialog is currently open. */
  open: boolean;
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
  /** Whether the dialog is nested within another dialog. */
  nested: boolean;
  /** Whether the dialog has nested dialogs open. */
  nestedDialogOpen: boolean;
};

createHandle

Creates a new handle to connect a Dialog.Root with detached Dialog.Trigger components.

Return Value:

type ReturnValue = Dialog.Handle<Payload>;

Handle

Controls a Dialog imperatively and associates detached Dialog.Trigger components with a Dialog.Root. Create one with Dialog.createHandle() and pass it to the handle prop of the root and of any triggers rendered outside of it.

The imperative methods take effect only while a root using this handle is mounted; calls made before a root attaches (or after it unmounts) are ignored.

Properties:

Methods:

function open(triggerId: string | null): void;

Opens the dialog, optionally associating it with a trigger.

This method should only be called in an event handler or an effect (not during rendering).

function openWithPayload(payload: Payload): void;

Opens the dialog with the given payload, without associating it with any trigger.

This method should only be called in an event handler or an effect (not during rendering).

function close(): void;

Closes the dialog.

This method should only be called in an event handler or an effect (not during rendering).

External Types

InteractionType

type InteractionType = 'mouse' | 'touch' | 'pen' | 'keyboard' | '';

PayloadChildRenderFunction

type PayloadChildRenderFunction = (arg: { payload: unknown | undefined }) => ReactNode;

preventUnmountOnClose

type preventUnmountOnClose = () => void;

Export Groups

• Dialog.Backdrop: Dialog.Backdrop, Dialog.Backdrop.Props, Dialog.Backdrop.State
• Dialog.Close: Dialog.Close, Dialog.Close.Props, Dialog.Close.State
• Dialog.Description: Dialog.Description, Dialog.Description.Props, Dialog.Description.State
• Dialog.Popup: Dialog.Popup, Dialog.Popup.Props, Dialog.Popup.State
• Dialog.Portal: Dialog.Portal, Dialog.Portal.State, Dialog.Portal.Props
• Dialog.Root: Dialog.Root, Dialog.Root.State, Dialog.Root.Props, Dialog.Root.Actions, Dialog.Root.ChangeEventReason, Dialog.Root.ChangeEventDetails
• Dialog.Viewport: Dialog.Viewport, Dialog.Viewport.State, Dialog.Viewport.Props
• Dialog.Title: Dialog.Title, Dialog.Title.Props, Dialog.Title.State
• Dialog.Trigger: Dialog.Trigger, Dialog.Trigger.Props, Dialog.Trigger.State
• Dialog.createHandle
• Dialog.Handle
• Default: DialogRootState, DialogRootProps, DialogRootActions, DialogRootChangeEventReason, DialogRootChangeEventDetails, DialogTriggerProps, DialogTriggerState, DialogPortalState, DialogPortalProps, DialogPopupProps, DialogPopupState, DialogBackdropProps, DialogBackdropState, DialogTitleProps, DialogTitleState, DialogDescriptionProps, DialogDescriptionState, DialogCloseProps, DialogCloseState, DialogViewportState, DialogViewportProps

Canonical Types

Maps Canonical: Alias — Use Canonical when its namespace is already imported; otherwise use Alias.

• Dialog.Backdrop.Props: DialogBackdropProps
• Dialog.Backdrop.State: DialogBackdropState
• Dialog.Close.Props: DialogCloseProps
• Dialog.Close.State: DialogCloseState
• Dialog.Description.Props: DialogDescriptionProps
• Dialog.Description.State: DialogDescriptionState
• Dialog.Popup.Props: DialogPopupProps
• Dialog.Popup.State: DialogPopupState
• Dialog.Portal.State: DialogPortalState
• Dialog.Portal.Props: DialogPortalProps
• Dialog.Root.State: DialogRootState
• Dialog.Root.Props: DialogRootProps
• Dialog.Root.Actions: DialogRootActions
• Dialog.Root.ChangeEventReason: DialogRootChangeEventReason
• Dialog.Root.ChangeEventDetails: DialogRootChangeEventDetails
• Dialog.Viewport.State: DialogViewportState
• Dialog.Viewport.Props: DialogViewportProps
• Dialog.Title.Props: DialogTitleProps
• Dialog.Title.State: DialogTitleState
• Dialog.Trigger.Props: DialogTriggerProps
• Dialog.Trigger.State: DialogTriggerState