image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
CLI Reference
• Commands
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
AkanJS Reference
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI Reference
• Overview
• Core
• Display
• Forms
• Overlays
• System
CLI Reference
• Commands
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
AkanJS Reference
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI Reference
• Overview
• Core
• Display
• Forms
• Overlays
• System
Previous
Forms
Next
System

Overlays UI

Overlay components cover modal flows, custom dialogs, destructive confirmations, dropdown menus, and copy actions. Use `Modal` for common controlled overlays and `Dialog` for custom composition.

Modal

Controlled modal wrapper built on top of `Dialog`. Use it for common app overlays where you want title/content/action slots without composing the full dialog namespace.
Props / API
NameTypeDescription
openbooleanControlled open state.
onCancel() => voidCalled when the modal requests closing.
titlestring | ReactNodeOptional title slot.
actionReactNodeOptional footer/action slot.
confirmClosebooleanAsk for confirmation before closing.
Usage

Dialog

Compound dialog namespace for custom modal composition. Use it when `Modal` is too opinionated and you need a custom trigger, title, content, or action layout.
Props / API
NameTypeDescription
Dialog{ open?, defaultOpen?, className? }Provider/root for dialog state.
Dialog.TriggercomponentOpens the dialog from custom trigger content.
Dialog.ModalcomponentModal surface and close behavior.
Dialog.Title / Content / ActioncomponentsNamed modal slots.
Usage

Popconfirm

Inline confirmation popover for destructive or irreversible actions. It wraps a trigger element and shows localized OK/cancel buttons.
Props / API
NameTypeDescription
titlestringConfirmation title.
descriptionReactNodeOptional detailed message.
onConfirm() => voidCalled when the user confirms.
okText / cancelTextstringCustom button labels.
Usage

Dropdown

Compact dropdown menu wrapper. It is commonly used for row actions, comment/story menus, and context actions in list UIs.
Props / API
NameTypeDescription
valueReactNodeTrigger button content.
contentReactNodeDropdown menu content.
buttonClassNamestringClasses for the trigger button.
dropdownClassNamestringClasses for the menu panel.
Usage

Copy

Copy-to-clipboard trigger that also shows a global success message through Akan store messages.
Props / API
NameTypeDescription
textstringText copied to the clipboard.
copyMessagestringOptional custom success message.
childrenReactNodeTrigger element.
Usage
Overlays UI
Modal
Dialog
Popconfirm
Dropdown
Copy