image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Akan.js v2 docs are now available.View the v1 docs
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
Workspace Convention
• Structure
• Format & Lint
App & Library Convention
• Assets (public/ private/)
• Components (ui/)
• Server Utils (srvkit/)
• Web Utils (webkit/)
• Common Utils (common/)
• akan.config.ts
Domain Convention
• Overview
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
Scalar Convention
• Overview
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
Service Convention
• Overview
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
Workspace Convention
• Structure
• Format & Lint
App & Library Convention
• Assets (public/ private/)
• Components (ui/)
• Server Utils (srvkit/)
• Web Utils (webkit/)
• Common Utils (common/)
• akan.config.ts
Domain Convention
• Overview
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
Scalar Convention
• Overview
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
Service Convention
• Overview
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
Previous
Model.Util.tsx
Next
Model.Zone.tsx

Model.View.tsx

A View file renders full-model detail UI. It is usually used by detail pages or Zone wrappers that already have full view data from the server.
View components are presentation components. They may compose Unit, Util, Zone, and local subcomponents, but mutation and business decisions should stay outside the View.

View vs Unit

The main distinction is data size and page role. View is for full detail, while Unit is for repeated summary UI.
ComparisonDescriptionExample
Model.ViewRenders the full model. Use it for detail pages and sections that need body content, histories, logs, or full nested data.
Model.UnitRenders the light model. Use it for list rows, cards, table items, and compact summaries.
Model.View

Renders the full model. Use it for detail pages and sections that need body content, histories, logs, or full nested data.

Model.Unit

Renders the light model. Use it for list rows, cards, table items, and compact summaries.

Standard View Shape

A standard View exports General, accepts className and a full model prop, then uses dictionary labels for field names and statuses.
Ticket.View.tsx

Full Model Detail Patterns

A View can render every field defined on the constant full model because it receives the full model shape, not the light summary shape.
Article.View.tsx
Order.View.tsx

Using View In Pages

A server page usually fetches full view data, then passes the view object to a Zone wrapper or directly into Load.View.
detail page

Load.View And Store Hydration

Load.View safely hydrates server-provided full model data into the client store. It sets the model, loading state, modal state, and view timestamp before rendering your View.
Use this wrapper when rendering server-fetched view data inside client Zones, tab layouts, or reusable sections.
fieldDescriptionExample
<model>Stores the hydrated full model instance from the server view object.
<model>LoadingMarks the full model as ready so the View can render without showing loading UI.
<model>ModalMarks the current model state as view mode. Other model wrappers can distinguish view/edit/new flows.
<model>ViewAtStores the server view timestamp so Load.View can avoid replacing newer client state with older view data.
<model>

Stores the hydrated full model instance from the server view object.

<model>Loading

Marks the full model as ready so the View can render without showing loading UI.

<model>Modal

Marks the current model state as view mode. Other model wrappers can distinguish view/edit/new flows.

<model>ViewAt

Stores the server view timestamp so Load.View can avoid replacing newer client state with older view data.

Release.Zone.tsx

Practical Rules

Accept full model props in View components. Use Unit for light list or card summaries.
Use dictionary labels for field names, statuses, and headings.
Split large Views into named section components instead of one giant General component.
Keep mutations in Util, Store, Signal, or Service. View should mostly render the current full model.
Use Load.View when server-fetched view data must hydrate into client store state.
Model.View.tsx
View vs Unit
Standard View Shape
Full Model Detail Patterns
Using View In Pages
Load.View And Store Hydration
Practical Rules