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
akanjs/client
Next
Overview

akanjs/webkit

`akanjs/webkit` contains browser-only React helpers and native-capability hooks. Import it for lazy browser components, debounce/throttle/interval hooks, promise state, CSR navigation state, and Capacitor camera/contact/location/push flows.

lazy

React lazy wrapper that supports `ssr: false`. It returns a fallback stub on the server and gates client rendering until mounted, which is useful for browser-only libraries such as maps, charts, and 3D scenes.
Usage

useDebounce

Returns a debounced callback that delays execution until input quiets down. Search boxes, image editors, and expensive field updates use it to avoid repeated work while users type or drag.
Usage

useInterval

Runs the latest callback on a fixed interval and clears the timer on unmount. Zone components use it for polling metrics, game state, build logs, and realtime-like dashboards.
Usage

useThrottle

Returns a throttled callback that runs immediately, then ignores calls until the delay passes. Use it for scroll, pointer, resize, or drag handlers that can fire too frequently.
Usage

useFetch / useFetchFn

Client hook for promise-backed values. `useFetch` accepts a promise or immediate value, while `useFetchFn` memoizes a factory so re-renders do not duplicate network requests.
Usage

useCamera

Capacitor camera/photos hook. It checks permissions, opens app settings on denial, and exposes `getPhoto`, `pickImage`, and permission state for upload UIs.
Usage

useContact

Capacitor contacts hook for mobile signup/social flows. It requests contact permission and returns phone/name contact data when native contacts are available.
Usage

useGeoLocation

Capacitor geolocation hook. It requests location permissions, redirects to app settings when denied, and returns current coordinates for map or location flows.
Usage

usePushNoti

Push notification hook for native clients. It initializes FCM/push plugins, checks permission state, registers the device, and reads the FCM token when supported.
Usage

useLocation / useHistory

CSR router hooks for translating hrefs into route state and tracking navigation history. They power cached page transitions, scroll restoration, and back/forward detection.
Usage

LoginForm

Shared login form type used by auth stores and bridge UI. It describes target auth mode, redirect behavior, unauthorized path, and optional JWT handoff.
Usage
akanjs/webkit
lazy
useDebounce
useInterval
useThrottle
useFetch / useFetchFn
useCamera
useContact
useGeoLocation
usePushNoti
useLocation / useHistory
LoginForm