field-ui

Documentation

Build with field-ui.

A platform-native relational field runtime for the DOM — framework-agnostic, with a renderer-agnostic core. This page is the map; every card below is drawn from the same source as the sidebar, and every card is a body in this page's field. Engage one.

Install

Most projects want @fundamental-engine/vanilla — the framework-free door, host-bundled so createField works with no wiring. React users want @fundamental-engine/react. The other packages are there when you need them; the core engine has zero runtime dependencies.

npm i @fundamental-engine/vanilla the framework-free FieldField class, mountField(), and host-bundled createField. The recommended starting point.
npm i @fundamental-engine/react the <FieldField> React component + useFieldField hook
npm i @fundamental-engine/elements the <field-root> web component — drops into any framework or plain HTML
npm i @fundamental-engine/core the renderer-agnostic engine — when you own the canvas and wire your own host

No build step? Import straight from a CDN: import { createField } from 'https://esm.sh/@fundamental-engine/vanilla'. Want everything in one install? npm i @fundamental-engine/kit is an optional convenience bundle that pulls the whole suite (you still import from the specific package). In a hurry? Your first field goes from install to a reacting headline in eight steps.

The map

The documentation, whole. These groups mirror the sidebar exactly — both render from one navigation tree, so this map cannot drift from it.

Start here

  • Overview this page — the map
  • Your first field npm install to a glowing, reacting headline, step by step
  • Web component <field-root> in any framework or plain HTML
  • TypeScript the typed FieldField class — no custom elements, no framework
  • React the <FieldField> component and the useFieldField hook
  • Core engine createField on a canvas you own, host injected

Concepts

  • Concepts bodies, the shared field context, reciprocity — the mental model
  • Natural fields gravity → priority, EM → polarity, strong → binding, weak → transformation
  • Contour typography
  • Narrative walkthrough one ordinary element, revealed as a field participant layer by layer
  • Reading Field the flagship platform demo — a content page that measures your attention

Reference

  • Overview the whole surface, generated from the engine catalog
  • createField createField(canvas, opts) and every FieldOptions field
  • FieldHandle the FieldHandle every entry point returns
  • Attributes the data-* contract bodies are written in
  • Metrics every --field-* variable the field writes back, with ranges and cadence
  • Types the exported TypeScript contracts, core and platform
  • API stability the frozen 0.x surface — the same data CI enforces
  • Forces all 36 forces: law, attributes, example — from the catalog
  • Presets blackhole, galaxy, tornado — composites, not new engine code
  • Conditions & formations conditions, formations, render modes, palettes

Field studies

Examples

  • Evidence citations are mass — trust you can feel in the type
  • Market market cap is mass; the day's move polarizes; correlated assets thread
  • Backlog priority is mass; references bind; the cycle is a sink with capacity
  • Calendar the next launch pulls hardest; imminence ramps the weight in real time
  • Recipe gallery the recipe gallery, applied live

The examples

The applied tier. Twelve ordinary page types — an inbox, a market, a backlog, a front page — run as fields over real data, with no particle swarm: the field's measurements come back as type, ink, and anchor. Each ships a committed data snapshot, upgrades itself to live counts when its source is reachable, and says which mode it is in.

Evidence citations are mass — trust you can feel in the type Inbox urgency is mass; attention is one finite budget; old asks decay toward quiet Market market cap is mass; the day's move polarizes; correlated assets thread Backlog priority is mass; references bind; the cycle is a sink with capacity Calendar the next launch pulls hardest; imminence ramps the weight in real time Threads votes are mass; controversy is charge; reply chains bind and heat Dependencies downloads are mass; staleness decays; one advisory charges the graph Fleet services carry traffic; incidents accrete their updates; impact is heat Catalog review consensus is mass — the evidence trust math, retargeted at a shelf Library listens are mass; the queue accretes and releases Memory the forgetting curve is decay; frequency anchors; review re-binds Newsroom pageviews are mass; the cycle's rise and fall polarizes

Start with Evidence — the family's front door →

For agents

The docs ship as plain text too — /llms.txt is this map in the llms.txt format, and /llms-full.txt is the full canonical documentation concatenated; the field's agent consumption model, applied to its own docs.