@glimstone/core
The part of GlimStone that
needs no framework: the tokens, the glyphs, and the logic of every engine and
component. @glimstone/react and @glimstone/vue are thin wrappers around it,
and a page without a framework, such as an Unraid plugin, uses it directly.
npm install @glimstone/core
tokens.cssis the palette and every component class as CSS custom properties, where the shape, colour and motion engines resolve to values. Load it before the app's own stylesheet.tailwind-theme.cssmaps the tokens onto Tailwind v4 utilities for an app that uses Tailwind.glyphs.jsonandglyphs.mdare the glyph assortment: which mark means what, where each comes from, and the sizing rules that make them one set.- The engines:
appearance(shape, accent, rainbow, motion),theme(OLED and whether dark is showing),contrast(the inks that hold 4.5:1),browserAccent(the browser as a source for the system accent),controls(the label engine and its width stages) andsetStoragePrefix, which keeps an app's own names for what it stores. - What a component shows, as functions:
buttonView,badgeClassName, the select's list model, the Info tile's version links and update check, the README button's classes, where a bubble goes, a dialog's keys and the toast queue. - What a text field and its row share:
textFieldClassandfieldWidthClasssay how a field looks and how wide it is,pressRowControldoes what a click on a row's label does,treeRowsandtreeStephold a tree's rows and keys, andtableCellClasssays what a table's cell wears. - The sign-in card's flow:
createSignInFlowkeeps what was typed and which form shows while the app answers each step,signInTextEnholds the English words, andshowRefusalshakes the button of a refused try and selects the refused field. - The fortress in the Instances tab:
createFortressFlowruns the windows to join with the phrase, leave, remove an instance and show or change the phrase,enterWordsspreads a pasted phrase over its twelve fields,qrCodedraws the phrase as a QR code in one SVG path,appCardViewsays what another app's card shows, andfortressText(lang)hands out the words in every language of the glossary, each also a module of its own underfortressLocales/. - What windows and menus share:
windowFootadds the way out,stackWindowgives Escape and Tab to the window in front, andmenu.tsholds the menu model withtidyMenu,menuRowView,placeMenu,menuMove,focusFirstMenuRowandclaimMenu.menuIsOpenandwindowIsOpentell an app's own key handler to stand back. - What fields and bars share:
meterViewandprogressViewfor a Meter and a ProgressBar,copyTextwith its fallback for plain http, and for the ColorPickerfloatColorPicker,placeColorPickerandnearestColorName, which finds the closest name in OKLab in a list such asCOLOR_NAMES_DE. - Where a dragged item goes:
dropIndexplaces it among the others by its leading edge, along a row, down a column or line by line in a grid. - What runs without a framework:
mountSelect,wireTooltipswithinfoIcon,openColorPickerPopover,attachNumberSteppers,enableSelectScrollandflagEmoji.
The whole language, with the reasons behind each rule, is in docs/design-language.md.