Surfacesduskmoonimplemented1 demos

Modal

Modal blocks for confirmation, focused forms, and critical decisions.

Import@duskmoon-dev/components/modal
4API sections
34documented props
10behavior scenarios
Key API
opendefaultOpentitlecontentfooteronOk

Usage

When to use

  • Use it immediately after user actions or system checks that need visible confirmation.
  • Choose the least interruptive feedback surface that still makes the state clear.

Implementation notes

StylesheetImport @duskmoon-dev/components/styles.css once in the app or docs shell.
StateStart with default props for static examples, then switch to controlled props when state must be shared.
ThemeThe preview inherits the active DuskMoon data-theme value from the docs layout.

Features

User feedback

Covers transient, inline, or blocking feedback patterns for user actions and system status.

Action recovery

Shows how the component keeps next actions visible after success, warning, or failure states.

Primary API surface

Modal is most often configured through `open`, `defaultOpen`, `title`, `content`.

Covered behavior

Renders open modal with title and children

Feature Demos

Feature demos are authored for the component page, then supplemented with behavior scenarios from the component test coverage.

Preview

Controlled native modal

authored

Modal uses native showModal and close. A controlled onCancel must update open; its ref and div props remain on the inner modal box. Apply maskClassName to the dialog for ::backdrop styling. Static Modal.confirm/info/success/error/warning handles are retained but do not render a service surface yet.

Source
import "@duskmoon-dev/components/styles.css";
import { useState } from "react";
import { Modal } from "@duskmoon-dev/components/modal";

export function ReleaseChecklist() {
  const [open, setOpen] = useState(false);
  return (
    <>
      <button type="button" onClick={() => setOpen(true)}>Review release</button>
      <Modal
        open={open}
        title="Release checklist"
        onCancel={() => setOpen(false)}
        onOk={() => setOpen(false)}
        maskClassName="release-mask"
      >
        Review component styles before publishing.
      </Modal>
    </>
  );
}

API

The API reference below lists every parsed exported type or interface for Modal. Start with `open`, `defaultOpen`, `title`, `content` for common usage.

Types: packages/components/src/components/modal/Modal.types.tsScenarios: packages/components/src/components/modal/Modal.test.tsx
ModalPropsinterface extends Omit< ComponentProps<"div">, "children" | "className" | "content" | "title" >
PropTypeRequiredDescription
openbooleanNoopen configures Modal.
defaultOpenbooleanNodefaultOpen configures Modal.
titleReactNodeNotitle configures Modal.
childrenReactNodeNochildren configures Modal.
contentReactNodeNocontent configures Modal.
footerReactNode | nullNofooter configures Modal.
onOk(event: MouseEvent<HTMLButtonElement>) => voidNoonOk configures Modal.
onCancel(event: MouseEvent<HTMLButtonElement | HTMLDivElement>) => voidNoonCancel configures Modal.
okTextReactNodeNookText configures Modal.
cancelTextReactNodeNocancelText configures Modal.
confirmLoadingbooleanNoconfirmLoading configures Modal.
closablebooleanNoclosable configures Modal.
maskClosablebooleanNomaskClosable configures Modal.
widthCSSProperties["width"]Nowidth configures Modal.
centeredbooleanNocentered configures Modal.
destroyOnClosebooleanNodestroyOnClose configures Modal.
afterOpenChange(open: boolean) => voidNoafterOpenChange configures Modal.
classNamestringNoclassName configures Modal.
maskClassNamestringNomaskClassName configures Modal.
closeIconReactNodeNocloseIcon configures Modal.
ModalFuncPropsinterface
PropTypeRequiredDescription
titleReactNodeNotitle configures Modal.
contentReactNodeNocontent configures Modal.
onOk() => voidNoonOk configures Modal.
onCancel() => voidNoonCancel configures Modal.
okTextReactNodeNookText configures Modal.
cancelTextReactNodeNocancelText configures Modal.
ModalFuncHandleinterface
PropTypeRequiredDescription
destroy() => voidYesdestroy configures Modal.
update(config: ModalFuncProps) => voidYesupdate configures Modal.
ModalComponentinterface extends ForwardRefExoticComponent< ModalProps & RefAttributes<HTMLDivElement> >
PropTypeRequiredDescription
confirm(config: ModalFuncProps) => ModalFuncHandleYesconfirm configures Modal.
info(config: ModalFuncProps) => ModalFuncHandleYesinfo configures Modal.
success(config: ModalFuncProps) => ModalFuncHandleYessuccess configures Modal.
error(config: ModalFuncProps) => ModalFuncHandleYeserror configures Modal.
warning(config: ModalFuncProps) => ModalFuncHandleYeswarning configures Modal.
destroyAll() => voidYesdestroyAll configures Modal.