skip to content
hyvui anthology / field guide
utility
route note open note / field guide a part is easier to use when its role is shown beside its props.
what it shows

a part is easier to use when its role is shown beside its props.

focal
live component specimens
viewer
author
relation
annotate
time
inspect and return
host
deconstructed-editorial
mobile
index then specimen
hyvui docs
component index

documentation

components, props, and live specimens. choose a section.

field guide / first pass

start here

install the floor, place the smallest composition, then add state and a real relation. the catalog below keeps the full component surface available when you need it.

01 / install + import

one stylesheet. one public barrel.

npm install @hyvnt/hyvui
import "@hyvnt/hyvui/styles.css";
02 / smallest composition

a surface gives the parts somewhere to work.

<Card>
  <Text variant="heading" as="h2">operator panel</Text>
  <Button variant="primary">activate</Button>
</Card>
03 / props + states

use the component props for variants. use native attributes for identity, form behavior, and accessibility.

read input states
04 / one relation

a component is a part. the relation gives it work.

open relation workbench

overview

the index

choose a section. examples and props sit beside the specimen.

v0.1 svelte 5 stable

weights and themes

change the weight. keep the theme.

weight changes density and voice. theme changes palette, motion, and ornament. try both.

set weight and theme separately. components stay the same. import the theme tokens before using hextech or arcane.

import '@hyvnt/hyvui/tokens/hextech.css' import '@hyvnt/hyvui/tokens/arcane.css'

primitives

text and surfaces

heading tier

body text. short lines. leave room between them.

use italics for a side note.

caption register

icon primitive

label + divider primitives
base

surface

card

surface

panel

surface


layout

stack, grid, card, panel

card

use card for a repeated item or a small group.

grid

use grid for columns. pass equal column count or a template.

stack

stack places children in a row or column and applies the gap.

panel layout

use panel for a large section, form, or table.

surface spacing rhythm

display

data, status, narrative

AR operator active
sessions 248 ↑ +12%
latency 82ms ↓ -6%
drift 0.32 —
show the state the user needs. hide the rest.
componentrolestatus
Buttonprimary actionstable
Panelsection containerstable
StatusLinesystem voicecalibrated
DepthStagespatial stackactive
<script lang="ts">
  import { Button, Card, Text } from '$lib';
</script>

<Card>
  <Text variant="heading" as="h2">operator panel</Text>
  <Button variant="primary">activate</Button>
</Card>

inputs

controlled fields and actions

form module

feedback

status, alerts, and system voice

[WARN] contrast delta near threshold
[ .. ] loading register
[ OK ] tokens aligned
[ OK ] surface stabilized
[WARN] signal drift within tolerance
[ OK ] ready for operators

no entries

no records yet.

signal deferred

try again when the channel is steady.



overlays

modal, drawer, popover, action bar

selection test

ambient

ornament and atmosphere

hextech + arcane ambient
HexGrid
BrassFiligree
CrystalShard
ArcaneVein
EnergyArc
ShimmerCloud

depth

layers in depth


scenes

scene patterns

stage scene

centered register

one message. centered. no side rail.

chapter 01

narrative scene

copy stays narrow. the open side holds an image or specimen.

canvas
readout signal clean

dense layout for data-heavy screens.

archive

archive item one

archive item two

log scene
[ .. ] syncing modules
[ OK ] cache locked
[ OK ] session stable

one decision

one decision at a time.

secondary panel

secondary content enters from the side.

apply update

write these changes to the register.

2 selected
route / docs status / utility