Skip to content
opsinjs
Edit this page

Reference

Glossary

The words opsinjs uses about itself, from axis and rung to tier and twin, each with the page that defines it.

This is the vocabulary of the system, not of health. For HbA1c or systolic, use the Plain English A to Z, which is written for the people using your app. Where a word has two meanings, both are listed. The one that catches people out is status.

This page is written by hand. A definition here may summarise the page it links but never contradicts it.

TermWhat it meansSee
aliasA search synonym in a page's frontmatter. Aliases are indexed, emitted into llms.txt and /r/index.json, and unique across the docs.Agents and LLMs
axisOne of the two independent colour dimensions. The status axis carries clinical urgency and the category axis carries subject identity. They never combine on one element.Two colour axes
baseThe React code that implements a component's behaviour. base is the only one. Its URL segment means a second base would be additive rather than a migration.Registry
catalogueThe single list of every component id, with its category, release phase and aliases. registry/catalogue.ts is its only definition.Components
categoryThe subject a value belongs to, which is the identity axis. A category colour says what a number is about, never how worried to be.Two colour axes
chromeThe documentation site's own interface: sidebar, header and search. It shares the product's visual language at desk density and sets Inter, while the product keeps the platform face.Reading the docs
doctrineA rule page that constrains components rather than describing one. A Health page lists the components it governs in implements.Health
foundationA cross-cutting layer every component draws on, from colour to writing. Six have tokens of their own: colour, typography, space, shape, motion and materials.Foundations
generated markerThe comment pair opsinjs:generated:begin and opsinjs:generated:end. A script writes everything between them and erases it on the next run. The error table uses opsinjs:errors:begin and opsinjs:errors:end.Reference
ladderThe material rungs from canvas to scrim, an ordered set where position carries meaning rather than size.Materials
namespaceThe @opsinjs prefix a consumer registers in components.json so that npx shadcn add @opsinjs/result-card resolves here.Registry
patternA multi-screen sequence a health product keeps rebuilding, such as result disclosure or daily logging.Patterns
presetA complete theme expressed as values rather than code. The values are the token overrides that turn the system a particular colour.Theming
preset codeThe short opaque string, opsinjs-*, that encodes a preset for a URL or a CLI flag. It is decodable, versioned and not a secret.Theming
product themeThe theme components render under: squircle corners, system-ui and generous spacing. Every /view route and component preview uses it. The docs chrome does not.Reading the docs
rampA perceptually even series of steps generated from one colour in OKLCH, clamped for gamut and checked for contrast. Each axis colour has one.Colour
registry itemThe JSON for one distributable unit in the shadcn registry schema: its files, dependencies and target paths. Served from /r.Registry
roleA semantic colour slot filled by a ramp step. The four roles are surface, line, ink and accent. Components read roles, never ramp steps.Colour
rungOne step of the material ladder, identified by its position in the stacking order rather than by a blur radius.Materials
scaleAn ordered set of sizes named by intent rather than by t-shirt size. The scales are type, space and radius.Theming
screenA whole-screen specimen: several components under one layout, showing what the parts do together.Patterns
status (clinical)One of the four ordinal levels describing a value against what is expected for a person: steady, watch, attention and urgent. The product assigns it, and opsinjs only renders it. unknown means there is no reading. It is not a fifth level.Two colour axes
status (release)The phase a component page declares: planned, shipped or deprecated. Only a component page carries one. Shipped means the source installs and renders. It never means reviewed.Reading the docs
styleA visual variant applied as CSS only, never as behaviour. base-lyra is the default, and styles are addressable in /view and /r URLs.Registry
tierThe level a token sits at: primitive (a raw value), semantic (a role) or component (a part). Components read the semantic and component tiers only.Theming
twinThe .md version of a documentation page, served by appending .md to its URL. It is processed Markdown, not raw MDX.Agents and LLMs