image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
Previous
DataList & Enum
Next
Endpoint

CRUD With Less Code

CRUD is usually the first screen you build: list items, open one item, create a new one, edit it, and remove it. In Akan, most of that work is already prepared around a model slice.
  • Slice decides which records this screen can read and edit.
  • Template draws the form fields.
  • Load and Model components connect the slice to UI behavior.

Start With A Slice

A slice is a named window into your model. Give it a name that matches the screen, such as `inPublic`, `inAdmin`, or `inProject`.
Post slice

List And Open

`Load.Units` renders the list. `Model.ViewEditModal` can live next to the list and handle detail view plus edit modal behavior.
Post list zone

Create And Edit

Use the same Template for create and update. The wrapper prepares the form state, and the Template only cares about fields.
Create page
Edit modal

Remove In Util

Delete buttons usually appear in many places. Put them in `Post.Util.tsx` so Unit, View, and Zone files stay simple.
Remove helper

Tips

  • Name slices after screens, not database queries.
  • Keep Template boring. It should mostly read form state and render fields.
  • Use Util components for repeated actions such as remove, publish, approve, or open dialog.
CRUD With Less Code
Start With A Slice
List And Open
Create And Edit
Remove In Util
Tips