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
Overlays

System UI

System UI components are app-shell and admin helpers, not normal feature widgets. Use them in root layouts, admin pages, signal dashboards, tabbed detail views, and animation-heavy UI.

System

System namespace for app-level chrome and runtime helpers. It chooses CSR or SSR provider by render mode and exposes theme/language/reconnect/dev-mode helpers.
Props / API
NameTypeDescription
System.Provider{ appName, params, env, of, children, ... }Root app provider for CSR/SSR shell setup.
System.ThemeTogglecomponentTheme switching control.
System.SelectLanguagecomponentLanguage selector.
System.ReconnectcomponentReconnect helper for local or unstable sessions.
Usage

ClientSide

Small Suspense boundary for content that should be rendered client-side with an optional fallback.
Props / API
NameTypeDescription
childrenReactNodeClient-side content.
loadingReactNodeSuspense fallback.
Usage

Signal

Admin and developer-facing signal inspection namespace. It renders API/signal documents, arguments, listeners, WebSocket/PubSub views, and message payloads.
Props / API
NameTypeDescription
Signal.DoccomponentDocumentation viewer for signal definitions.
Signal.RestApicomponentREST API signal view/test surface.
Signal.WebSocket / PubSubcomponentsRealtime signal surfaces.
Signal.Arg / Object / MessagecomponentsPayload and argument renderers.
Usage

Tab

Compound tab state namespace. It provides a provider plus menu and panel components that share active menu state through context.
Props / API
NameTypeDescription
Tab{ defaultMenu?, className?, children? }Provider/root for tab state.
Tab.MenuscomponentContainer for tab menu items.
Tab.MenucomponentSelectable menu item.
Tab.PanelcomponentContent visible for a matching menu key.
Usage

animated

Small re-export of react-spring animated primitives used by Akan UI components and custom animated surfaces.
Props / API
NameTypeDescription
animated.divreact-spring animated divAnimated div primitive.
animated.greact-spring animated gAnimated SVG group primitive.
animated.progressreact-spring animated progressAnimated progress element.
Usage
System UI
System
ClientSide
Signal
Tab
animated