Duolith docs

Glossary

One word per concept, used the same way in the specification, the code, these docs and the diagnostics. Generated from spec/glossary.yaml.

Terms

TermMeansAvoidSeen by
pageA file in pages/ that becomes a route; markup, script block and style.screen file, view, templateuser
screenThe running instance of a page on a device.page (at runtime)user
componentA reusable file with markup, used by name inside a page.widgetuser
behaviourAn exported function in a .behaviour.duo or .behaviour.ts file that makes state, derived values or effects, called at the top of any file's script, which owns what it makes (decision 0152).hook, composable, mixin, behavioruser
packA folder that owns one topic, such as styling, with rules (each saying what to do, why, and the codes or check that find a break of it), a skill agents follow and references they read when needed. Duolith has one for each topic of the language; an app's own, in packs/ or an installed package, builds on Duolith's of the same topic (decision 0160).plugin, preset, rulesetuser
elementA built-in tag such as view, text or list.node, taguser
partA built-in kit component such as sheet or tabs.widget, controluser
pieceA named, overridable section of a part, such as a sheet's handle.slotuser
overlayContent shown above the screen, such as a dialog, sheet, menu or tooltip, written with the overlay element.modal (for every kind), portal, popupuser
anchorThe element an overlay belongs to and is placed next to, such as the button that opens a menu.reference, targetuser
detentA height a sheet rests at, medium or large.snap point, stopuser
toastA short message at the screen's edge that goes by itself, shown with toast().snackbar, notification (for this)user
lookThe starting visual style of the kit, default or platform.skin, modeuser
variantA declared alternative of a component or part, such as primary.flavour, kinduser
tokenA named design value in the theme.variableuser
themeA complete set of token values.paletteuser
utilityA short class that applies tokens, such as p-4.helper classuser
prefixA condition on a utility, such as pressed or wide.modifieruser
stateA reactive value, which may hold a value or load one.store, signal, resourceuser
loaded stateState that loads, declared with state.load(key, loader), cached by key and kept fresh; it is loading, ready or failed (decisions 0020 and 0098).resource, query, fetcheruser
shared stateState declared with state(initial, { shared: "name" }), one value for every screen that declares that name, for as long as the app runs (decision 0033).global state, store, contextuser
routeThe path a page serves, from its file name in pages/ ([id] a parameter, [...rest] the rest); route() gives a screen its path, params and query (decision 0031).url pattern, path patternuser
layoutA _layout.duo file that wraps every screen in its folder and the folders below, showing the screen where it writes <slot />; it stays mounted while the screens inside it change (decision 0031).frame, wrapper, shelluser
guardA check a page or layout makes with guard(...) before its screen is shown and while it is in front; a string redirects, a falsy value shows not-found (decision 0033).middleware, protector, gateuser
actionAn asynchronous write with pending, error, retry and refresh.mutation, commanduser
streamState fed continuously by a live source.subscription, feeduser
bindingA link from state to a view property.user
boundaryA part of a screen that shows a skeleton until its state is ready.suspenseuser
skeletonThe placeholder drawn at a boundary while it loads.shimmer, placeholderuser
islandA unit of a screen that loads, updates and fails on its own.user
motionAutomatic or preset movement of an element.animationuser
morphAn element carried from one screen to another.shared elementuser
transitionMovement between screens.user
interactionA module bundling a gesture, its state, motion and haptic.gesture handleruser
moduleAnything installed with add, whether script, effect-using or component.extension, pluginuser
effectAn operating-system feature implemented once per platform, such as haptics.native module, capabilityuser
targetAn output of the build, one of web, ios or android.platformuser
rungA level of the execution ladder, 0 to 3.tier, leveluser
diagnosticAn error, warning or hint with a stable code.user
editionA version of the language that a project opts into.user
Screen IRThe analysed, target-neutral description of a screen that both emitters consume.ASTinternal
style tableThe build-time table of resolved style combinations that views refer to by number.stylesheetinternal
engine adapterThe anti-corruption layer that is the only code allowed to talk to Lynx.bridgeinternal
contractA versioned file in the repository that two contexts agree on.interface (for these files)internal
briefThe document that is an implementer agent's whole task description.ticketinternal
consentThe person's choice, per category such as analytics or crashes, of what the app may record and send about them.permission (for this), opt-in, tracking preferenceuser
transportThe function that delivers analytics batches or crash reports somewhere, such as an HTTP endpoint or the console.sink, backend, destinationuser
breadcrumbOne recent happening, such as a press, a screen shown or an action settled, kept to send with a crash report.trail entry, log lineuser
catalogueThe file of messages for one locale, locales/<locale>.json.translation file, resource bundle, dictionaryuser
messageOne translatable text in a catalogue, named by a key and written in ICU message syntax.string, translation (for the text)user
localeA language tag such as en or ar-EG that picks the catalogue, the text direction and the number and date formats.language (for the tag), cultureuser
lint ruleA check that duolith lint runs, with a warning code from W0001 to W0099, turned off or on under lint in duolith.yaml.linter rule, inspectionuser