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
Core
Next
Forms

Display UI

Display components render model lists, timestamps, loading feedback, empty states, and table/pagination surfaces. Prefer `Data` for generated model lists and standalone helpers for local UI state.

Data

Namespace for generated model list and dashboard displays. `Data.ListContainer` is the main high-level component; lower-level helpers include `TableList`, `CardList`, `Pagination`, `Dashboard`, and `Insight`.
Props / API
NameTypeDescription
Data.ListContainer{ slice, type?, columns?, actions?, tools? }Feature-rich generated model list container.
Data.TableList{ slice, columns, actions?, renderView? }Table-style list wired to generated store state.
Data.Pagination{ slice, className? }Pagination control bound to generated slice page state.
Usage

RecentTime

Localized relative-time label with a tooltip containing the absolute date. It switches from relative labels to formatted dates after the configured break unit.
Props / API
NameTypeDescription
dateDate | Dayjs | nullDate value to render. Null renders nothing.
breakUnitIntl.RelativeTimeFormatUnitUnit where relative display stops and date formatting begins.
format"auto" | "full"Automatic compact format or full date-time format.
Usage

Loading

Namespace of loading indicators for async UI: full-area overlays, buttons, inputs, progress bars, skeletons, and spinners.
Props / API
NameTypeDescription
Loading.AreacomponentAbsolute overlay for blocking a local area.
Loading.Skeleton{ active?, className?, style? }Skeleton placeholder for pending content.
Loading.ButtoncomponentButton-friendly loading indicator.
Loading.SpincomponentSimple spinner.
Usage

Empty

Standard no-data state with a localized default description and optional content below the empty body.
Props / API
NameTypeDescription
descriptionReactNodeCustom empty-state text. Defaults to localized `base.noData`.
minHeightnumberMinimum empty body height in pixels.
childrenReactNodeOptional follow-up action or explanation rendered below the empty state.
Usage

Table

Responsive table wrapper used by data-heavy screens. It supports column renderers, row click handlers, loading state, empty state, and optional `Pagination`.
Props / API
NameTypeDescription
columnsColumn[]Header/cell definitions with optional responsive visibility.
dataSourceunknown[]Rows rendered by the table.
paginationPaginationProps | falsePagination config or false to disable.
onRow(record, index) => handlersFactory for row events such as click navigation.
Usage

Pagination

Standalone page-number control. Use it when pagination state is local; use `Data.Pagination` when the state is generated from a model slice.
Props / API
NameTypeDescription
currentPagenumberCurrent 1-based page number.
totalnumberTotal item count.
itemsPerPagenumberNumber of items per page.
onPageSelect(page: number) => voidCalled with the selected 1-based page number.
Usage
Display UI
Data
RecentTime
Loading
Empty
Table
Pagination