1use std::sync::LazyLock;
33
34use rustc_hash::{FxHashMap, FxHashSet};
35
36use crate::access::Role;
37use crate::anim::{Easing, Repeat};
38use crate::color::Color;
39use crate::cursor::CursorShape;
40use crate::enter::Enter;
41use crate::keyframes::Keyframe;
42use crate::spec::{
43 Align, Bound, FontFamily, NodeSpec, PadShorthand, Sizing, TextStyle, TextWrap, UnderlineStyle,
44};
45use crate::value::Value;
46use crate::window::{WindowButton, WindowConfig};
47
48mod doors;
49pub use doors::{Cell, DOORS, Door, GUEST};
50
51pub const P_DIR: u32 = 1;
53pub const P_WIDTH: u32 = 2;
54pub const P_HEIGHT: u32 = 3;
55pub const P_MIN_W: u32 = 4;
56pub const P_MAX_W: u32 = 5;
57pub const P_MIN_H: u32 = 6;
58pub const P_MAX_H: u32 = 7;
59pub const P_PAD: u32 = 8;
60pub const P_GAP: u32 = 9;
61pub const P_MAIN_ALIGN: u32 = 10;
62pub const P_CROSS_ALIGN: u32 = 11;
63pub const P_BG: u32 = 12;
64pub const P_BORDER: u32 = 13;
65pub const P_RADIUS: u32 = 14;
66pub const P_OVERFLOW: u32 = 15;
67pub const P_FLOAT: u32 = 16;
68pub const P_HOVERABLE: u32 = 17;
69pub const P_ON_CLICK: u32 = 18;
70pub const P_ON_DRAG: u32 = 19;
71pub const P_ON_KEY: u32 = 20;
72pub const P_WINDOW: u32 = 21;
73pub const P_KEY_FOCUS: u32 = 22;
74pub const P_CENTER: u32 = 23;
75pub const P_SIZE: u32 = 24;
76pub const P_LINE_HEIGHT: u32 = 25;
77pub const P_COLOR: u32 = 26;
78pub const P_FAMILY: u32 = 27;
79pub const P_KEY: u32 = 28;
80pub const P_TITLE: u32 = 29;
81pub const P_TOOLTIP: u32 = 30;
82pub const P_TRANSITION: u32 = 31;
83pub const P_EASING: u32 = 32;
84pub const P_SLIDE: u32 = 33;
85pub const P_HOVER_BG: u32 = 34;
86pub const P_PRESSED_BG: u32 = 35;
87pub const P_HOVER_GROUP: u32 = 36;
88pub const P_ON_HOVER: u32 = 37;
89pub const P_RADIUS_TL: u32 = 38;
90pub const P_RADIUS_TR: u32 = 39;
91pub const P_RADIUS_BR: u32 = 40;
92pub const P_RADIUS_BL: u32 = 41;
93pub const P_FONT: u32 = 42;
94pub const P_KEYFRAMES: u32 = 43;
95pub const P_REPEAT: u32 = 44;
96pub const P_DELAY: u32 = 45;
97pub const P_WRAP: u32 = 46;
98pub const P_MAX_LINES: u32 = 47;
99pub const P_ELLIPSIS: u32 = 48;
100pub const P_ENTER: u32 = 49;
101pub const P_CLICK_SOUND: u32 = 50;
102pub const P_HOVER_SOUND: u32 = 51;
103pub const P_ON_LAYOUT: u32 = 52;
104pub const P_ROLE: u32 = 53;
105pub const P_LABEL: u32 = 54;
106pub const P_CHECKED: u32 = 55;
107pub const P_VALUE_NOW: u32 = 56;
108pub const P_VALUE_MIN: u32 = 57;
109pub const P_VALUE_MAX: u32 = 58;
110pub const P_CARET: u32 = 59;
111pub const P_SELECTION_ANCHOR: u32 = 60;
112pub const P_FOCUSABLE: u32 = 61;
113pub const P_DISABLED: u32 = 62;
114pub const P_FOCUS_BG: u32 = 63;
115pub const P_MODAL: u32 = 64;
116pub const P_ON_CONTEXT_MENU: u32 = 65;
117pub const P_CURSOR: u32 = 66;
118pub const P_SELECTED: u32 = 67;
119pub const P_EXPANDED: u32 = 68;
120pub const P_OPACITY: u32 = 69;
121pub const P_SHADOW_COLOR: u32 = 70;
122pub const P_SHADOW_BLUR: u32 = 71;
123pub const P_SHADOW_X: u32 = 72;
124pub const P_SHADOW_Y: u32 = 73;
125pub const P_SHADOW_SPREAD: u32 = 74;
126pub const P_WRAP_CHILDREN: u32 = 75;
127pub const P_CROSS_GAP: u32 = 76;
128pub const P_INITIAL_FOCUS: u32 = 77;
129pub const P_EXIT: u32 = 78;
130pub const P_WINDOWS: u32 = 79;
131pub const P_LIVE: u32 = 80;
132pub const P_KEY_UP: u32 = 81;
133pub const P_VALUE_TEXT: u32 = 82;
134pub const P_DESCRIPTION: u32 = 83;
135pub const P_FEATURES: u32 = 84;
136pub const P_UNDERLINE: u32 = 85;
137pub const P_STRIKETHROUGH: u32 = 86;
138pub const P_ANIMATE: u32 = 87;
139pub const P_ACCENT: u32 = 88;
140pub const P_INDEX: u32 = 89;
141pub const P_SELECTABLE: u32 = 90;
142pub const P_ON_FORCE_CLICK: u32 = 91;
143pub const P_FOCUS_REGION: u32 = 92;
144pub const P_SCROLLBAR: u32 = 93;
145pub const P_SCROLLBAR_WIDTH: u32 = 94;
146pub const P_SCROLLBAR_COLOR: u32 = 95;
147pub const P_SCROLLBAR_ACTIVE_COLOR: u32 = 96;
148pub const P_ANCHOR: u32 = 97;
149pub const P_ALWAYS_ON_TOP: u32 = 98;
150pub const P_ON_SCROLL: u32 = 99;
151pub const P_ROW_COUNT: u32 = 100;
152pub const P_UNDERLINE_COLOR: u32 = 101;
153pub const P_UNDERLINE_STYLE: u32 = 102;
154pub const P_ON_DROP: u32 = 103;
155pub const P_DROP_BG: u32 = 104;
156pub const P_CARET_SOLID: u32 = 105;
157pub const P_SECURE_INPUT: u32 = 106;
158pub const P_ASPECT_RATIO: u32 = 107;
159pub const P_MIXED: u32 = 108;
160pub const P_VALUE_STEP: u32 = 109;
161pub const P_ON_CHANGE: u32 = 110;
162pub const P_PIXEL_SNAP: u32 = 111;
163pub const P_KEEP_FOCUS: u32 = 112;
164pub const P_ON_FOCUS: u32 = 113;
165pub const P_RULES: u32 = 114;
166pub const P_RULE_WIDTH: u32 = 115;
167pub const P_ON_BUTTON: u32 = 116;
168pub const P_BUTTONS: u32 = 117;
169pub const P_OVERSCROLL: u32 = 118;
170pub const P_SCROLL_AXES: u32 = 119;
171pub const P_MODIFIER_KEYS: u32 = 120;
172pub const P_OPTION_AS_ALT: u32 = 121;
173pub const P_BOUNCE: u32 = 122;
174pub const P_GRADIENT: u32 = 123;
175pub const P_SCROLL_MODS: u32 = 124;
176pub const P_IME_OFF: u32 = 125;
177pub const P_BACKDROP_BLUR: u32 = 126;
178pub const P_ROTATE: u32 = 127;
179pub const P_SCALE: u32 = 128;
180pub const P_PIVOT_X: u32 = 129;
181pub const P_PIVOT_Y: u32 = 130;
182pub const P_ITERATIONS: u32 = 131;
183pub const P_BOLD: u32 = 132;
184pub const P_OVER_SIBLINGS: u32 = 133;
185pub const P_INITIAL_LETTER: u32 = 134;
186
187pub const ALIGNS: &[&str] = &[
192 "start",
193 "center",
194 "end",
195 "spaceBetween",
196 "spaceAround",
197 "spaceEvenly",
198 "baseline",
199];
200pub const WINDOW_ROLES: &[&str] = &["drag", "close", "minimize", "maximize"];
201pub const SCROLLBARS: &[&str] = &["visible", "hidden", "auto"];
206pub const OVERSCROLLS: &[&str] = &["auto", "contain"];
211pub const SCROLL_AXES: &[&str] = &["both", "x", "y"];
215pub const FAMILIES: &[&str] = &["sans", "serif", "mono"];
218pub const CURSORS: &[&str] = &[
221 "default",
222 "text",
223 "pointer",
224 "grab",
225 "grabbing",
226 "notAllowed",
227 "ewResize",
228 "nsResize",
229 "nwseResize",
230 "neswResize",
231];
232
233pub fn cursor_idx(i: usize) -> CursorShape {
234 CURSORS
235 .get(i)
236 .and_then(|n| CursorShape::parse(n))
237 .unwrap_or(CursorShape::Default)
238}
239pub const WRAPS: &[&str] = &["word", "glyph", "none", "break-spaces"];
240pub const UNDERLINE_STYLES: &[&str] = UnderlineStyle::NAMES;
242pub const EXPANDED: &[&str] = &["collapsed", "expanded"];
247pub const LIVE: &[&str] = &["off", "polite", "assertive"];
251pub const ROLES: &[&str] = &[
257 "none",
258 "button",
259 "checkbox",
260 "radio",
261 "switch",
262 "slider",
263 "tab",
264 "tabList",
265 "link",
266 "heading",
267 "list",
268 "listItem",
269 "image",
270 "dialog",
271 "group",
272 "textInput",
273 "multilineTextInput",
274 "line",
275 "radioGroup",
279 "menu",
280 "menuItem",
281 "terminal",
283];
284
285pub const ORIENTATIONS: &[&str] = &["horizontal", "vertical"];
291
292pub const APPEARANCES: &[&str] = &["unknown", "light", "dark"];
298
299pub const MOTIONS: &[&str] = &["unknown", "full", "reduced"];
302
303pub const ASSISTIVE: &[&str] = &["unknown", "none", "listening"];
307
308pub const AUDIO_DEVICES: &[&str] = &["closed", "opening", "open", "failed"];
312
313pub const BACKDROPS: &[&str] = &["opaque", "transparent", "blur", "tinted"];
317
318pub const DERIVED_ONLY: &[(&str, &str)] = &[
325 (
326 "window",
327 "the root node of a frame, named by the window title",
328 ),
329 ("titleBar", "a `windowDrag` node"),
330 ("staticText", "a text node"),
331 ("scrollView", "a `scrollX` / `scrollY` node"),
332];
333
334pub fn role_idx(i: usize) -> Role {
357 ROLES
358 .get(i)
359 .and_then(|n| Role::parse(n))
360 .unwrap_or(Role::Group)
361}
362pub const EASINGS: &[&str] = &[
365 "easeOut",
366 "linear",
367 "easeIn",
368 "easeInOut",
369 "spring",
370 "bouncy",
371 "smooth",
372 "snappy",
373];
374
375pub const REPEATS: &[&str] = &["normal", "reverse", "alternate", "alternateReverse"];
377
378pub fn repeat_idx(i: usize) -> Repeat {
379 Repeat::from_index(i)
380}
381
382pub fn easing_idx(i: usize) -> Easing {
383 Easing::from_index(i)
384}
385
386pub enum Kind {
388 F32,
390 Color,
393 Flag,
395 Enum(&'static [&'static str]),
397 Sizing,
403 Min,
408 Max,
412 Msg,
414 Tag,
421 Str,
423 Family,
427 Resource,
431 Keyframes,
435 Enter,
438 Gradient,
442}
443
444pub enum Apply {
446 SpecF32(fn(NodeSpec, f32) -> NodeSpec),
447 SpecColor(fn(NodeSpec, Color) -> NodeSpec),
448 SpecFlag(fn(NodeSpec) -> NodeSpec),
449 SpecEnum(fn(NodeSpec, usize) -> NodeSpec),
450 SpecSizing(fn(NodeSpec, Sizing) -> NodeSpec),
451 SpecBound(fn(NodeSpec, Bound) -> NodeSpec),
452 SpecMsg(fn(NodeSpec, Value) -> NodeSpec),
453 SpecStr(fn(NodeSpec, &str) -> NodeSpec),
454 SpecKeyframes(fn(NodeSpec, Vec<Keyframe>) -> NodeSpec),
455 SpecEnter(fn(NodeSpec, Enter) -> NodeSpec),
456 SpecGradient(fn(NodeSpec, crate::gradient::Gradient) -> NodeSpec),
457 SpecResource(fn(NodeSpec, u64) -> NodeSpec),
458 StyleF32(fn(TextStyle, f32) -> TextStyle),
459 StyleColor(fn(TextStyle, Color) -> TextStyle),
460 StyleEnum(fn(TextStyle, usize) -> TextStyle),
461 StyleFlag(fn(TextStyle) -> TextStyle),
462 StyleResource(fn(TextStyle, u64) -> TextStyle),
463 StyleStr(fn(TextStyle, &str) -> TextStyle),
464 StyleFamily(fn(TextStyle, FontFamily) -> TextStyle),
465}
466
467#[derive(Clone, Copy, Debug, PartialEq, Eq)]
468pub enum Target {
469 Spec,
471 Style,
473}
474
475pub struct PropDef {
476 pub name: &'static str,
478 pub id: u32,
479 pub kind: Kind,
480 pub apply: Apply,
481 pub doc: &'static str,
482}
483
484impl PropDef {
485 pub fn target(&self) -> Target {
486 match self.apply {
487 Apply::StyleF32(_)
488 | Apply::StyleColor(_)
489 | Apply::StyleEnum(_)
490 | Apply::StyleFlag(_)
491 | Apply::StyleResource(_)
492 | Apply::StyleStr(_)
493 | Apply::StyleFamily(_) => Target::Style,
494 _ => Target::Spec,
495 }
496 }
497
498 pub fn snake_name(&self) -> &'static str {
500 SNAKE_NAMES[self.index()]
501 }
502
503 fn index(&self) -> usize {
504 PROPS
507 .iter()
508 .position(|d| d.name == self.name)
509 .expect("PropDef not from PROPS")
510 }
511}
512
513pub fn align_idx(i: usize) -> Align {
514 match i {
515 1 => Align::Center,
516 2 => Align::End,
517 3 => Align::SpaceBetween,
518 4 => Align::SpaceAround,
519 5 => Align::SpaceEvenly,
520 6 => Align::Baseline,
521 _ => Align::Start,
522 }
523}
524
525pub fn min_num(mode: u32, value: f64) -> Bound {
529 match mode {
530 1 => Bound::Fit,
531 _ => Bound::Px(value as f32),
532 }
533}
534
535pub fn sizing_num(mode: u32, value: f64) -> Sizing {
537 match mode {
538 1 => Sizing::Fit,
539 2 => Sizing::Grow(value as f32),
540 3 => Sizing::Percent(value as f32),
541 _ => Sizing::Fixed(value as f32),
542 }
543}
544
545pub const PROPS: &[PropDef] = &[
546 PropDef {
547 name: "width",
548 id: P_WIDTH,
549 kind: Kind::Sizing,
550 apply: Apply::SpecSizing(|s, v| s.width(v)),
551 doc: "Horizontal size: px | \"fit\" | \"grow\" | \"N%\" | a size expression — \
552 `\"clamp(400px, 80%, 1000px)\"`, `\"min(720px, 100%)\"`, `\"max(50%, 300)\"`, \
553 nested — which layout resolves against the parent's content box, the box a \
554 percentage takes its cut of (backlog F109). An expression with no percentage \
555 in it is a length; a calc does not ease under `transition`. A percentage \
556 or an expression gives, with the fit children, when its parent overflows \
557 — two `\"50%\"` children and a gap fit their row (backlog F110) — where a \
558 px size keeps its own. A row holding one gives as CSS's flex items do: \
559 every child that can give gives in proportion to its size, and stops at \
560 its content — the widest thing in it that cannot wrap, a label's longest \
561 word — unless `minWidth` says otherwise (backlog RG92). The process keeps \
562 65 536 distinct expressions and never lets one go: past that a new one leaves \
563 its prop at its default, with a `size-expressions-full` warning, so declare \
564 one per layout — a px size for the part that moves each frame, a splitter's \
565 drag — not one per frame (backlog RG93).",
566 },
567 PropDef {
568 name: "height",
569 id: P_HEIGHT,
570 kind: Kind::Sizing,
571 apply: Apply::SpecSizing(|s, v| s.height(v)),
572 doc: "Vertical size: px | \"fit\" | \"grow\" | \"N%\" | a size expression (see `width`).",
573 },
574 PropDef {
575 name: "minWidth",
576 id: P_MIN_W,
577 kind: Kind::Min,
578 apply: Apply::SpecBound(|s, v| s.min_width(v)),
579 doc: "Lower width clamp: logical px, a size expression (see `width`; a percentage \
580 clamp is none until the parent's width is known, as in CSS), or \"fit\" for \
581 the node's own fit width. \
582 \"fit\" under `width=\"grow\"` is a content floor — CSS's `flex: 1 0 auto` — \
583 which is what an i3-style tab bar is: tabs that split the bar evenly \
584 while they fit and sit at their label's width, scrolling, once they do \
585 not. Opt-in, because a fit width is the unwrapped one: a paragraph in a \
586 grow column would stop wrapping under it. Left out, a child giving in an \
587 overflowing row that holds a percentage or a size expression stops at its \
588 content, CSS's `min-width: auto`; `0` lets it go below, CSS's \
589 `min-width: 0` (backlog RG92). A fit node across a column is no wider \
590 than the column's box — CSS's `fit-content` — down to this floor, 0 left \
591 out, unless the column scrolls x, so a text one wrapper deep in a capped \
592 card wraps there; \"fit\" keeps its content's width and runs past \
593 (backlog F116).",
594 },
595 PropDef {
596 name: "maxWidth",
597 id: P_MAX_W,
598 kind: Kind::Max,
599 apply: Apply::SpecBound(|s, v| s.max_width(v)),
600 doc: "Upper width clamp: logical px or a size expression (see `width`); \
601 grow+maxWidth is the responsive-width pattern.",
602 },
603 PropDef {
604 name: "minHeight",
605 id: P_MIN_H,
606 kind: Kind::Min,
607 apply: Apply::SpecBound(|s, v| s.min_height(v)),
608 doc: "Lower height clamp: logical px, a size expression, or \"fit\" for the node's own fit height. Undeclared, it is the node's content where its column overflows — CSS's `min-height: auto`, none for a node that scrolls or clips — so a row keeps the height of its text; `0` asks for the squeeze back (see `minWidth`).",
609 },
610 PropDef {
611 name: "maxHeight",
612 id: P_MAX_H,
613 kind: Kind::Max,
614 apply: Apply::SpecBound(|s, v| s.max_height(v)),
615 doc: "Upper height clamp: logical px or a size expression (see `width`).",
616 },
617 PropDef {
618 name: "gap",
619 id: P_GAP,
620 kind: Kind::F32,
621 apply: Apply::SpecF32(|s, v| s.gap(v)),
622 doc: "Space between children along the main axis.",
623 },
624 PropDef {
628 name: "wrapChildren",
629 id: P_WRAP_CHILDREN,
630 kind: Kind::Flag,
631 apply: Apply::SpecFlag(NodeSpec::wrap),
632 doc: "Children that don't fit the main axis start a new line instead of overflowing or shrinking. Rows only (a column is ignored, with a warning), and never on a scrollX row.",
633 },
634 PropDef {
635 name: "crossGap",
636 id: P_CROSS_GAP,
637 kind: Kind::F32,
638 apply: Apply::SpecF32(|s, v| s.cross_gap(v)),
639 doc: "Space between wrap lines, across the main axis (`gap` stays the space along it).",
640 },
641 PropDef {
642 name: "mainAlign",
643 id: P_MAIN_ALIGN,
644 kind: Kind::Enum(ALIGNS),
645 apply: Apply::SpecEnum(|s, i| s.main_align(align_idx(i))),
646 doc: "Child alignment along the main axis. `start`, `center` and `end` put the children together; `spaceBetween` deals the free space out between them (none at the ends), `spaceAround` gives each child an equal share split to its two sides, and `spaceEvenly` makes every gap and both ends equal — CSS's `justify-content`. The spread is added to `gap`, and there is none when nothing is free: a `grow` child takes it all, and an overflowing run keeps its gaps. `baseline` means nothing here and lays out as `start`, with a warning.",
647 },
648 PropDef {
649 name: "crossAlign",
650 id: P_CROSS_ALIGN,
651 kind: Kind::Enum(ALIGNS),
652 apply: Apply::SpecEnum(|s, i| s.cross_align(align_idx(i))),
653 doc: "Child alignment across the main axis. On a row, `baseline` lines up the first baselines of the children's text, so a label and a larger value read as one line; a child with no text aligns by its bottom edge, a `grow` or percent height fills the line from its top, and a fit-height row grows to hold the aligned children. A column lays `baseline` out as `start` (as CSS does), and the three spreads mean nothing across an axis — each with a warning.",
654 },
655 PropDef {
656 name: "aspectRatio",
657 id: P_ASPECT_RATIO,
658 kind: Kind::F32,
659 apply: Apply::SpecF32(|s, v| s.aspect_ratio(v)),
660 doc: "Width over height — `16/9`, `1` for a square — CSS's `aspect-ratio`. It sizes the axis left `fit`: a fit height is the final width over the ratio (so `width: grow` and a ratio is a box that keeps its shape as the window resizes), and a fit width under a fixed height is that height times it. With both axes declared, or a fit width under a `grow` or percent height, it has nothing it can set and warns. The derived axis is neither shrunk nor fitted to the children, which overflow it; `minHeight: 'fit'` floors it at them. On an image it wins over the pixels' own aspect.",
661 },
662 PropDef {
663 name: "bg",
664 id: P_BG,
665 kind: Kind::Color,
666 apply: Apply::SpecColor(|s, c| s.bg(c)),
667 doc: "Background fill.",
668 },
669 PropDef {
670 name: "radius",
671 id: P_RADIUS,
672 kind: Kind::F32,
673 apply: Apply::SpecF32(|s, v| s.radius(v)),
674 doc: "Corner radius for all four corners (logical px); the per-corner props override it when listed after it. On a node that also clips or scrolls it rounds the clip as well, so children stay inside the corners.",
675 },
676 PropDef {
677 name: "opacity",
678 id: P_OPACITY,
679 kind: Kind::F32,
680 apply: Apply::SpecF32(|s, v| s.opacity(v)),
681 doc: "Group opacity 0..1 (default 1): fades this node and its whole subtree. A per-quad alpha multiply rather than an offscreen composite, so overlapping pieces of one subtree show their seams through the fade. Layout, hit-testing and the access tree are untouched; eases with `transition`, and `enter: { opacity: 0 }` fades a panel in.",
682 },
683 PropDef {
684 name: "pixelSnap",
685 id: P_PIXEL_SNAP,
686 kind: Kind::Flag,
687 apply: Apply::SpecFlag(|s| s.pixel_snap()),
688 doc: "Paint this node's background, border, shadow and fragment with each edge on a whole physical pixel: `x` and `x + width` rounded on their own, from where layout put them, as a text's span backgrounds are. Off by default, and a box is drawn where layout put it, so a 1 px `gap` between boxes is there at any scale. On, boxes that share an edge in layout meet on one pixel line, where a join inside a pixel was drawn by halves and left a seam — rows of a band stacked at a pitch that is not whole pixels, or a box that continues a text's selection. Layout, hit-testing, the clip and the children are untouched. A snapped box can draw up to half a pixel from its layout edge and its size can differ by a pixel, so a snapped hairline is 1 or 2 px thick by where it sits.",
689 },
690 PropDef {
691 name: "shadowColor",
692 id: P_SHADOW_COLOR,
693 kind: Kind::Color,
694 apply: Apply::SpecColor(|s, c| s.shadow_color(c)),
695 doc: "Drop-shadow color; nothing else about a shadow draws without it. On its own it is a hard shadow exactly behind the node — add `shadowBlur` / `shadowY` to lift it. Outer shadows only, and the shape is not knocked out of the middle, so a translucent background shows it through.",
696 },
697 PropDef {
698 name: "shadowBlur",
699 id: P_SHADOW_BLUR,
700 kind: Kind::F32,
701 apply: Apply::SpecF32(|s, v| s.shadow_blur(v)),
702 doc: "Drop-shadow blur radius (logical px): the edge ramps over this distance and reaches this far past the shape. 0 = a hard edge.",
703 },
704 PropDef {
705 name: "shadowX",
706 id: P_SHADOW_X,
707 kind: Kind::F32,
708 apply: Apply::SpecF32(|s, v| s.shadow_x(v)),
709 doc: "Drop-shadow horizontal offset (logical px).",
710 },
711 PropDef {
712 name: "shadowY",
713 id: P_SHADOW_Y,
714 kind: Kind::F32,
715 apply: Apply::SpecF32(|s, v| s.shadow_y(v)),
716 doc: "Drop-shadow vertical offset (logical px); positive casts downward.",
717 },
718 PropDef {
719 name: "shadowSpread",
720 id: P_SHADOW_SPREAD,
721 kind: Kind::F32,
722 apply: Apply::SpecF32(|s, v| s.shadow_spread(v)),
723 doc: "Grows (or, negative, shrinks) the drop shadow's shape before blurring (logical px).",
724 },
725 PropDef {
726 name: "radiusTL",
727 id: P_RADIUS_TL,
728 kind: Kind::F32,
729 apply: Apply::SpecF32(|s, v| s.radius_tl(v)),
730 doc: "Top-left corner radius (logical px).",
731 },
732 PropDef {
733 name: "radiusTR",
734 id: P_RADIUS_TR,
735 kind: Kind::F32,
736 apply: Apply::SpecF32(|s, v| s.radius_tr(v)),
737 doc: "Top-right corner radius (logical px).",
738 },
739 PropDef {
740 name: "radiusBR",
741 id: P_RADIUS_BR,
742 kind: Kind::F32,
743 apply: Apply::SpecF32(|s, v| s.radius_br(v)),
744 doc: "Bottom-right corner radius (logical px).",
745 },
746 PropDef {
747 name: "radiusBL",
748 id: P_RADIUS_BL,
749 kind: Kind::F32,
750 apply: Apply::SpecF32(|s, v| s.radius_bl(v)),
751 doc: "Bottom-left corner radius (logical px).",
752 },
753 PropDef {
754 name: "center",
755 id: P_CENTER,
756 kind: Kind::Flag,
757 apply: Apply::SpecFlag(|s| s.center()),
758 doc: "Center children on both axes.",
759 },
760 PropDef {
761 name: "hoverable",
762 id: P_HOVERABLE,
763 kind: Kind::Flag,
764 apply: Apply::SpecFlag(|s| s.hoverable()),
765 doc: "Hover-track without a click payload (for isHovered-driven styling).",
766 },
767 PropDef {
768 name: "animate",
769 id: P_ANIMATE,
770 kind: Kind::Flag,
771 apply: Apply::SpecFlag(|s| s.animate()),
772 doc: "Ask for another frame after this one, every frame this node is declared. What a `fragment` that reads `time` needs, and what anything driving itself off the clock rather than off input needs. Opt-in like `exit`, and for the same reason: it takes the loop off input-driven and onto the display's cadence for as long as it is declared, so a still node must not carry it. One node asking is enough for the whole window.",
773 },
774 PropDef {
775 name: "accent",
776 id: P_ACCENT,
777 kind: Kind::Flag,
778 apply: Apply::SpecFlag(|s| s.accent()),
779 doc: "Paint this node's background in the OS accent colour — `env.system.accent` — keeping the declared `bg` on a host that cannot tell what it is. The one prop whose paint depends on the environment, which is why it is opt-in: the same tree is a different colour on two machines, and that is the point here and a surprise anywhere else. On the stock button it does the whole job — the hover and pressed shades are derived from the accent, and the label goes black or white by its luminance, so a yellow accent is still readable — which is what `<button accent>` is for.",
780 },
781 PropDef {
782 name: "selectable",
783 id: P_SELECTABLE,
784 kind: Kind::Flag,
785 apply: Apply::SpecFlag(|s| s.selectable()),
786 doc: "Makes this node a selection scope: the text of every node inside it is one selectable run, in tree order, and a press-drag across them selects the lot — as do Shift with Left / Right / Home / End on a focused node inside it, a character or a word at a time, a scope with nothing selected anchoring at its start (`docs/adr/0017-selection-as-a-scope.md`). Declared on the container and not on each label, because what a reader selects is a paragraph or a card rather than one run of it — three labels in a column under one `selectable` select as three lines of one text. The selection is the window's: starting one anywhere clears the last, an editor's included. Scopes do not nest; an outer one around an inner one is warned about (`nested-selection-scope`) and the innermost owns the text. Text scrolled out of view inside the scope is still part of it — selection and copy reach it, hit-testing does not. On a `cells` grid the scope selects in cells rather than in bytes: a drag takes lines (with a modifier, a rectangle), a double click the word under the pointer and a triple click the whole row, its ends are absolute lines so a scroll does not move them, and a copy trims each line's trailing blanks.",
787 },
788 PropDef {
789 name: "focusable",
790 id: P_FOCUSABLE,
791 kind: Kind::Flag,
792 apply: Apply::SpecFlag(|s| s.focusable()),
793 doc: "Reachable by Tab (and focused by a click) without a click payload or a control role — a row that opens on Enter. Editors, key sinks, `onClick` boxes and the control roles are focusable already.",
794 },
795 PropDef {
796 name: "keepFocus",
797 id: P_KEEP_FOCUS,
798 kind: Kind::Flag,
799 apply: Apply::SpecFlag(|s| s.keep_focus()),
800 doc: "A press on this node, or anywhere inside it, leaves keyboard focus where it was: a toolbar button, a tab or a divider that acts without taking the keyboard from the editor or key sink that had it. Without it a press on an `onClick` node focuses the node, and the app's keys stop reaching the sink until it takes focus back. The press also leaves a text or cell selection and the Tab ring where they were, so a Copy button copies what was selected. An `<edit>` inside still takes its caret and focus, as the keyboard's own owner. The click, drag and hover are unchanged, and Tab and assistive technology still reach the node.",
801 },
802 PropDef {
803 name: "focusRegion",
804 id: P_FOCUS_REGION,
805 kind: Kind::Flag,
806 apply: Apply::SpecFlag(|s| s.focus_region()),
807 doc: "Makes this node's subtree a focus region: a Tab ring of its own that the ring outside never enters and that never leaves — a devtools dock, an inspector beside the app (`docs/adr/0022-focus-regions.md`). Entered on purpose: `focusRegion(name)` (`Ui::focus_region`, `env.focus_region`, `kui_focus_region`) moves focus in — to the focus the region last held, else its `initialFocus`, else its first stop — and `focusRegion(null)` moves it back to the main ring the same way; a press inside the region, or an explicit focus on a node in it, enters it too. Tab then walks that ring alone, wrapping inside it; with nothing focused, Tab enters the ring of the region in effect (`region()`). A region that stops being declared hands focus back to what the main ring last held. Only the ring is scoped: keys still bubble through the boundary to the sink above (a region that wants its own keymap is an `onKey` sink), the pointer and assistive technology see a plain node, and a `modal` in effect is the ring wherever it sits. Nested regions are skipped by the outer ring the way the main ring skips them.",
808 },
809 PropDef {
810 name: "scrollbar",
811 id: P_SCROLLBAR,
812 kind: Kind::Enum(SCROLLBARS),
813 apply: Apply::SpecEnum(|s, i| s.scrollbar(crate::spec::ScrollbarMode::ALL[i])),
814 doc: "When a scrolling node draws its bars: `visible` (the default — the stock overlay thumb, drawn while the content overflows), `hidden` (no thumb, no track to press; the wheel, the keyboard, `reveal` and the caret still scroll it — for a list that draws its own indicator, or a pane whose bar would sit on a border), or `auto` (shown while the scroll state is changing — the offset or the content's extent moved, the pointer is on the track, a thumb is dragged — and for a second after, then faded out over a quarter of one; a node first seen shows it the same second; what an overlay bar does on macOS). `auto` needs the driver's clock and is `visible` without one. The bars are overlays and take no layout space in any mode. From the last change until it has faded — a second and a quarter — an `auto` bar asks for frames the way a transition of that length would (nothing else could wake the core when the hold ends); while the pointer holds it, it asks for none.",
815 },
816 PropDef {
817 name: "anchor",
818 id: P_ANCHOR,
819 kind: Kind::Flag,
820 apply: Apply::SpecFlag(|s| s.anchor()),
821 doc: "Scroll anchoring on a scrolling node (backlog C26, CSS's `overflow-anchor`): the first child in view keeps its place on screen when the content before it changes size — a chat that prepends history, a log that inserts rows above the viewport, a list whose row heights are corrected as they are measured — with no `setScroll` and no arithmetic in the view. The core remembers which child was first in view and where its edge was, and moves the offset by however far that edge moved in the next layout, before the offset is clamped; a wheel notch or a `setScroll` between the frames is kept and the correction added to it. The child is found by key, so give the rows stable keys (a `key` or an `index`); a child that is gone anchors nothing that frame. On the scroll axis that is the node's main axis only — `scrollY` on a column, `scrollX` on a row — and content appended *after* the anchor moves nothing, so a log that is tailing still asks for the end itself.",
822 },
823 PropDef {
824 name: "scrollbarWidth",
825 id: P_SCROLLBAR_WIDTH,
826 kind: Kind::F32,
827 apply: Apply::SpecF32(|s, v| s.scrollbar_width(v)),
828 doc: "The thumb's width at rest, logical px (default 4); under the pointer or dragged it is 2 px wider. The grabbable track grows to fit a wide thumb.",
829 },
830 PropDef {
831 name: "scrollbarColor",
832 id: P_SCROLLBAR_COLOR,
833 kind: Kind::Color,
834 apply: Apply::SpecColor(|s, c| s.scrollbar_color(c)),
835 doc: "The thumb at rest; the default is the theme's `scrollbar` role, a translucent wash over whatever it sits on.",
836 },
837 PropDef {
838 name: "scrollbarActiveColor",
839 id: P_SCROLLBAR_ACTIVE_COLOR,
840 kind: Kind::Color,
841 apply: Apply::SpecColor(|s, c| s.scrollbar_active_color(c)),
842 doc: "The thumb under the pointer or while dragged; the default is the theme's `scrollbar_active` role.",
843 },
844 PropDef {
845 name: "overscroll",
846 id: P_OVERSCROLL,
847 kind: Kind::Enum(OVERSCROLLS),
848 apply: Apply::SpecEnum(|s, i| s.overscroll(crate::spec::Overscroll::ALL[i])),
849 doc: "What a scroll gesture that starts over this scroller does when it is already at its limit that way (backlog F107, CSS's `overscroll-behavior`): `auto` (the default) passes the gesture on to the scroller around it, `contain` keeps it here, moving nothing until it turns back. A gesture picks its target once, when it starts — the innermost scroller under the pointer that can still move the way it goes — and keeps it until it ends, wherever the pointer or the content has gone; one that reaches a limit midway stops there, whatever this says. Only on the axes the node scrolls: a `scrollY` list that contains still passes a sideways swipe to the strip around it. For a panel or a popup's list whose scrolling must never move what is behind it.",
850 },
851 PropDef {
852 name: "disabled",
853 id: P_DISABLED,
854 kind: Kind::Flag,
855 apply: Apply::SpecFlag(|s| s.disabled(true)),
856 doc: "Inert: no click, drag or key sink, no hover / pressed / focus background, skipped by Tab, reported disabled to assistive technology; hover tracking stays so a `tooltip` can say why.",
857 },
858 PropDef {
859 name: "hoverBg",
860 id: P_HOVER_BG,
861 kind: Kind::Color,
862 apply: Apply::SpecColor(|s, c| s.hover_bg(c)),
863 doc: "Background while hovered (or while any node in its hoverGroup is); implies hover tracking, eases with `transition`.",
864 },
865 PropDef {
866 name: "gradient",
867 id: P_GRADIENT,
868 kind: Kind::Gradient,
869 apply: Apply::SpecGradient(|s, g| s.gradient(g)),
870 doc: "A gradient painted over the node's `bg` and under its border and its children (`docs/adr/0042-a-gradient-is-an-image-the-core-paints.md`): `{ to: 'bottom', stops: [...] }` towards a side or a corner (`right`, `bottom left`, …; the default is `bottom`), `{ angle: 0.125, stops }` in turns clockwise from east, or `{ radial: true, at: [0.5, 0], stops }` out from a centre (fractions of the box, the middle by default) to its farthest corner. A stop is a colour — a `$token` too — or `[colour, position]` with the position 0 to 1; stops without one are spaced evenly between those with. Two stops at one position are a hard edge. The gradient is defined on the box's unit square and stretched to it, so a side or a corner is CSS's and any other `angle` runs corner to corner at an eighth of a turn whatever the box's aspect, where CSS's pixel-measured `45deg` does not. Stops mix in straight sRGB with the alpha premultiplied, as CSS's do. What it costs is one image quad: the core rasterizes each distinct gradient once into the glyph atlas — a 256-texel strip along an axis, a 128-texel square otherwise, within half an 8-bit level of the gradient computed per pixel for a linear one and 1.2 for a radial — keyed by the gradient and not the box, so a box that resizes and a thousand boxes that share one rasterize nothing, and a host that draws an image draws it; a gradient box costs about 55 ns over a flat one, so ten thousand of them are half a millisecond. A hard edge is as soft as the raster stretched to the box (a 256th of its length along a strip); stripes are boxes. It does not tween — `transition` eases the `bg` under it and `opacity` fades it — and `hoverBg` and the other state backgrounds replace `bg`, not the gradient; one that changes every frame is a raster a frame, and a shimmer is a `fragment`'s. Ignored on a `line`, a `polygon` and a `path`. Fewer than two stops are an error in JSX and Lua, as a malformed `keyframes` is, and draw nothing in Rust and C. A stop whose `$token` misses is not an error: it is raised as `unknown-token` and left out, as a miss leaves any slot unset, and the rest are spaced as if it had not been declared — so a gradient left with fewer than two stops, a two-stop one with a typo, draws nothing over its `bg` (backlog RG118).",
871 },
872 PropDef {
873 name: "backdropBlur",
874 id: P_BACKDROP_BLUR,
875 kind: Kind::F32,
876 apply: Apply::SpecF32(|s, v| s.backdrop_blur(v)),
877 doc: "Blur what was drawn beneath the node, inside its rounded box, by this radius in logical px — CSS's `backdrop-filter: blur()`, the radius its standard deviation (backlog F129). What blurs is everything painted before the node: its ancestors' backgrounds, the siblings under it, content scrolling beneath it, the window's `backdrop` where the window has one. The node's own `bg`, border and children paint over the blur, so a translucent `bg` (`#ffffff40`) makes frosted glass and an opaque one hides it. Clipped as the node is, faded by its `opacity`; 0 is none. The GPU renderer reads back only the box (and a margin of three radii around it) and blurs it at reduced resolution, so it costs a copy and three small passes per blurred node on a frame that has one and nothing on a frame that does not. A renderer that cannot read back what it drew — a host's own, or anything older — leaves the node over an unblurred backdrop; the display list carries it as a `backdrop` quad (`KUI_QUAD_BACKDROP` in C) either way.",
878 },
879 PropDef {
880 name: "rotate",
881 id: P_ROTATE,
882 kind: Kind::F32,
883 apply: Apply::SpecF32(|s, v| s.rotate(v)),
884 doc: "Turns this node and everything under it, in turns clockwise (0.25 is a quarter turn right), about its pivot — the centre unless `pivotX` / `pivotY` say — after layout (`docs/adr/0043-a-node-turns-about-its-pivot.md`). Paint-only: the node takes the room its upright self takes, nothing around it moves, `onLayout` reports the layout rect. Everything the subtree draws turns with it — backgrounds, borders, shadows, text, images, strokes, fragments — and so does what it clips: a child cut by a turned card's rounded corners stays inside them. Hit where drawn: a tilted card is grabbed on its tilted edge and a press in its box past its edge falls through; drag payloads stay in viewport px. The access rect is the bounding box. Nests by composition. Tweens with `transition` as one slot with `scale`, and an entrance, an exit or a keyframe stop may name it (`enter: { rotate: -0.02 }`, `keyframes: [{ rotate: 0 }, { rotate: 1 }]` spins a box). A float anchored to the parent turns with it; a viewport float does not. On a `path` this is the path's own turn (ADR 0041), which does not tween — wrap it in a box for one that does. Text under a turn leaves the pixel grid, as a turned mask does. `backdropBlur` under a turn blurs the upright box.",
885 },
886 PropDef {
887 name: "scale",
888 id: P_SCALE,
889 kind: Kind::F32,
890 apply: Apply::SpecF32(|s, v| s.scale(v)),
891 doc: "Scales this node and everything under it by this factor, uniformly, about its pivot, after layout (`docs/adr/0043-a-node-turns-about-its-pivot.md`); 1 is none. 0 draws nothing in Rust, Node and Lua; in C and Odin, where a zeroed field is unset, 0 is 1. Paint-only, as `rotate` is: layout, the room taken and `onLayout` are the upright node's; what it draws, clips and hits scales. Tweens with `transition` as one slot with `rotate`; `enter: { scale: 0.8 }` settles a chip in, `keyframes: [{ scale: 1.05, at: 0.5 }]` pulses. The edge ramps scale with the box, so a box scaled far up reads soft.",
892 },
893 PropDef {
894 name: "pivotX",
895 id: P_PIVOT_X,
896 kind: Kind::F32,
897 apply: Apply::SpecF32(|s, v| {
898 let fy = s.transform_spec().map_or(0.5, |t| t.pivot.y);
899 s.pivot(v, fy)
900 }),
901 doc: "Where across the box `rotate` and `scale` are about, as a fraction of its width: 0 the left edge, 0.5 (the default) the middle, 1 the right edge; outside 0..1 is a point past the box. C: `pivot_x` with `pivot_set`.",
902 },
903 PropDef {
904 name: "pivotY",
905 id: P_PIVOT_Y,
906 kind: Kind::F32,
907 apply: Apply::SpecF32(|s, v| {
908 let fx = s.transform_spec().map_or(0.5, |t| t.pivot.x);
909 s.pivot(fx, v)
910 }),
911 doc: "Where down the box `rotate` and `scale` are about, as a fraction of its height: 0 the top, 0.5 (the default) the middle, 1 the bottom. C: `pivot_y` with `pivot_set`.",
912 },
913 PropDef {
914 name: "rules",
915 id: P_RULES,
916 kind: Kind::Color,
917 apply: Apply::SpecColor(|s, c| s.rules(c)),
918 doc: "On a table (`dir=\"table\"`, ADR 0033): grid lines of this colour between its columns and between its rows (backlog DX21) — down the middle of each gap between the columns of its widest row, from the first row's top to the last row's bottom, and across the middle of each gap between rows, the content box wide. Drawn with the table's box, under its cells and on whole pixels, so give the table and its rows a `gap` at least `ruleWidth` for the lines to show between cells; the outer edge is the table's `border`. Ignored on anything but a table.",
919 },
920 PropDef {
921 name: "ruleWidth",
922 id: P_RULE_WIDTH,
923 kind: Kind::F32,
924 apply: Apply::SpecF32(|s, v| s.rule_width(v)),
925 doc: "The width of a table's `rules` in logical px; 1 when unset.",
926 },
927 PropDef {
928 name: "dropBg",
929 id: P_DROP_BG,
930 kind: Kind::Color,
931 apply: Apply::SpecColor(|s, c| s.drop_bg(c)),
932 doc: "Background while files dragged in from the OS are over this node (ADR 0031); wins over pressedBg, focusBg and hoverBg, clears when they leave, land or the drag is cancelled. Implies hover tracking, eases with `transition`.",
933 },
934 PropDef {
935 name: "pressedBg",
936 id: P_PRESSED_BG,
937 kind: Kind::Color,
938 apply: Apply::SpecColor(|s, c| s.pressed_bg(c)),
939 doc: "Background while pressed (or while its hoverGroup is); implies hover tracking.",
940 },
941 PropDef {
942 name: "focusBg",
943 id: P_FOCUS_BG,
944 kind: Kind::Color,
945 apply: Apply::SpecColor(|s, c| s.focus_bg(c)),
946 doc: "Background while the node holds keyboard-visible focus (moved there by Tab or assistive technology, not a click); replaces the default focus ring. Pressed wins over focus wins over hover; eases with `transition`.",
947 },
948 PropDef {
949 name: "modal",
950 id: P_MODAL,
951 kind: Kind::Tag,
952 apply: Apply::SpecMsg(|s, v| s.modal(v)),
953 doc: "Modal surface: the Tab ring becomes this node's subtree, everything outside it is inert to the pointer, the wheel and assistive technology, and Escape or a press outside emits {kind:\"dismiss\", reason:\"escape\"|\"outside\", tag} on it — the app stops declaring the node. The last one declared in tree order is the one in effect (a confirm inside a dialog); a modal that must cover the app is a float. The access tree is not pruned to the modal: it keeps every node of the frame and marks the one in effect `modal` (`docs/adr/0003-modal-surfaces.md`, decision 7), which is what assistive technology acts on.",
954 },
955 PropDef {
956 name: "initialFocus",
957 id: P_INITIAL_FOCUS,
958 kind: Kind::Flag,
959 apply: Apply::SpecFlag(|s| s.initial_focus()),
960 doc: "Where focus lands when the enclosing `modal` scope is entered: the first node in the modal\'s Tab ring declaring it, so a destructive confirm opens on its Cancel rather than on whichever control is declared first. Read on entry only — a Tab press afterwards stands, and the scope re-entered (a nested confirm closing) leaves focus where it was. Declared on nothing, or only on nodes the ring skips (disabled, `role=\"none\"`, not focusable), entry stays the ring\'s first node.",
961 },
962 PropDef {
963 name: "hoverGroup",
964 id: P_HOVER_GROUP,
965 kind: Kind::Str,
966 apply: Apply::SpecStr(|s, name| s.hover_group(name)),
967 doc: "Nodes sharing a group name show hoverBg/pressedBg together (a split button, a multi-piece shape).",
968 },
969 PropDef {
970 name: "onHover",
971 id: P_ON_HOVER,
972 kind: Kind::Tag,
973 apply: Apply::SpecMsg(|s, v| s.on_hover(v)),
974 doc: "Hover tag: the pointer entering/leaving emits {kind:\"hover\", phase:\"enter\"|\"leave\", tag} events.",
975 },
976 PropDef {
977 name: "onDrop",
978 id: P_ON_DROP,
979 kind: Kind::Tag,
980 apply: Apply::SpecMsg(|s, v| s.on_drop(v)),
981 doc: "Drop-zone tag (`docs/adr/0031-a-drop-zone-is-a-row-and-the-files-are-an-event.md`): files dragged in from the OS over this node emit {kind:\"drop\", phase:\"enter\"|\"move\"|\"leave\"|\"drop\", paths, x, y, tag} — `paths` the OS paths as strings, `x`/`y` the pointer in logical viewport coordinates (absent on `leave`). The zone under the files is the topmost zone by paint order: a node inside a zone is the zone's (a button in it, a field in it), and a node that is no zone and has none enclosing it is looked past, so an overlay shown on `enter` cannot make the zone lose the files. No `leave` follows a `drop`; a drop off every zone is refused by the driver. Implies hover tracking. No access row — a screen-reader user's way in is a button beside the zone. On Windows and Linux the position is the OS cursor at enter and release only, so `move` never fires there.",
982 },
983 PropDef {
984 name: "onLayout",
985 id: P_ON_LAYOUT,
986 kind: Kind::Tag,
987 apply: Apply::SpecMsg(|s, v| s.on_layout(v)),
988 doc: "Layout tag: the node's laid-out rect arrives as {kind:\"layout\", x, y, w, h, parent, tag} on its first frame and whenever it changes (needs a stable key).",
989 },
990 PropDef {
991 name: "onClick",
992 id: P_ON_CLICK,
993 kind: Kind::Msg,
994 apply: Apply::SpecMsg(|s, v| s.on_click(v)),
995 doc: "Message emitted when clicked (data, not a callback).",
996 },
997 PropDef {
998 name: "onDrag",
999 id: P_ON_DRAG,
1000 kind: Kind::Tag,
1001 apply: Apply::SpecMsg(|s, v| s.on_drag(v)),
1002 doc: "Drag tag: emits {kind:\"drag\", phase, x, y, dx, dy, parent, tag} events, `dx`/`dy` measured from the press point in every phase. On a `cells` grid the events also carry `cell: {row, col}`; inside an `onKey` sink that draws `role=\"line\"` rows they carry `line`, `byte` and `clicks` — see the events table.",
1003 },
1004 PropDef {
1005 name: "onKey",
1006 id: P_ON_KEY,
1007 kind: Kind::Tag,
1008 apply: Apply::SpecMsg(|s, v| s.on_key(v)),
1009 doc: "Key-sink tag: with key focus held, presses arrive as {kind:\"key\", phase:\"down\", code, ...} events. Releases only with `keyUp` beside it.",
1010 },
1011 PropDef {
1012 name: "keyUp",
1013 id: P_KEY_UP,
1014 kind: Kind::Flag,
1015 apply: Apply::SpecFlag(|s| s.key_up()),
1016 doc: "With `onKey`: releases arrive too, as the same payload with phase:\"up\" (`text` null, `repeat` false) — for a held-key interaction (WASD, press-and-hold, a key that arms a mode while it is down). A key only comes up where it went down: a release whose press the sink never got is dropped, and focus leaving while a key is held delivers the `up` first, so nothing is left stuck down. Without it a sink hears presses only, which is what a keymap wants — one that heard both halves would run every binding twice.",
1017 },
1018 PropDef {
1019 name: "modifierKeys",
1020 id: P_MODIFIER_KEYS,
1021 kind: Kind::Flag,
1022 apply: Apply::SpecFlag(|s| s.modifier_keys()),
1023 doc: "With `onKey`: the modifier and lock keys arrive as keys of their own (backlog F108) — `code` \"shift\", \"ctrl\", \"alt\", \"super\", \"capslock\", \"numlock\", \"scrolllock\", which side in `location` (\"left\" / \"right\"), releases too with `keyUp`. Without it a modifier is only ever held — the next key's `shift`, `ctrl`, … and the `modifiers` event — so a keymap mid-sequence never reads a Shift as a key between two others. For a terminal speaking kitty's keyboard protocol, or a game that binds a lone Shift.",
1024 },
1025 PropDef {
1026 name: "onContextMenu",
1027 id: P_ON_CONTEXT_MENU,
1028 kind: Kind::Tag,
1029 apply: Apply::SpecMsg(|s, v| s.on_context_menu(v)),
1030 doc: "Context-menu tag: a secondary-button (right) press emits {kind:\"contextmenu\", x, y, tag} on the node, at the logical viewport point to open the menu at. The press moves no focus, places no caret and produces no click, so right-clicking a selection keeps it. Asked of the topmost node under the pointer, and when that node offers no menu the press reaches the nearest enclosing node that does — a container declaring a menu for everything inside it is the common case — the way an unclaimed key reaches the enclosing sink (`docs/adr/0011`): the event carries the *owner's* key and tag, a nested declaration wins over its ancestor's, a disabled node's own is skipped, and the walk stops at the modal boundary.",
1031 },
1032 PropDef {
1033 name: "onForceClick",
1034 id: P_ON_FORCE_CLICK,
1035 kind: Kind::Tag,
1036 apply: Apply::SpecMsg(|s, v| s.on_force_click(v)),
1037 doc: "Force-click tag: a press that deepens past the second stage of a Force Touch trackpad emits {kind:\"forceclick\", x, y, tag} on the node, at the logical viewport point it happened at (`docs/adr/0017-selection-as-a-scope.md`). Routed as a secondary press is — no focus moved, no caret placed, no click — but asked of the topmost node only, with no walk to an enclosing declaration — and the ordinary click the press is still producing arrives afterwards, as it does on macOS. Text needs none of this: a force click over an `edit` or a `selectable` scope selects the word under it and asks the host for its Look Up panel. macOS-only in practice, and there the user can switch the gesture off, so nothing may declare itself the only way to reach something.",
1038 },
1039 PropDef {
1040 name: "onButton",
1041 id: P_ON_BUTTON,
1042 kind: Kind::Tag,
1043 apply: Apply::SpecMsg(|s, v| s.on_button(v)),
1044 doc: "Button tag (backlog F105): a press of a non-primary button — middle, secondary, or one past those — emits {kind:\"button\", phase:\"press\", button, x, y, clicks, tag} on the node, and the button is then captured by it: every pointer move while it is held arrives as phase:\"move\" and its release as phase:\"release\", on this node wherever the pointer is. `button` is `\"secondary\"`, `\"middle\"` or a further button's number (3 and up); `x`/`y` are logical viewport coordinates, and on a `cells` grid each event carries `cell: {row, col}` as a click does. Several buttons can be held at once, each its own capture, and a primary drag is untouched. `buttons` says which buttons it claims — all of them unless it narrows them. Asked of the topmost node under the pointer, and when that node claims no such button the press reaches the nearest enclosing node that does, the way a context menu's does: a disabled node's own is skipped and the walk stops at the modal boundary. A claimed secondary press is this event *instead of* a `contextmenu` event and the stock menu (a nearer `onContextMenu` still wins, being the nested declaration). Like every non-primary press it moves no focus, places no caret and touches no selection or scrollbar. For a terminal's middle-click paste, and the mouse reports a program in it asked for.",
1045 },
1046 PropDef {
1047 name: "buttons",
1048 id: P_BUTTONS,
1049 kind: Kind::Str,
1050 apply: Apply::SpecStr(|s, v| s.buttons(crate::input::Buttons::parse(v))),
1051 doc: "Which non-primary buttons `onButton` claims (backlog F105): `\"secondary\"`, `\"middle\"` and `\"other\"` (every button past those), separated by spaces or commas — `\"middle\"`, `\"secondary middle\"`. Unset, all three: a node that wants the middle button and leaves the secondary one to its context menu says `\"middle\"`. A word that is none of the three is skipped, so a string of none of them claims nothing, and a typo never takes the secondary button from a context menu. Meaningless without `onButton`.",
1052 },
1053 PropDef {
1054 name: "onScroll",
1055 id: P_ON_SCROLL,
1056 kind: Kind::Tag,
1057 apply: Apply::SpecMsg(|s, v| s.on_scroll(v)),
1058 doc: "Scroll tag: the wheel over this node emits {kind:\"scroll\", x, y, dx, dy, lines, tag} on it instead of scrolling anything — `dx`/`dy` the delta in logical px as the driver reported it (positive `dy` is the wheel rolling up, toward earlier content), `x`/`y` the pointer, and `lines` on a `cells` grid the whole lines the delta covers (positive = later history, the sign `originLine` grows in; the fraction is carried to the next notch so a trackpad's small steps add up) and null on any other node. The node takes the wheel on the axes `scrollAxes` names (both unless it narrows them): a gesture that starts over it is its own whether or not it has anywhere to go — except on an axis the node also scrolls (`scrollX`/`scrollY`, its offset the app's to set), where it is answered by its room as a container is, so at its edge a gesture that way passes to the scroller around it (backlog F118) — and stays its own until it ends, wherever the pointer goes (backlog F107); it reaches no scroll container above it, and a scroller inside it still takes the axes it scrolls while it can move that way, passing this node the rest — the other axis, and a gesture that begins with that scroller at its limit (`overscroll: \"contain\"` on the scroller keeps it there). The core moves nothing — a grid re-declares `originLine`, a canvas zooms. A drag-select held past a `cells` grid's top or bottom edge arrives here too, once a frame with the lines that frame scrolled by (`docs/adr/0029-a-selection-follows-the-pointer-past-the-edge.md`).",
1059 },
1060 PropDef {
1061 name: "scrollAxes",
1062 id: P_SCROLL_AXES,
1063 kind: Kind::Enum(SCROLL_AXES),
1064 apply: Apply::SpecEnum(|s, i| s.scroll_axes(crate::spec::ScrollAxes::ALL[i])),
1065 doc: "Which axes `onScroll` takes (backlog F107): `both` (the default), `x` or `y`. A scroll gesture on an axis the node does not take passes it by, to the scroller around it, and hears nothing here: a terminal that scrolls its history says `y`, and a sideways swipe that starts over it moves the strip it sits in. (A swipe that started elsewhere is not the node's either way: a gesture keeps the target it started with.) Meaningless without `onScroll`.",
1066 },
1067 PropDef {
1068 name: "scrollMods",
1069 id: P_SCROLL_MODS,
1070 kind: Kind::Str,
1071 apply: Apply::SpecStr(|s, v| s.scroll_mods(crate::input::KeyMods::parse(v))),
1072 doc: "The modifiers `onScroll` is for (backlog F122): `\"shift\"`, `\"ctrl\"`, `\"alt\"` and `\"super\"` (⌘, the Windows key), separated by spaces or commas — `\"ctrl super\"`. With any named, the node hears only a scroll gesture that began with one of them held, and hears it first: ahead of every scroll container and every `onScroll` that names none, wherever under the pointer the gesture began, the innermost such node winning — so a Ctrl-wheel zoom declared on the window's root is heard over a list, and the list does not scroll. A wheel with none of them held passes the node by, as if it had no `onScroll`: a node that scrolls as well (`overflow`) scrolls for it as any container does. Its `scroll` events carry `mods`, the modifiers held when the gesture began; the gesture stays the node's to the end of its glide, whatever is let go meanwhile, and one begun without them never becomes its. A word that is none of the four is skipped. Unset, a handler like any other. Meaningless without `onScroll`.",
1073 },
1074 PropDef {
1075 name: "window",
1076 id: P_WINDOW,
1077 kind: Kind::Enum(WINDOW_ROLES),
1078 apply: Apply::SpecEnum(|s, i| match i {
1079 0 => s.window_drag(),
1080 1 => s.window_button(WindowButton::Close),
1081 2 => s.window_button(WindowButton::Minimize),
1082 3 => s.window_button(WindowButton::Maximize),
1083 _ => s,
1084 }),
1085 doc: "Window-chrome role: interactions become window commands, not events.",
1086 },
1087 PropDef {
1088 name: "cursor",
1089 id: P_CURSOR,
1090 kind: Kind::Enum(CURSORS),
1091 apply: Apply::SpecEnum(|s, i| s.cursor(cursor_idx(i))),
1092 doc: "The pointer shape over this node. Unset, the pointer is `text` over an editor or a `selectable` scope and `default` over everything else — an `onClick`, `focusable` or `onDrag` node included, as a native button is — so a hand (`pointer`) over a control, a `grab` over a handle (and `grabbing` while its drag runs, which the view declares as its drag state changes), a splitter's `ewResize` / `nsResize` and a `disabled` control's `notAllowed` are all declared. The stock `button` declares `pointer` itself. A captured drag keeps the dragged node's shape wherever the pointer goes.",
1093 },
1094 PropDef {
1095 name: "transition",
1096 id: P_TRANSITION,
1097 kind: Kind::F32,
1098 apply: Apply::SpecF32(|s, v| s.transition(v)),
1099 doc: "Animate sizing/colors/radius changes over this many ms — and, on a scroll container, the offset a reveal or a set_scroll moves it to (needs a stable key).",
1100 },
1101 PropDef {
1102 name: "easing",
1103 id: P_EASING,
1104 kind: Kind::Enum(EASINGS),
1105 apply: Apply::SpecEnum(|s, i| s.easing(easing_idx(i))),
1106 doc: "Easing for `transition` (default easeOut). The springs — `smooth` (no overshoot), `snappy`, `spring` and `bouncy` (the most), each a `bounce` of its own — integrate with momentum, so a value retargeted mid-flight keeps moving the way it was; `transition` is then about how long one takes to get there. Between `keyframes` stops a spring is drawn as `easeOut` (see that row).",
1107 },
1108 PropDef {
1109 name: "bounce",
1110 id: P_BOUNCE,
1111 kind: Kind::F32,
1112 apply: Apply::SpecF32(|s, v| s.bounce(v)),
1113 doc: "How far a spring overshoots its target: 0 glides in with none, 0.5 bounces visibly, and values past 0.9 are held there (a spring at 1 would never settle). It replaces a spring `easing`'s own bounce (`smooth` 0, `snappy` 0.15, `spring` 0.25, `bouncy` 0.5), and on a timed easing makes the transition a spring — so `transition` plus `bounce` is a spring of that length and bounce. It does nothing between `keyframes` stops, which are sampled off the clock (see that row).",
1114 },
1115 PropDef {
1116 name: "slide",
1117 id: P_SLIDE,
1118 kind: Kind::Flag,
1119 apply: Apply::SpecFlag(|s| s.slide()),
1120 doc: "With transition: also ease the node's position (reordered siblings slide). While it eases, the node is drawn between where it was and where this frame put it — not at the declared `dx`/`dy`, or its slot in the row — so anything else positioned from those numbers drifts for the transition's length: a canvas of floats eases everything or nothing. Siblings that cross on their way paint in tree order, the one in the later place on top; `overSiblings` keeps one over the others.",
1121 },
1122 PropDef {
1123 name: "overSiblings",
1124 id: P_OVER_SIBLINGS,
1125 kind: Kind::Flag,
1126 apply: Apply::SpecFlag(|s| s.over_siblings()),
1127 doc: "Paint this node and its subtree after its siblings, over any it overlaps: a tab that glides past its neighbour under `slide` passes over it whichever way it moved, so the selected tab declared `overSiblings` stays on top without the view tracking when it moves. Siblings otherwise paint in tree order, a later place over an earlier. Only the sibling order changes: the parent still paints under it, what follows the parent over it, it keeps the parent's clip, and a float still opens above it. The hit test reads the same order, so where it overlaps a sibling it takes the press. Two siblings that both declare it paint in tree order between themselves. Not a z-index: there is no number to outbid (`docs/adr/0046-a-node-over-its-siblings-paints-after-them.md`).",
1128 },
1129 PropDef {
1130 name: "keyframes",
1131 id: P_KEYFRAMES,
1132 kind: Kind::Keyframes,
1133 apply: Apply::SpecKeyframes(|s, k| s.keyframes(k)),
1134 doc: "CSS-style stops `[{ at?, dx?, dy?, width?, height?, bg?, radius?, opacity?, rotate?, scale? }, …]`: the slots they name cycle through them over `transition` ms, for ever unless `iterations` says how many times, without the view redrawing; `at` is 0..1 and spreads evenly when omitted. `dx` / `dy` are logical px from where layout put the node (backlog F132), as an entrance's are: the node and its subtree are drawn and hit that far away at the stop, a lane a stop leaves out is 0, and the offset adds to a `slide`'s, so `[{ dy: 0 }, { dy: -6 }]` with `repeat: 'alternate'` bobs a box and a sparkle drifts up its stops. Paint, hit and access only: layout and the room the node takes are its own place's, and an `onLayout` node reports its layout rect, not the cycle, which would post an event every frame it runs. The `easing` applies to each step between two stops, as CSS applies its timing function per keyframe; a spring easing there is drawn as `easeOut` and `bounce` does nothing, since a cycle is sampled off the clock and a spring has to be integrated (backlog F141) — an overshoot in a cycle is a stop past the target, `[{ scale: 1 }, { scale: 1.15, at: 0.6 }, { scale: 1 }]`.",
1135 },
1136 PropDef {
1137 name: "enter",
1138 id: P_ENTER,
1139 kind: Kind::Enter,
1140 apply: Apply::SpecEnter(|s, e| s.enter(e)),
1141 doc: "Where the node starts the first frame it is seen `{ dx?, dy?, width?, height?, bg?, radius?, opacity?, rotate?, scale? }`: those slots ease in from there over `transition` ms instead of snapping (`dx`/`dy` slide it in from that far away, `opacity: 0` fades the whole subtree in, `scale: 0.8` settles it in).",
1142 },
1143 PropDef {
1144 name: "exit",
1145 id: P_EXIT,
1146 kind: Kind::Enter,
1147 apply: Apply::SpecEnter(|s, e| s.exit(e)),
1148 doc: "Where the node ends the frame after the view stops declaring it `{ dx?, dy?, width?, height?, bg?, radius?, opacity?, rotate?, scale? }` — an `enter` read the other way. It plays when the node itself is removed, its parent still declared; a node that goes because an ancestor went — a tab switched away, a panel closed around it — goes at once with it, unless that ancestor has an `exit` of its own, whose picture carries it (backlog DX19; React's `AnimatePresence` rule). With a `transition`, the departing subtree is copied out of the last frame that had it and replayed frozen, in its place (the pass it painted in, just under the node that painted after it — a panel under a HUD leaves under it) and inert (no clicks, no Tab stop, no access row) while those slots ease from where they were, then dropped; without one it vanishes at once as it always did. `width`/`height` resize the departing node's own box only — the subtree inside it is a picture and is not laid out again. The exit read is the one the last frame that had the node declared, unless `exit_with` named another for the frame it went in: a card a button throws left or right is aimed by the handler that removes it, with no frame drawn first to point it. Needs a stable key across frames.",
1149 },
1150 PropDef {
1151 name: "repeat",
1152 id: P_REPEAT,
1153 kind: Kind::Enum(REPEATS),
1154 apply: Apply::SpecEnum(|s, i| s.repeat(repeat_idx(i))),
1155 doc: "How `keyframes` cycle (CSS `animation-direction`, default normal). Lua: `direction`, since `repeat` is a keyword.",
1156 },
1157 PropDef {
1158 name: "delay",
1159 id: P_DELAY,
1160 kind: Kind::F32,
1161 apply: Apply::SpecF32(|s, v| s.delay(v)),
1162 doc: "Holds the `keyframes` cycle back by this many ms (CSS `animation-delay`); siblings with different delays run out of phase.",
1163 },
1164 PropDef {
1165 name: "iterations",
1166 id: P_ITERATIONS,
1167 kind: Kind::F32,
1168 apply: Apply::SpecF32(|s, v| s.iterations(v)),
1169 doc: "How many times the `keyframes` cycle runs (CSS `animation-iteration-count`, backlog F133); left out, for ever. A finite cycle plays from the first frame the node is declared with it — a node that leaves and comes back plays again — holds its first stop through its `delay`, and rests where its last iteration ended (CSS's fill `both`): `1` plays a burst or a shake once, `2` with `repeat: \"alternate\"` goes out and back and ends where it began, `0.5` stops halfway. Once it is over the node owes no frame, so `animating()` and `owed()` go quiet as a settled transition's do; `delay` plus `iterations: 1` staggers one-shots. A count that is not a positive number is for ever. C: 0 is for ever.",
1170 },
1171 PropDef {
1172 name: "clickSound",
1173 id: P_CLICK_SOUND,
1174 kind: Kind::Resource,
1175 apply: Apply::SpecResource(|s, id| s.click_sound(crate::resources::SoundId::from_ffi(id))),
1176 doc: "A registered sound (addSound) played when the node is clicked; implies hover tracking.",
1177 },
1178 PropDef {
1179 name: "hoverSound",
1180 id: P_HOVER_SOUND,
1181 kind: Kind::Resource,
1182 apply: Apply::SpecResource(|s, id| s.hover_sound(crate::resources::SoundId::from_ffi(id))),
1183 doc: "A registered sound (addSound) played when the pointer enters the node; implies hover tracking.",
1184 },
1185 PropDef {
1186 name: "lineHeight",
1187 id: P_LINE_HEIGHT,
1188 kind: Kind::F32,
1189 apply: Apply::StyleF32(|t, v| t.line_height(v)),
1190 doc: "Line height (logical px); default size * 1.35.",
1191 },
1192 PropDef {
1193 name: "color",
1194 id: P_COLOR,
1195 kind: Kind::Color,
1196 apply: Apply::StyleColor(|t, c| t.color(c)),
1197 doc: "Text color; default foreground when omitted.",
1198 },
1199 PropDef {
1200 name: "family",
1201 id: P_FAMILY,
1202 kind: Kind::Family,
1203 apply: Apply::StyleFamily(|t, f| t.family(f)),
1204 doc: "Font family: `sans`, `serif` or `mono`, kui's own, or the name of an installed family or one loaded with `loadFontsDir` / `loadFontFile` — `\"Berkeley Mono\"` — drawn in its face in the frame that names it (ADR 0037). A name is matched as `addSystemFont` matches it and registered in the session on first sight, exactly as the font database spells it (`\"menlo\"` is not `\"Menlo\"`); the session's first registration of any font maps the installed font files once (~30 ms on a Mac, backlog DX24), which a family named in a view pays in that frame. `systemFonts()` lists the names there are. A name nothing matches shapes as sans and raises `unknown-family`. It and `font` set the same thing, so declare one.",
1205 },
1206 PropDef {
1207 name: "font",
1208 id: P_FONT,
1209 kind: Kind::Resource,
1210 apply: Apply::StyleResource(|t, id| t.font(crate::resources::FontId::from_ffi(id))),
1211 doc: "A registered font handle (addFont / addSystemFont); overrides `family`.",
1212 },
1213 PropDef {
1214 name: "wrap",
1215 id: P_WRAP,
1216 kind: Kind::Enum(WRAPS),
1217 apply: Apply::StyleEnum(|t, i| match i {
1218 1 => t.wrap(TextWrap::Glyph),
1219 2 => t.wrap(TextWrap::None),
1220 3 => t.wrap(TextWrap::BreakSpaces),
1221 _ => t.wrap(TextWrap::Word),
1222 }),
1223 doc: "Line breaking at the node's width: between words (default), anywhere, never (one line per paragraph, clipped to the node), or between words with whitespace taking its room (`break-spaces`: a space that does not fit starts the next row rather than hanging past the edge — an editor's wrapped line). On a single-line `edit` — a field, which otherwise takes one line and scrolls it — declaring it is what makes the field fold to its width like a document, by this mode, while Enter still submits (see `edit`).",
1224 },
1225 PropDef {
1226 name: "maxLines",
1227 id: P_MAX_LINES,
1228 kind: Kind::F32,
1229 apply: Apply::StyleF32(|t, v| t.max_lines(v.max(0.0) as u32)),
1230 doc: "Lay out at most this many lines (0 = unlimited); with `ellipsis`, a line clamp.",
1231 },
1232 PropDef {
1233 name: "ellipsis",
1234 id: P_ELLIPSIS,
1235 kind: Kind::Flag,
1236 apply: Apply::StyleFlag(|t| t.ellipsis()),
1237 doc: "End the last line with an ellipsis when the text is cut off: a single line unless `maxLines` says otherwise.",
1238 },
1239 PropDef {
1240 name: "initialLetter",
1241 id: P_INITIAL_LETTER,
1242 kind: Kind::F32,
1243 apply: Apply::StyleF32(|t, v| t.initial_letter(v.max(0.0) as u32)),
1244 doc: "The first letter as an initial — a drop cap — this many lines tall (backlog F164), as CSS's `initial-letter`: its top level with the first line's capitals, its foot on the last one's baseline, the lines beside it moved in past it and the ones below at full width again. The letter is the text's first, with any opening quote or bracket before it; it keeps its span's face and colour and is sized to the drop. Still one text: a caret, a hit, a selection and the access tree read it where it is drawn, and the text is at least as tall as the lines it drops through. 0 and 1 are none (the default); a text with `maxLines` or `ellipsis`, a right-to-left one and an `edit` have none.",
1245 },
1246 PropDef {
1247 name: "underline",
1248 id: P_UNDERLINE,
1249 kind: Kind::Flag,
1250 apply: Apply::StyleFlag(|t| t.underline()),
1251 doc: "A line under the text, where the face puts its underline and as thick as it says, in the text colour. Paint only. On a `<span>` it covers the span alone and follows it across a wrap, one rect per line. `underlineColor` gives it a colour of its own and `underlineStyle` a shape; either implies it.",
1252 },
1253 PropDef {
1254 name: "underlineColor",
1255 id: P_UNDERLINE_COLOR,
1256 kind: Kind::Color,
1257 apply: Apply::StyleColor(|t, c| t.underline_color(c)),
1258 doc: "The underline's own colour — a diagnostic's red under keyword-coloured text (backlog K4). Implies `underline`. On a `<span>` the span's; a span with no colour of its own takes the text's.",
1259 },
1260 PropDef {
1261 name: "underlineStyle",
1262 id: P_UNDERLINE_STYLE,
1263 kind: Kind::Enum(UNDERLINE_STYLES),
1264 apply: Apply::StyleEnum(|t, i| t.underline_style(UnderlineStyle::from_index(i as u32))),
1265 doc: "The underline's shape (backlog K4): `solid` (the face's line), `wavy` (three strokes tall around the line, a six-stroke period — a diagnostic's squiggle, a terminal's undercurl) or `dotted` (dots two strokes across, four apart). Implies `underline`. A wave or dots are runs of the segment primitive a `line` draws, so no backend learns a kind; the cost is two quads per period.",
1266 },
1267 PropDef {
1268 name: "strikethrough",
1269 id: P_STRIKETHROUGH,
1270 kind: Kind::Flag,
1271 apply: Apply::StyleFlag(|t| t.strikethrough()),
1272 doc: "A line through the text, where the face puts its strikeout. Paint only; on a `<span>` the span alone, per line.",
1273 },
1274 PropDef {
1275 name: "bold",
1276 id: P_BOLD,
1277 kind: Kind::Flag,
1278 apply: Apply::StyleFlag(|t| t.bold()),
1279 doc: "The family's bold, on a whole text or an editor (backlog F150) — a heading, a table's header, a title field: its bold face, or its regular drawn bold where the family has none, as a `<span bold>` is. A span inside a bold text is bold too.",
1280 },
1281 PropDef {
1282 name: "features",
1283 id: P_FEATURES,
1284 kind: Kind::Str,
1285 apply: Apply::StyleStr(|t, s| t.features(crate::spec::FontFeatures::parse(s))),
1286 doc: "OpenType features for the shaper, as `tag=value` pairs separated by spaces or commas — a bare `tag` is 1, `-tag` is 0: `\"liga=0 calt=0\"` keeps a coding font from joining `->` and `!=` (what a terminal built on runs needs to hold its grid), `\"tnum\"` lines figures up in a gutter, `\"ss01\"` picks a stylistic set. Unset, the font's own defaults apply. At most 8; part of what the text is shaped as, so two texts differing only here are shaped twice.",
1287 },
1288 PropDef {
1289 name: "role",
1290 id: P_ROLE,
1291 kind: Kind::Enum(ROLES),
1292 apply: Apply::SpecEnum(|s, i| s.role(role_idx(i))),
1293 doc: "What the node is to assistive technology. Unset, the core derives one (an `onClick` node is a button, an editor a text input, a scrolling box a scroll view, a plain box nothing); `none` hides the node and its subtree from the access tree — the decorative door, for what a reader need not hear: an icon beside the text that says the same, or a caption under the button it repeats. A text takes no `role` (it has no box), so `none` goes on the box around it; `ambiguous-name` points at it when a caption and its control share a name (backlog F140). Where the caption is all a control says, a `label` on the control that says what it does is the better answer. A `radio` belongs inside a `radioGroup` and a `tab` inside a `tabList`, labelled with what the choice is: the pair is a composite (`docs/adr/0007-composite-keyboard-patterns.md`) — one Tab stop for the set, the arrows, Home and End moving the choice inside it (each step is the item's click, so the choice follows focus), and a screen reader reading \"2 of 3\". A `radio` or `tab` with no container above it is a Tab stop of its own that no arrow moves, and the core warns (`item-outside-container`). `menu` holds `menuItem`s and `list` holds `listItem`s the same way.",
1294 },
1295 PropDef {
1296 name: "label",
1297 id: P_LABEL,
1298 kind: Kind::Str,
1299 apply: Apply::SpecStr(|s, v| s.label(v)),
1300 doc: "The accessible name. Without one a button, link, tab or heading is named by the text inside it; an image, an icon-only button and a `modal` dialog have none, and the core warns (`image-without-label`, `control-without-name`, `modal-without-name`). Not the key label a `key` prop or `with_keyed` declares, which `key_of` looks up and a reader never hears; `key_named` looks a node up by this name.",
1301 },
1302 PropDef {
1303 name: "description",
1304 id: P_DESCRIPTION,
1305 kind: Kind::Str,
1306 apply: Apply::SpecStr(|s, v| s.description(v)),
1307 doc: "The accessible description: the extra sentence a reader says after the name, for what the name cannot say on its own — what a button will do, why a control is disabled, what format a field wants. `tooltip` is the shorthand that also draws the string and hover-tracks the node; this is the description alone, for a hint that is spoken and never drawn. Both write the one slot, so a node declaring both keeps whichever its binding applied last. It reads only on a node that reaches the access tree — a role, a label, a control — since a plain box is elided and takes its description with it.",
1308 },
1309 PropDef {
1310 name: "checked",
1311 id: P_CHECKED,
1312 kind: Kind::Flag,
1313 apply: Apply::SpecFlag(|s| s.checked(true)),
1314 doc: "The on state of a `checkbox` / `radio` / `switch` role.",
1315 },
1316 PropDef {
1317 name: "mixed",
1318 id: P_MIXED,
1319 kind: Kind::Flag,
1320 apply: Apply::SpecFlag(|s| s.mixed(true)),
1321 doc: "A `checkbox` that is neither on nor off — the select-all box over a list some of whose rows are selected (ADR 0034). Read as mixed by assistive technology whatever `checked` says, and drawn as a dash by the stock `<checkbox>`. Meaningful on the checkbox role alone.",
1322 },
1323 PropDef {
1324 name: "selected",
1325 id: P_SELECTED,
1326 kind: Kind::Flag,
1327 apply: Apply::SpecFlag(|s| s.selected(true)),
1328 doc: "The current one of a set: which `tab` a `tabList` shows, which `listItem` a list has picked, which `link` is the page you are on. A `tab` always carries the state — its siblings read as \"not selected\" — while a list row or a link carries it only where it is set, since an ordinary list or navigation bar is not a selection and a reader saying \"not selected\" on every row of it is noise.",
1329 },
1330 PropDef {
1331 name: "expanded",
1332 id: P_EXPANDED,
1333 kind: Kind::Enum(EXPANDED),
1334 apply: Apply::SpecEnum(|s, i| s.expanded(i == 1)),
1335 doc: "A disclosure's state: what a node that shows and hides something (a twisty, an accordion header, a menu button) reads as. Unset, the node does not expand at all — which is why this names its state instead of being a flag.",
1336 },
1337 PropDef {
1338 name: "live",
1339 id: P_LIVE,
1340 kind: Kind::Enum(LIVE),
1341 apply: Apply::SpecEnum(|s, i| s.live(crate::access::Live::from_index(i))),
1342 doc: "Marks this node a live region: when the text inside it changes, a screen reader reads the change without being asked — `polite` at the next pause, `assertive` interrupting. Put it on the smallest node that holds the message, since everything inside a live node is live. For a one-off with no node behind it (\"Saved\") the binding's `announce` verb is the other half.",
1343 },
1344 PropDef {
1345 name: "valueNow",
1346 id: P_VALUE_NOW,
1347 kind: Kind::F32,
1348 apply: Apply::SpecF32(|s, v| s.value_now(v)),
1349 doc: "A `slider` role's current value (the drawing stays yours; this is what assistive technology reads).",
1350 },
1351 PropDef {
1352 name: "valueMin",
1353 id: P_VALUE_MIN,
1354 kind: Kind::F32,
1355 apply: Apply::SpecF32(|s, v| s.value_min(v)),
1356 doc: "A `slider` role's minimum.",
1357 },
1358 PropDef {
1359 name: "valueMax",
1360 id: P_VALUE_MAX,
1361 kind: Kind::F32,
1362 apply: Apply::SpecF32(|s, v| s.value_max(v)),
1363 doc: "A `slider` role's maximum.",
1364 },
1365 PropDef {
1366 name: "valueText",
1367 id: P_VALUE_TEXT,
1368 kind: Kind::Str,
1369 apply: Apply::SpecStr(|s, v| s.value_text(v)),
1370 doc: "What a `slider` role's position reads as (ARIA's `aria-valuetext`). Without one a reader has only `valueNow` and the range and says a percentage — 25 in [5..60] is \"36 percent\" — so a value whose unit carries the meaning says it here: \"25 minutes\". It replaces the number in the reading rather than joining it, and a nudge announces the new text. Meaningful on the slider role alone, like the three numbers; putting the reading in `label` instead renames the control on every nudge, which is the wrong attribute.",
1371 },
1372 PropDef {
1373 name: "valueStep",
1374 id: P_VALUE_STEP,
1375 kind: Kind::F32,
1376 apply: Apply::SpecF32(|s, v| s.value_step(v)),
1377 doc: "How far one arrow key moves a `slider` role, and the grid a value the pointer sets snaps to (ADR 0034). Unset, a hundredth of the range. PageUp / PageDown move ten steps. Read by the core only where the slider declares `onChange`; reported to assistive technology either way.",
1378 },
1379 PropDef {
1380 name: "onFocus",
1381 id: P_ON_FOCUS,
1382 kind: Kind::Tag,
1383 apply: Apply::SpecMsg(|s, v| s.on_focus(v)),
1384 doc: "Keyboard focus entering or leaving this node's subtree — the node itself, or anything focused inside it — emits `{kind:\"focus\", phase:\"in\"|\"out\", by, tag}` (backlog DX18). `by` is what moved it: `pointer` (a press), `keyboard` (Tab, a key a control answered), `assistive` (a screen reader's request) or `program` (the view or the app — `keyFocus`, `setFocus`, a modal's entry). Reported once the move settles, after the input that made it or at the end of the frame that declared it, so an app hears a pane taking the keyboard instead of diffing the focused key every frame. Leaving is reported innermost first, entering outermost first. It makes nothing focusable or interactive.",
1385 },
1386 PropDef {
1387 name: "onChange",
1388 id: P_ON_CHANGE,
1389 kind: Kind::Tag,
1390 apply: Apply::SpecMsg(|s, v| s.on_change(v)),
1391 doc: "A `slider` role's changes (ADR 0034): the core turns a press on the node into the value under the pointer, a drag into the value under it, the arrows and assistive technology's increment / decrement into one `valueStep`, PageUp / PageDown into ten, Home / End into the range's ends — clamped to `valueMin`..`valueMax` (0..100 unset) and snapped to the step — and emits `{kind:\"change\", value, phase, tag}`: `phase` is `\"move\"` while the pointer holds the slider and `\"end\"` when it lets go or a key moved it. The value is proposed and never applied; the slider moves when the view declares it as `valueNow`. A key that lands where the slider already is proposes nothing. The pointer reads the node's content box along its main axis, so a `dir=\"column\"` slider runs bottom to top. Without it a slider's arrows reach the app as `{kind:\"access\", action}`. Ignored on any other role.",
1392 },
1393 PropDef {
1394 name: "caret",
1395 id: P_CARET,
1396 kind: Kind::F32,
1397 apply: Apply::SpecF32(|s, v| s.caret(v.max(0.0) as u32)),
1398 doc: "On a `line` of a custom editor (a `textInput` / `multilineTextInput` role drawn by the app): the caret's byte offset into that line's text.",
1399 },
1400 PropDef {
1401 name: "selectionAnchor",
1402 id: P_SELECTION_ANCHOR,
1403 kind: Kind::F32,
1404 apply: Apply::SpecF32(|s, v| s.selection_anchor(v.max(0.0) as u32)),
1405 doc: "On a `line` of a custom editor: the byte offset where the selection's other end sits (the caret is `caret`, possibly on another line).",
1406 },
1407 PropDef {
1408 name: "caretSolid",
1409 id: P_CARET_SOLID,
1410 kind: Kind::Flag,
1411 apply: Apply::SpecFlag(|s| s.caret_solid()),
1412 doc: "On a `line` declaring `caret`: the caret is solid — a block caret in a modal editor's normal mode — so the driver's blink clock is not armed on it and `caretVisible` stays true, while the offset still anchors the IME and reads to assistive technology. Without it a declared `caret` is a caret to blink, and the one thing that asks an idle app for a frame twice a second; an editor whose caret only blinks while typing declares this on every other mode's line.",
1413 },
1414];
1415
1416pub struct CustomProp {
1420 pub name: &'static str,
1421 pub id: u32,
1422 pub jsx_names: &'static [&'static str],
1429 pub lua_names: &'static [&'static str],
1431 pub jsx: &'static str,
1433 pub lua: &'static str,
1435 pub c: &'static str,
1437 pub odin: &'static str,
1441 pub doc: &'static str,
1442}
1443
1444pub const CUSTOM: &[CustomProp] = &[
1445 CustomProp {
1446 name: "dir",
1447 id: P_DIR,
1448 jsx_names: &["dir"],
1449 lua_names: &[],
1450 jsx: "`dir=\"row\" | \"column\" | \"table\"`",
1451 lua: "`row { }` / `column { }` / `grid { }`",
1452 c: "`dir` (`KUI_ROW` / `KUI_COLUMN` / `KUI_TABLE`)",
1453 odin: "`Spec.dir` (`.Column` / `.Row` / `.Table`); `kui.row` and `kui.column` set it",
1454 doc: "Main axis; column is the default. `table` is a column whose rows' children line up in columns (the `table` element).",
1455 },
1456 CustomProp {
1457 name: "size",
1458 id: P_SIZE,
1459 jsx_names: &["size"],
1460 lua_names: &["size"],
1461 jsx: "`size` (text)",
1462 lua: "`size`",
1463 c: "`KuiTextStyle.size`; `KuiSpan.size`",
1464 odin: "`Text_Style.size`",
1465 doc: "Font size in logical px; the text style is constructed from it, so declare it for the other style props to apply at that size.",
1466 },
1467 CustomProp {
1468 name: "pad",
1469 id: P_PAD,
1470 jsx_names: &["pad", "padX", "padY", "padL", "padR", "padT", "padB"],
1471 lua_names: &["pad"],
1472 jsx: "`pad`, `padX`, `padY`, `padL`, `padR`, `padT`, `padB`",
1473 lua: "`pad = n` or `pad = { all=, x=, y=, l=, r=, t=, b= }`",
1474 c: "`pad_l`, `pad_r`, `pad_t`, `pad_b`",
1475 odin: "`Spec.pad`: `kui.pad(16)`, `kui.pad(16, 8)`, or `{l = .., r = .., t = .., b = ..}`",
1476 doc: "Padding; a frontend reports the names it saw and `PadShorthand::resolve` turns them into four edges — an edge falls back to its axis, an axis to the all-round `pad`, and the specific one always wins.",
1477 },
1478 CustomProp {
1479 name: "border",
1480 id: P_BORDER,
1481 jsx_names: &["borderW", "borderColor"],
1482 lua_names: &["border"],
1483 jsx: "`borderW`, `borderColor`",
1484 lua: "`border = { w=, color= }`",
1485 c: "`border_w`, `border_color`",
1486 odin: "`Spec.border_w`, `Spec.border_color`",
1487 doc: "Border width and color (drawn inside the rect).",
1488 },
1489 CustomProp {
1490 name: "overflow",
1491 id: P_OVERFLOW,
1492 jsx_names: &["clip", "scrollX", "scrollY"],
1493 lua_names: &["clip", "scroll", "scroll_x", "scroll_y"],
1494 jsx: "`clip`, `scrollX`, `scrollY`",
1495 lua: "`clip`, `scroll_x`, `scroll_y` (`scroll` = `scroll_y`)",
1496 c: "`overflow` bits `KUI_CLIP` | `KUI_SCROLL_X` | `KUI_SCROLL_Y`",
1497 odin: "`Spec.overflow`: `{.Clip}`, `{.Scroll_X}`, `{.Scroll_Y}`",
1498 doc: "Clip children; scroll (implies clip) with retained offsets and live scrollbars. A `radius` on the same node rounds the clip, so a rounded card does not show square corners poking out of it; nesting two rounded clippers keeps only the corners neither of them moved, and hit-testing stays rectangular. Every frontend ORs the same bits and hands them to `NodeSpec::overflow_bits`. The wheel goes to the scroller under the pointer on the axes it scrolls, and the rest of the notch to the one around it: a `scrollY` list inside a `scrollX` strip moves the strip on a sideways swipe (backlog DX13). A scroll gesture — a swipe and its glide, a wheel spun without a pause — picks that scroller when it starts, skipping one already at its limit that way for the one around it (unless it says `overscroll: contain`), and keeps it until it ends, so content moving under a still pointer does not hand the rest of a swipe to what came under it (backlog F107). An offset is kept while the key is declared; an undeclared one is kept until the budget needs the room (1024 undeclared entries, longest-undeclared evicted first).",
1499 },
1500 CustomProp {
1501 name: "float",
1502 id: P_FLOAT,
1503 jsx_names: &["float"],
1504 lua_names: &["float"],
1505 jsx: "`float=\"below\" | \"above\" | \"parent\" | \"viewport\"` or `{ anchor, at, self, dx, dy, fit, clip }`",
1506 lua: "`float = \"below\"` or `float = { anchor=, at=, self=, dx=, dy=, fit=, clip= }`",
1507 c: "`float_mode`, `float_anchor_x/y`, `float_self_x/y`, `float_dx/dy`, `float_fit`, `float_clip`; `kui_spec_float_preset` fills them from a preset name",
1508 odin: "`Spec.float`, a `Float` (`mode`, `anchor_x/y`, `self_x/y`, `dx/dy`, `fit`, `clip`); `kui.float_preset` fills one from a preset name",
1509 doc: "Out-of-flow positioning against the parent or the viewport; `fit` flips/clamps to stay on screen. A float escapes every ancestor's clip — a tooltip is not cut by the scroller it hangs from — unless it declares `clip` and is anchored to its parent (`parent`, `below`, `above`): then the parent's clip holds it as it holds a child, so a node on a `clip` canvas panned past the canvas's edge is cut there and cannot be hit past it; it still paints as a layer over its in-flow siblings. A `line`, `polygon` or `path` in its parent's box is always clipped this way. The four preset names resolve in `FloatConfig::preset`, and `anchor` takes any of them — an override left out keeps the preset's own value, so `{ anchor: \"below\", dx: 4 }` still hangs below with its 6px gap. A float is a layer of its own: above the in-flow tree and every float that opened before it, under every float that opened after, and hit-tested in the same order — so a tooltip that appears over an open menu is over it, and a popover over a scroller's bar takes the press there. A scroller's bars and the focus ring belong to the layer that owns them. There is no z-index; a float declared under a fresh key reopens on top (`docs/adr/0023-layers-stack-in-the-order-they-open.md`).",
1510 },
1511 CustomProp {
1512 name: "keyFocus",
1513 id: P_KEY_FOCUS,
1514 jsx_names: &["keyFocus"],
1515 lua_names: &["key_focus"],
1516 jsx: "`keyFocus`",
1517 lua: "`key_focus`",
1518 c: "`kui_set_key_focus`",
1519 odin: "`Spec.key_focus`, which calls `kui.set_key_focus` on the node",
1520 doc: "Focuses this node (an `onKey` sink, an editor, any focusable node) when it starts being declared: declared every frame it takes focus once, so a later Tab press is not clobbered. Declaring it on the frame a `modal` stops being declared is how a view says where focus lands on the way out — the edge stands, and the focus the modal displaced is not handed back over it (`docs/adr/0003-modal-surfaces.md`, decision 4). To move focus at any time call the binding's focus verb (`ctx.focus`, `kui_focus`, `env.set_focus`).",
1521 },
1522 CustomProp {
1523 name: "key",
1524 id: P_KEY,
1525 jsx_names: &["key"],
1526 lua_names: &["key"],
1527 jsx: "`key`",
1528 lua: "`key`",
1529 c: "`kui_open_keyed` label",
1530 odin: "`Spec.key`, which opens the node keyed",
1531 doc: "Stable identity for retained state (scroll offsets, editors, transitions; keys are hashes of the path from the root). Retained state outlives the key's absence, under a budget on the states nobody declares (see `<edit>` and the overflow props).",
1532 },
1533 CustomProp {
1534 name: "index",
1535 id: P_INDEX,
1536 jsx_names: &["index"],
1537 lua_names: &["index"],
1538 jsx: "`index`",
1539 lua: "`index`",
1540 c: "`kui_open_indexed`",
1541 odin: "`Spec.index`, a `Maybe(u64)`, which opens the node indexed",
1542 doc: "Stable identity by *data* index rather than by name: the key auto-keying would have given this node as the `i`th child, given to it wherever it actually sits. What a virtualised list is for — a view that builds rows 900..930 of ten thousand opens each with its own row number, so the row keeps its hover, focus, edit buffer and tweens as the built range slides over it, and a list that builds every row agrees with one that builds a screenful. Wherever `key` names a node this numbers it (a box, a `line`, a `cells`, a `fragment`); declared beside `key` the index wins. Indices and names are separate namespaces, so a spacer keyed `\"lead\"` cannot collide with row 0 — but two rows on one index do, exactly as two on one name would.",
1543 },
1544 CustomProp {
1545 name: "rowCount",
1546 id: P_ROW_COUNT,
1547 jsx_names: &["rowCount"],
1548 lua_names: &["row_count"],
1549 jsx: "`rowCount`",
1550 lua: "`row_count`",
1551 c: "`kui_row_count`",
1552 odin: "`Spec.row_count`, a `Maybe(u64)`, which calls `kui.row_count` on the node",
1553 doc: "How many `index`ed rows this node's virtual list has, built or not. `uniformList` / `uniform_list` / `widgets::uniform_list` and `widgets::list` declare it on their container; a list composed by hand says it beside `scrollY`. What it buys: Select All (Cmd/Ctrl-A, the menu's row) inside a `selectable` virtual list selects the *data*, rows `0..rowCount`, rather than the rows the frame built, and the copy is a `selectionrange` ask whose `to.byte` is past the last row's length when that row is not built — cut it to the row. Without it Select All is the built rows, which is all the core can see.",
1554 },
1555 CustomProp {
1556 name: "title",
1557 id: P_TITLE,
1558 jsx_names: &["title"],
1559 lua_names: &["window_title"],
1560 jsx: "`title` (root box only)",
1561 lua: "`window_title` (root table)",
1562 c: "`kui_window_title`",
1563 odin: "`kui.window_title`",
1564 doc: "Declares the window title for this frame; the driver diffs and applies.",
1565 },
1566 CustomProp {
1567 name: "alwaysOnTop",
1568 id: P_ALWAYS_ON_TOP,
1569 jsx_names: &["alwaysOnTop"],
1570 lua_names: &["always_on_top"],
1571 jsx: "`alwaysOnTop` (root box only)",
1572 lua: "`always_on_top = true` (root table)",
1573 c: "`kui_set_always_on_top`",
1574 odin: "`kui.set_always_on_top`",
1575 doc: "Declares that this frame wants the window kept above every other app's — a floating palette, a picture-in-picture player, a timer (backlog C30). Frame state the way `title` is, applied by the driver on change and free on the frames it does not change, but with a default of false rather than \"leave as-is\": a frame that stops declaring it lowers the window again, so a pin button is a toggle on the app's own state and nothing has to remember to undo it. Whether the platform has a level to set is `env.window.always_on_top`, which is what the pin button should draw its state from — Wayland has no call for it at all, so there the window never moves and the reading says so; it is the driver's record of what it set, not a query, so a level the OS dropped afterwards (a fullscreen space, a tiling manager) is not reported. A popup keeps its own level whatever its owner declares.",
1576 },
1577 CustomProp {
1578 name: "secureInput",
1579 id: P_SECURE_INPUT,
1580 jsx_names: &["secureInput"],
1581 lua_names: &["secure_input"],
1582 jsx: "`secureInput` (root box only)",
1583 lua: "`secure_input = true` (root table)",
1584 c: "`kui_set_secure_input`",
1585 odin: "`kui.set_secure_input`",
1586 doc: "Declares that this frame wants the keyboard to this window kept from every other process while the window has it — macOS's Secure Keyboard Entry, what a terminal turns on at a password prompt (backlog F85). Frame state the way `alwaysOnTop` is, default false: declare it on every frame the prompt is up, and the frame that stops is what turns it off, so nothing has to remember to undo it. The runner owns the platform call and its balance: `EnableSecureEventInput` is process-wide and counted, and the runner holds one count while a window whose frame asked has the keyboard, giving it back when that window loses the keyboard, closes or stops asking, and at exit — Apple's rule, since while it is on no other process can read the keyboard at all (a launcher's hotkey, a text expander, an accessibility tool). Nothing on Windows or Linux, which have no such switch. A C host with its own loop reads the ask with `kui_secure_input_get` and makes the call itself.",
1587 },
1588 CustomProp {
1589 name: "optionAsAlt",
1590 id: P_OPTION_AS_ALT,
1591 jsx_names: &["optionAsAlt"],
1592 lua_names: &["option_as_alt"],
1593 jsx: "`optionAsAlt=\"left\"` — `\"none\"`, `\"left\"`, `\"right\"`, `\"both\"` (root box only)",
1594 lua: "`option_as_alt = \"left\"` (root table)",
1595 c: "`kui_set_option_as_alt` (`KUI_OPTION_AS_ALT_*`)",
1596 odin: "`kui.set_option_as_alt` (an `Option_As_Alt`)",
1597 doc: "Declares which Option keys act as Alt in this window on macOS (backlog F113). On a Mac, Option composes: ⌥m types `µ`, and ⌥u, ⌥e, ⌥i, ⌥n and ⌥` are dead keys that start an accent and wait for the next key, so the press never reaches the app as a key and a keymap binding `<A-u>` never hears it. An Option key named here is Alt instead: it composes nothing and types nothing, and a key under it arrives as a chord of the key the layout prints unmodified — a terminal's \"Option as Meta\", an editor's Alt bindings. `\"left\"` or `\"right\"` leaves the other side composing, so a user keeps `ü` on one Option; `\"both\"` takes both; `\"none\"`, the default, is the Mac's own behaviour. Frame state the way `alwaysOnTop` is: declare it on every frame, and the frame that stops gives the Option keys back to the layout; the runner applies it to the window on change, never per frame. A popup's keys arrive through its owner, so the owner's declaration is the one they are read under. Nothing on Windows or Linux, whose Alt composes nothing. A C host with its own loop reads the ask with `kui_option_as_alt_get` and applies it itself.",
1598 },
1599 CustomProp {
1600 name: "imeOff",
1601 id: P_IME_OFF,
1602 jsx_names: &["imeOff"],
1603 lua_names: &["ime_off"],
1604 jsx: "`imeOff` (root box only)",
1605 lua: "`ime_off = true` (root table)",
1606 c: "`kui_set_ime_off`",
1607 odin: "`kui.set_ime_off`",
1608 doc: "Declares that this window takes the keyboard as keys, with the platform's input method off (backlog F125): no composition and no candidate window, and on a Mac no dead key waiting for the next and no press-and-hold — an input method too, so a held letter repeats instead of opening the accent picker, whatever the user's `ApplePressAndHoldEnabled` says. A `key` event's `text` is still the layout's character; what goes is everything the OS would have composed from it. What a modal editor's normal mode wants — `jjjj` is how one moves, and an IME left on eats the keymap — while its insert mode stops declaring it and gets accents, dead keys and the IME back. Frame state the way `alwaysOnTop` is, default false: declare it on every frame the mode wants it, and the frame that stops gives the input method back; the runner applies it to the window on change, never per frame, and a composition in progress when it turns off ends without a commit, as an empty `preedit`. The window's, not a node's: a stock editor focused under it composes nothing either. A popup's keys arrive through its owner, so the owner's declaration is the one they are read under. On Windows and Linux the window's IME is disabled the same way, and only that: their dead keys are the layout's, and still compose. A C host with its own loop reads the ask with `kui_ime_off_get` and applies it itself.",
1609 },
1610 CustomProp {
1611 name: "windows",
1612 id: P_WINDOWS,
1613 jsx_names: &["windows"],
1614 lua_names: &["windows"],
1615 jsx: "`windows={[{ name, kind?, anchor?, width?, height?, activates? }]}` (root box only; `windows: (model) => [...]` in the loop config)",
1616 lua: "`windows = { { name=, kind=, anchor=, width=, height=, activates= } }` (root table)",
1617 c: "`kui_window_declare`",
1618 odin: "`kui.window_declare`",
1619 doc: "Declares which windows exist this frame, by stable name (`docs/adr/0004-multi-window.md`). A window opens on the first frame any window's frame declares it — its config is read then and never again, since the user owns its geometry once it exists — and closes on the first frame none does. The driver drains the `Open` / `Close` that result, and the app sees `{kind:\"window\", phase, name, id}`. A window the user closed does not reopen while it is still declared: stop declaring it, then declare it again. `kind: \"popup\"` makes it a menu surface instead: borderless, off the taskbar, owned by the window that declared it and closed with it, placed in screen coordinates against `anchor` — the `{x, y, w, h}` an `onLayout` node reported — and non-activating unless `activates` says otherwise, so the field that opened it keeps the focus ring while the arrows walk the list. A press outside it or Escape raises `{kind:\"dismiss\", reason, name, id}` and closes nothing, exactly as a `modal` node's does: stop declaring the window. Reach for a popup only for the placements a float cannot make — a list taller than the window, a menu with nowhere in-window to go, a panel beside the app; everything else stays `fit` plus a `modal` float, which costs one tree instead of an OS surface.",
1620 },
1621 CustomProp {
1622 name: "tooltip",
1623 id: P_TOOLTIP,
1624 jsx_names: &["tooltip"],
1625 lua_names: &["tooltip"],
1626 jsx: "`tooltip=\"hint\"`",
1627 lua: "`tooltip = \"hint\"`",
1628 c: "`KuiSpec.tooltip` (`kui_tooltip` / `kui_tooltip_with` draw a hint that is not hover-gated)",
1629 odin: "`Spec.tooltip` (`kui.tooltip` / `kui.tooltip_with` draw a hint that is not hover-gated)",
1630 doc: "Floats a hint below the node while hovered. All three effects — hover tracking, the accessible description, and the float itself — come from `PropsOut::apply_tooltip`, so no frontend can implement two of them; a Rust view has all three in `NodeSpec::tooltip` (`NodeSpec::apply_tooltip` is the spec half, for a caller that floats the hint itself). The `description` row is that middle effect on its own, for a hint that is spoken and never drawn. On a box or a `fragment` the float is the node's last child; a leaf holds no children — a `line`, `polygon`, `path`, `cells` grid, `image` or `edit` — and its hint floats beside it instead, anchored to it, and lands below its box the same way, out of every clip and flipping above near the window's bottom (backlog RG113; `PropsOut::for_leaf`). A leaf draws its description, which is the hint unless a `description` applied after it overwrote the slot. A `line`, `polygon` or `path` is hovered by its shape, so its hint shows while the pointer is on the stroke or inside the outline, not anywhere in its box.",
1631 },
1632];
1633
1634pub const C_FIELDS: &[(&str, &str)] = &[
1637 ("width", "`width` (KuiSizing)"),
1638 ("height", "`height` (KuiSizing)"),
1639 ("center", "`main_align` + `cross_align` = `KUI_CENTER`"),
1640 ("window", "`window_role` (`KUI_WINDOW_*`)"),
1641 ("transition", "`transition_ms`"),
1642 ("easing", "`easing` (`KUI_EASE_*`)"),
1643 (
1644 "keyframes",
1645 "`keyframes` + `keyframes_len` (`KuiKeyframe[]`)",
1646 ),
1647 ("gradient", "`gradient` (`const KuiGradient *`)"),
1648 ("repeat", "`repeat` (`KUI_REPEAT_*`)"),
1649 ("delay", "`delay_ms`"),
1650 ("iterations", "`iterations` (0 is for ever)"),
1651 ("enter", "`enter` (`KuiEnter`, with `set` bits)"),
1652 ("exit", "`exit` (`KuiEnter`, with `set` bits)"),
1653 ("opacity", "`opacity` with `opacity_set`"),
1654 ("scale", "`scale` (0 is 1)"),
1655 ("pivotX", "`pivot_x` with `pivot_set`"),
1656 ("pivotY", "`pivot_y` with `pivot_set`"),
1657 ("radiusTL", "`radius_tl` with `per_corner`"),
1658 ("radiusTR", "`radius_tr` with `per_corner`"),
1659 ("radiusBR", "`radius_br` with `per_corner`"),
1660 ("radiusBL", "`radius_bl` with `per_corner`"),
1661 ("hoverGroup", "`hover_group` (KuiStr)"),
1662 ("role", "`role` (`KUI_ROLE_*`)"),
1663 ("expanded", "`expanded` (`KUI_EXPANDED_*`)"),
1664 ("live", "`live` (`KUI_LIVE_*`)"),
1665 ("cursor", "`cursor` (`KUI_CURSOR_*`)"),
1666 ("label", "`label` (KuiStr)"),
1667 (
1668 "valueNow",
1669 "`value_now` with `KUI_VALUE_NOW` in `value_set`",
1670 ),
1671 (
1672 "valueMin",
1673 "`value_min` with `KUI_VALUE_MIN` in `value_set`",
1674 ),
1675 (
1676 "valueMax",
1677 "`value_max` with `KUI_VALUE_MAX` in `value_set`",
1678 ),
1679 ("valueText", "`value_text` (KuiStr)"),
1680 ("caret", "`caret` with `KUI_VALUE_CARET` in `value_set`"),
1681 (
1682 "selectionAnchor",
1683 "`selection_anchor` with `KUI_VALUE_ANCHOR` in `value_set`",
1684 ),
1685 (
1686 "onClick",
1687 "`on_click` argument of `kui_open` / `kui_open_with`",
1688 ),
1689 (
1690 "onDrag",
1691 "`on_drag` argument of `kui_open_draggable` / `kui_open_with`",
1692 ),
1693 ("onKey", "`on_key` argument of `kui_open_with`"),
1694 (
1695 "onContextMenu",
1696 "`on_context_menu` (a borrowed `KuiValue*`, cloned while the node opens)",
1697 ),
1698 (
1699 "onButton",
1700 "`on_button` (a borrowed `KuiValue*`, cloned while the node opens)",
1701 ),
1702 (
1703 "buttons",
1704 "`buttons` (`KUI_BUTTONS_*` bits; zeroed, all three)",
1705 ),
1706 (
1707 "modal",
1708 "`modal` (a borrowed `KuiValue*`, cloned while the node opens)",
1709 ),
1710 (
1711 "onScroll",
1712 "`on_scroll` (a borrowed `KuiValue*`, cloned while the node opens)",
1713 ),
1714 ("onHover", "`on_hover` argument of `kui_open_with`"),
1715 (
1716 "onFocus",
1717 "`on_focus` (a borrowed `KuiValue*`, cloned while the node opens)",
1718 ),
1719 ("ruleWidth", "`rule_w`"),
1720 (
1721 "overscroll",
1722 "`overscroll` (`KUI_OVERSCROLL_*`; zeroed, auto)",
1723 ),
1724 (
1725 "scrollAxes",
1726 "`scroll_axes` (`KUI_SCROLL_AXES_*`; zeroed, both)",
1727 ),
1728 (
1729 "scrollMods",
1730 "`scroll_mods` (`KUI_KMOD_*` bits; zeroed, none)",
1731 ),
1732 (
1733 "onDrop",
1734 "`on_drop` (a borrowed `KuiValue*`, cloned while the node opens)",
1735 ),
1736 (
1737 "onLayout",
1738 "`on_layout` (a borrowed `KuiValue*`, cloned while the node opens)",
1739 ),
1740 (
1741 "family",
1742 "`KuiTextStyle.family` (`KUI_FONT_*`); `KuiSpan.family` (with `KUI_SPAN_FAMILY`)",
1743 ),
1744 (
1745 "font",
1746 "`KuiTextStyle.font` (from `kui_font_add*`); `KuiSpan.font`",
1747 ),
1748 ("lineHeight", "`KuiTextStyle.line_height`"),
1749 ("wrap", "`KuiTextStyle.wrap` (`KUI_WRAP_*`)"),
1750 ("maxLines", "`KuiTextStyle.max_lines`"),
1751 ("initialLetter", "`KuiTextStyle.initial_letter`"),
1752 ("ellipsis", "`KuiTextStyle.ellipsis`"),
1753 (
1754 "features",
1755 "`KuiTextStyle.features` (a `KuiStr`, the same spelling)",
1756 ),
1757 (
1758 "underline",
1759 "`KuiTextStyle.decoration` (`KUI_DECO_UNDERLINE`); `KuiSpan.flags` (`KUI_SPAN_UNDERLINE`)",
1760 ),
1761 (
1762 "strikethrough",
1763 "`KuiTextStyle.decoration` (`KUI_DECO_STRIKETHROUGH`); `KuiSpan.flags` (`KUI_SPAN_STRIKETHROUGH`)",
1764 ),
1765 (
1766 "bold",
1767 "`KuiTextStyle.bold`; `KuiSpan.flags` (`KUI_SPAN_BOLD`)",
1768 ),
1769 (
1770 "underlineColor",
1771 "`KuiTextStyle.underline_color`; `KuiSpan.underline_color`",
1772 ),
1773 (
1774 "underlineStyle",
1775 "`KuiTextStyle.underline_style` (`KUI_UNDERLINE_*`); `KuiSpan.underline_style`",
1776 ),
1777 ("color", "`KuiTextStyle.color`"),
1778];
1779
1780pub fn c_field(def: &PropDef) -> String {
1782 C_FIELDS
1783 .iter()
1784 .find(|(n, _)| *n == def.name)
1785 .map(|(_, c)| (*c).to_string())
1786 .unwrap_or_else(|| format!("`{}`", def.snake_name()))
1787}
1788
1789pub fn odin_field(def: &PropDef) -> String {
1792 let record = match def.target() {
1793 Target::Spec => "Spec",
1794 Target::Style => "Text_Style",
1795 };
1796 format!("`{record}.{}`", def.snake_name())
1797}
1798
1799pub fn odin_from_c(c: &str) -> String {
1805 c.replace("kui_", "kui.")
1806 .replace("KuiSpec.", "Spec.")
1807 .replace("KuiTextStyle.", "Text_Style.")
1808}
1809
1810pub struct ElementDef {
1815 pub name: &'static str,
1816 pub jsx_own: &'static [&'static str],
1822 pub lua_own: &'static [&'static str],
1824 pub jsx_rows: Option<&'static [&'static str]>,
1832 pub lua_rows: Option<&'static [&'static str]>,
1833 pub jsx: &'static str,
1834 pub lua: &'static str,
1835 pub c: &'static str,
1836 pub odin: &'static str,
1839 pub doc: &'static str,
1840}
1841
1842pub const TEXT_ROWS_JSX: &[&str] = &[
1853 "size",
1854 "lineHeight",
1855 "color",
1856 "family",
1857 "font",
1858 "wrap",
1859 "maxLines",
1860 "ellipsis",
1861 "initialLetter",
1862 "underline",
1863 "underlineColor",
1864 "underlineStyle",
1865 "strikethrough",
1866 "bold",
1867 "features",
1868];
1869pub const TEXT_ROWS_LUA: &[&str] = &[
1870 "size",
1871 "line_height",
1872 "color",
1873 "family",
1874 "font",
1875 "wrap",
1876 "max_lines",
1877 "ellipsis",
1878 "initial_letter",
1879 "underline",
1880 "underline_color",
1881 "underline_style",
1882 "strikethrough",
1883 "bold",
1884 "features",
1885];
1886
1887pub const BUTTON_ROWS_JSX: &[&str] = &[
1895 "onClick",
1896 "key",
1897 "index",
1898 "label",
1899 "description",
1900 "tooltip",
1901 "disabled",
1902 "accent",
1903];
1904pub const BUTTON_ROWS_LUA: &[&str] = &[
1905 "on_click",
1906 "key",
1907 "index",
1908 "label",
1909 "description",
1910 "tooltip",
1911 "disabled",
1912 "accent",
1913];
1914
1915pub const TOGGLE_ROWS_JSX: &[&str] = &[
1920 "onClick",
1921 "key",
1922 "label",
1923 "description",
1924 "tooltip",
1925 "disabled",
1926 "checked",
1927 "mixed",
1928];
1929pub const TOGGLE_ROWS_LUA: &[&str] = &[
1930 "on_click",
1931 "key",
1932 "label",
1933 "description",
1934 "tooltip",
1935 "disabled",
1936 "checked",
1937 "mixed",
1938];
1939pub const SLIDER_ROWS_JSX: &[&str] = &[
1943 "key",
1944 "label",
1945 "description",
1946 "tooltip",
1947 "disabled",
1948 "valueNow",
1949 "valueMin",
1950 "valueMax",
1951 "valueStep",
1952 "valueText",
1953 "onChange",
1954 "width",
1955 "minWidth",
1956 "maxWidth",
1957];
1958pub const SLIDER_ROWS_LUA: &[&str] = &[
1959 "key",
1960 "label",
1961 "description",
1962 "tooltip",
1963 "disabled",
1964 "value_now",
1965 "value_min",
1966 "value_max",
1967 "value_step",
1968 "value_text",
1969 "on_change",
1970 "width",
1971 "min_width",
1972 "max_width",
1973];
1974
1975pub const ELEMENTS: &[ElementDef] = &[
1976 ElementDef {
1977 name: "box",
1978 jsx_own: &[],
1979 lua_own: &[],
1980 jsx_rows: None,
1981 lua_rows: None,
1982 jsx: "`<box>`",
1983 lua: "`row { }`, `column { }`",
1984 c: "`kui_open*` … `kui_close`",
1985 odin: "`kui.box` / `kui.row` / `kui.column` in an `if`, closed at its end; `kui.open` … `kui.close` unscoped",
1986 doc: "A container: every container prop applies.",
1987 },
1988 ElementDef {
1989 name: "table",
1990 jsx_own: &[],
1991 lua_own: &[],
1992 jsx_rows: None,
1993 lua_rows: None,
1994 jsx: "`<box dir=\"table\">`",
1995 lua: "`grid { }`",
1996 c: "`kui_open*` with `dir = KUI_TABLE`",
1997 odin: "`kui.box` with `dir = .Table`",
1998 doc: "A column whose rows' children line up in columns (`docs/adr/0033-a-table-is-a-column-whose-cells-align.md`): its children are the rows, each row's in-flow children its cells, the nth cell of every row column n, and a column as wide as its widest cell — so a label column sits at its longest label with nothing measured and no width picked by hand, in every binding, since the alignment is the layout's and not a widget's. A cell's `width` says how its column sizes: `fit` (the default) and a fixed number are content the column's fit width is the max of; `grow` makes the whole column grow with the table, `grow` factors splitting the room the fit columns leave; a percent takes its cut of the row; and a column's `minWidth` / `maxWidth` are the strictest its cells declared. Fit columns that overflow the row are compressed toward their floors largest first, as a row's children are, unless the table scrolls x; a fixed column never is. A bare text is a cell too, held at its column's width, so a text straight inside a row is a column; an image straight in a row is a cell the same way, its box the column wide and its own aspect tall, the pixels meeting the box by its `fit` row (wrap an icon in a box to keep its own width). The rows are the table's `row` children, ordinary rows — give them `width=\"grow\"` for the columns to grow into (a `fit` row sits at the columns' width) — with their own `gap` between cells, their own padding, background, click, hover and access rows; a row of a table never wraps (`wrap-ignored`). Anything else straight under the table — a text, a `column` section, another table — is a child with its own width and no cells. The table's own `fit` width is its columns', whatever its rows' sizing, so a table with no width is the aligned list; a `scrollX` table's rows are at least as wide as its columns, and it scrolls to them. Everything else is a column's: `gap` is the space between rows, `scrollY` scrolls them, a float in a row is not a cell. Spelled `grid { }` in Lua, since `table` is Lua's own.",
1999 },
2000 ElementDef {
2001 name: "text",
2002 jsx_own: &["bold", "italic", "bg", "bgRadius"],
2003 lua_own: &["value", "spans"],
2004 jsx_rows: Some(TEXT_ROWS_JSX),
2005 lua_rows: Some(TEXT_ROWS_LUA),
2006 jsx: "`<text>` with `<span bold italic underline strikethrough bg bgRadius color family font size>` children",
2007 lua: "`text(\"s\", {…})`, `text({ \"a\", { \"b\", bold = true, underline = true, bg = 0x.., bg_radius = 4 }, { \"code\", family = \"mono\", size = 13 } })`",
2008 c: "`kui_text`, `kui_rich_text`",
2009 odin: "`kui.text`, `kui.rich_text`",
2010 doc: "Plain or rich text; spans shape as one paragraph, so wrapping crosses style boundaries. A text is content plus a style and no box of its own, so the rows it reads are the style rows (`size`, `lineHeight`, `color`, `family`, `font`, `wrap`, `maxLines`, `ellipsis`, `initialLetter`, `underline`, `strikethrough`, `features`) and nothing else: a container row, an access row (`label`, `role`, `live`), `key` or `onClick` on a text is dropped with an `unknown-prop` warning naming the rows it does take — put them on the box around it. `wrap`, `maxLines` and `ellipsis` control line breaking. A span's `bg` is a background behind its glyphs alone, one rect per line it spans, so it follows the span across a wrap the way a box around a run cannot. With `bgRadius` (`bg_radius` in Lua, `KuiSpan.bg_radius` in C, `Span::bg_radius` in Rust; logical px) the background is rounded and joined into one shape with every rounded background of the same colour and radius it meets: a piece whose edge touches it exactly on the line above or below and overlaps it sideways, or that meets it end to end on its own line, in this text or another. Its corners are then convex where a line reaches past its neighbour, a fillet where it falls short, and round where nothing meets it — a selection over many rows, or over the wrapped lines of a paragraph, is one rounded outline, joined after every text of the frame is laid out and painted, so it is never a frame behind. Nothing names the shape: two that touch are one; `underline` and `strikethrough` on a span or on the whole text are lines where the face puts them. A span takes a face and a size of its own: `family` (a stock name or an installed family's, as the text's) or `font` (a handle, which wins) — inline code in `mono` inside a sans paragraph — and `size` in logical px, its line height scaled at the paragraph's ratio (`Span::family` / `Span::mono` / `Span::size` in Rust, `KuiSpan.family` with `KUI_SPAN_FAMILY`, `.font` and `.size` in C). Its glyphs are shaped in that face, so a caret, a hit, a selection and the measurement read the same glyphs and byte positions stay exact across the change; a line is as tall as its tallest span, and a span's background is its own height around its glyphs. A paragraph with a sized span is shaped whole, never in chunks. A text with no line breaks that is 4096 bytes or longer (and no `maxLines` or `ellipsis`), plain or spans alike, is shaped in ~1 KB chunks as they come on screen, so a minified bundle or a log line with a blob in it costs the screenful it shows and a keystroke into it — or a span moving along it, an editor's caret — costs the chunk it lands in; wrapped, the rows are broken from the chunks' positions, so a 100k-character paragraph costs the rows it shows. Its size is estimated from the first chunk until the rest shape (exact under monospace), and the access tree carries its value without its runs.",
2011 },
2012 ElementDef {
2013 name: "button",
2014 jsx_own: &[],
2015 lua_own: &["text"],
2016 jsx_rows: Some(BUTTON_ROWS_JSX),
2017 lua_rows: Some(BUTTON_ROWS_LUA),
2018 jsx: "`<button onClick key|index label description tooltip disabled accent>`",
2019 lua: "`button { label=, on_click=, key= | index=, text=, description=, tooltip=, disabled=, accent= }`",
2020 c: "`kui_button`, `kui_button_with`",
2021 odin: "`kui.button`",
2022 doc: "The stock button: `widgets::button_spec(&theme, &metrics)` — the theme's accent trio as its three backgrounds, declared on the node and resolved by the core — keyed by its text (`key` overrides). It paints from the palette like every stock widget (backlog AR41): the OS's accent where the host reports one, the app's where it set or pinned one, kui's blue otherwise; the label goes black or white by the background's luminance. Its look is its spec, so the layout and paint rows are closed — declared, they are dropped with an `unknown-prop` warning naming the rows it does read — and those are the access rows: `label` when the text is not the name, `description`, `tooltip`, and `disabled` (inert, and dimmed to half). The one paint row it takes is `accent`, which on a button changes nothing (it is the accent already) and is kept for the box's sake. In Lua `label` is the name and the text both unless `text` says otherwise; in C the rows ride a `KuiSpec` whose other fields `kui_button_with` ignores. A button that needs any other row is a box with `role=\"button\"` and the same rows spelled out.",
2023 },
2024 ElementDef {
2025 name: "edit",
2026 jsx_own: &[
2027 "id",
2028 "initial",
2029 "multiline",
2030 "autofocus",
2031 "keepTab",
2032 "placeholder",
2033 ],
2034 lua_own: &[
2035 "initial",
2036 "multiline",
2037 "autofocus",
2038 "keep_tab",
2039 "placeholder",
2040 ],
2041 jsx_rows: None,
2042 lua_rows: None,
2043 jsx: "`<edit key initial multiline autofocus keepTab placeholder>`, `<input label initial>`",
2044 lua: "`edit { key=, initial=, keep_tab=, placeholder=, … }`, `input { label=, initial= }`",
2045 c: "`kui_text_edit`, `kui_text_edit_placeholder`, `kui_text_input`",
2046 odin: "`kui.text_edit`, `kui.text_input`",
2047 doc: "Retained editor state by key; read it back with `editText(key)` after a `changed` event. `initial` seeds a new editor only — a key declared again keeps the draft the user typed, and `setEditText(name, text)` is what resets one (it leaves the caret at the end). Name it by the label its `key` prop declares — `setEditText(\'note\', text)` — or by the hex key an event carried. It reaches an editor that does not exist yet: the text is held for the frame that declares that name and seeds it there, over `initial`, so the `update` that opens a rename field can fill it in the same turn, which is what the label spelling is for — the hex key comes from an event an editor being opened has not fired. A name nothing declares on that frame drops its text with an `edit-text-without-editor` warning. A single-line editor is a field and a `multiline` one a document, which decides how each is laid out as well as how it reads: a field takes one line whatever its box, sizes to the text it holds when its width is `fit`, and scrolls that line under the caret when it is not, while a document wraps to its box. The one exception is a field with `wrap` declared (`wrap=\"word\"` or `\"glyph\"`): it folds to its width the way a document does and keeps a field\'s keyboard — Enter still submits, a newline is still never admitted, the caret still opens at the end — so a rename field breaks where the label it renames breaks, and with `width=\"fit\"` plus `maxWidth` it sizes to its wrapped draft on the keystroke frame. A single-line editor opens with the caret after its seeded text, as a native field does; a multiline one is a document and opens at its top — a held `setEditText` is the call, not a seed, so it opens at the end either way. State is kept while the key is declared; an undeclared one is kept until the budget needs the room (256 undeclared editors, longest-undeclared evicted first). `autofocus` asks once: the editor takes focus on the frame the flag starts being declared — a new editor, or one whose flag just turned on — and only while nothing holds focus, so a blur afterwards stands and a focused control is never robbed (`docs/adr/0022-focus-regions.md`, decision 9); `focus(key)` is the call for taking it at any other time. A focused editor keeps the keys it acts on — the editing keys, what it types, the clipboard and undo chords — and a chord it does not (⌘N, Ctrl+K) goes to the nearest `onKey` sink above it, as a chord bubbles from a control (`docs/adr/0011-keys-bubble-to-the-enclosing-sink.md`, amended 2026-10-09). `keepTab` makes a field's Tab the app's: Tab and Shift-Tab do not walk the focus ring from it, and the press goes to the sink above it the same way, so a list or an outline built from fields indents on Tab; a `multiline` editor keeps Tab for indentation either way. An arrow, Backspace or Delete that meets the edge of the text emits `boundary` (see the events). `placeholder` is what an empty editor shows where its text would be, in the theme's `faint` — never part of the value, gone with the first character typed or composed, and read as the field's accessible description when it declares none.",
2048 },
2049 ElementDef {
2050 name: "select",
2051 jsx_own: &["label", "options", "current"],
2052 lua_own: &["label", "options", "current"],
2053 jsx_rows: Some(&[]),
2056 lua_rows: Some(&[]),
2057 jsx: "`<select label options={[…]} current>`",
2058 lua: "`dropdown { label=, options={…}, current= }`",
2059 c: "`kui_select`",
2060 odin: "`kui.select`",
2061 doc: "The stock select (`widgets::select_items`, backlog F72): a field showing the choice in force that, clicked, opens the core's own menu of the options under it with the current one checked — the menu a right-click opens, drawn in the frame or the platform's where the host shows menus itself, dismissed by Escape or a press outside, its rows walked by the arrows and read as a menu. `label` is the key and the accessible name both; `options` is a list whose entries are strings (an option by its label, posting it) or menu-item objects `{ label, id, enabled }` (posting `id`), and a `{ role: \"separator\" }` is a separator; `current` is the index in force, counted from 0 in JSX and C and from 1 in Lua, or none — one past the options or on a separator is none, with a `select-current-ignored` warning on the field; an empty `options` is refused, and a key of an option object no row reads (`disabled`, where the key is `enabled`) is an `unknown-prop` warning. The app holds no open state: the choice arrives as the `menu` event a menu row posts, on the field's key — `{kind: \"menu\", role: \"custom\", item: <the option>}` — and drawing the field again with the new `current` is the whole loop. A reader hears a button named by the field, described by its choice, expanded while the menu is open. Its look is its spec, so it reads no other row: a layout, paint or access row on it is dropped with an `unknown-prop` warning. Lua spells it `dropdown`, since `select` is Lua's own.",
2062 },
2063 ElementDef {
2064 name: "checkbox",
2065 jsx_own: &[],
2066 lua_own: &["text"],
2067 jsx_rows: Some(TOGGLE_ROWS_JSX),
2068 lua_rows: Some(TOGGLE_ROWS_LUA),
2069 jsx: "`<checkbox checked mixed onClick key label description tooltip disabled>text</checkbox>`",
2070 lua: "`checkbox { label=, checked=, mixed=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
2071 c: "`kui_checkbox`",
2072 odin: "`kui.checkbox`",
2073 doc: "The stock checkbox (`widgets::toggle_with`, ADR 0034): a box drawn from the state the view declares — `checked`, or `mixed` for the select-all box over a list some of whose rows are selected, drawn as a dash and read as mixed — and its label beside it, keyed by its text (`key` overrides). The state is the app's: a press by the pointer, Space, Enter or assistive technology posts `onClick`, and the view flips its model and draws it again. Its look is its spec, so the layout and paint rows are closed and dropped with an `unknown-prop` warning; the rows it reads are its state and the access rows. In Lua `label` is the name and the text both unless `text` says otherwise. The box is the metrics' control text plus one (16 px comfortable), so `compact` and `scaled` move it with the stock button.",
2074 },
2075 ElementDef {
2076 name: "radio",
2077 jsx_own: &[],
2078 lua_own: &["text"],
2079 jsx_rows: Some(TOGGLE_ROWS_JSX),
2080 lua_rows: Some(TOGGLE_ROWS_LUA),
2081 jsx: "`<radio checked onClick key label description tooltip disabled>text</radio>`",
2082 lua: "`radio { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
2083 c: "`kui_radio`",
2084 odin: "`kui.radio`",
2085 doc: "The stock radio (`widgets::toggle_with`, ADR 0034): a circle drawn from `checked`, and its label, keyed by its text. Put radios in a `radioGroup`, which makes them one Tab stop whose arrows, Home and End move the choice and press the radio they land on (ADR 0007), so radios whose `onClick` each set the choice answer the keyboard with no more code. The state is the app's, as a checkbox's is; the rows are the checkbox's, `mixed` aside.",
2086 },
2087 ElementDef {
2088 name: "radioGroup",
2089 jsx_own: &[],
2090 lua_own: &[],
2091 jsx_rows: None,
2092 lua_rows: None,
2093 jsx: "`<radioGroup label>…radios…</radioGroup>`",
2094 lua: "`radio_group { label=, … }`",
2095 c: "`kui_radio_group_open` … `kui_close`",
2096 odin: "`kui.radio_group` in an `if`, closed at its end",
2097 doc: "A container of radios (`widgets::radio_group_with`, ADR 0034): the `radioGroup` role, named by its `label`, laid out as a column with the stock gap — a `dir=\"row\"` lays the radios across, and its arrows run across with it. It reads every box row; the role and the name are its own whatever the rows say.",
2098 },
2099 ElementDef {
2100 name: "switch",
2101 jsx_own: &[],
2102 lua_own: &["text"],
2103 jsx_rows: Some(TOGGLE_ROWS_JSX),
2104 lua_rows: Some(TOGGLE_ROWS_LUA),
2105 jsx: "`<switch checked onClick key label description tooltip disabled>text</switch>`",
2106 lua: "`switch { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
2107 c: "`kui_switch`",
2108 odin: "`kui.toggle`",
2109 doc: "The stock switch (`widgets::toggle_with`, ADR 0034): a track and a knob drawn from `checked`, the knob sliding across when it changes, and its label; read as a switch, on or off. The state is the app's, as a checkbox's is; the rows are the checkbox's, `mixed` aside.",
2110 },
2111 ElementDef {
2112 name: "slider",
2113 jsx_own: &[],
2114 lua_own: &[],
2115 jsx_rows: Some(SLIDER_ROWS_JSX),
2116 lua_rows: Some(SLIDER_ROWS_LUA),
2117 jsx: "`<slider label valueNow valueMin valueMax valueStep valueText onChange width description tooltip disabled/>`",
2118 lua: "`slider { label=, value_now=, value_min=, value_max=, value_step=, value_text=, on_change=, width=, … }`",
2119 c: "`kui_slider`",
2120 odin: "`kui.slider`",
2121 doc: "The stock slider (`widgets::slider_with`, ADR 0034): a track, a fill to `valueNow` and a thumb, as wide as a menu (`width` sizes it), keyed by its `label`, which is also its accessible name. With `onChange` the core does the arithmetic: a press proposes the value under the pointer, a drag each new step, the arrows one `valueStep`, PageUp / PageDown ten, Home / End the ends, all clamped to `valueMin`..`valueMax` (0..100 unset) and snapped to the step, as `{kind:\"change\", value, phase:\"move\"|\"end\", tag}`. The value is proposed, never applied: the view stores it and declares it as `valueNow`. Its look is its spec, so the rows it reads are the value rows, the access rows and its width.",
2122 },
2123 ElementDef {
2124 name: "image",
2125 jsx_own: &["src", "sampling", "fit"],
2126 lua_own: &["id", "sampling", "fit"],
2127 jsx_rows: None,
2128 lua_rows: None,
2129 jsx: "`<image src={id} sampling fit>`",
2130 lua: "`image { id=, sampling=, fit= }`",
2131 c: "`kui_image`, `kui_image_with`",
2132 odin: "`kui.image`, `kui.image_with`",
2133 doc: "A registered RGBA image. Sizing: `width=\"fit\"` takes the pixel size, a fit height against a resolved width keeps the aspect, `radius` rounds it. Two rows say how the pixels meet the box (`docs/adr/0025-the-image-is-the-canvas.md`): `sampling` is `linear` (the default) or `nearest` — pixel art, an emulator, a data grid that must stay square under zoom; `fit` is `fill` (the default: the pixels stretch to the box), `contain` (the largest rect of the image's aspect that fits, centred, the rest of the box showing what is behind) or `cover` (the box filled and the pixels that do not fit cropped, centred). The box — its layout, its hit region, its access rect — is the same in every mode. The pixels come from the atlas, or from a texture of the image's own once `updateImage` has replaced them or when no atlas page could hold them; the node cannot tell and need not. Drawn at less than half its texels a pixel, a `linear` image is drawn from a level the core halved it to (`docs/adr/0044-an-image-drawn-smaller-is-drawn-from-a-level.md`): the deepest level with at least a texel a pixel, the 2×2 means taken in linear light, made once per session at the first draw that wants it and kept in the atlas in place of the whole image — so a photo registered as decoded and shown on a card is neither resampled by the app nor aliased on screen. The display's scale and any `scale` the node is drawn through count. `nearest` and an image ever updated (a stream) draw the whole image.",
2134 },
2135 ElementDef {
2136 name: "polygon",
2137 jsx_own: &["points"],
2139 lua_own: &["points"],
2140 jsx_rows: None,
2141 lua_rows: None,
2142 jsx: "`<polygon points={[[x,y],…]} bg/>`",
2143 lua: "`polygon { points={{x,y},…}, bg= }`",
2144 c: "`kui_polygon`",
2145 odin: "`kui.polygon`, its points a `[][2]f32`",
2146 doc: "A filled polygon through up to eight `points`, the fill in `bg` (`docs/adr/0025-the-image-is-the-canvas.md`, decision 6): an arrowhead, a pie slice, the area under a curve. Placed as a `line` is — always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box a pixel out on each side, so it takes no room in a row or column, and painted in the parent's layer at its place in the tree, over the siblings before it and under those after (backlog F123). A polygon in its parent's box space is held by the parent's clip as a child is, its hit region with it, so it is cut at a scroller's edge with the row it is drawn in; a declared float is held that way only when it declares `clip` with a parent anchor, and a `float=\"viewport\"` polygon escapes (backlog F78, `docs/adr/0010-a-segment-primitive.md` decision 5). `transition` eases the fill and, with `slide`, its position. The outline may be concave; a self-intersecting one fills even-odd, its overlaps unfilled. Hit by its outline (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press inside the outline hits it and one in its box past the outline falls through, so a pie's wedges need no hit boxes; with none it takes no input and has no access row, and with input it derives one as a box would (a clickable wedge is a button), so name it. A ninth point and later are dropped with `polygon-points-truncated`; fewer than three draw nothing; no `bg`, no fill. On the wire it is one `fragment` quad painted by a WGSL function the core registers itself, so a host that draws the list gets its source from `kui_fragment_source` like any other; what it costs is that quad and one pipeline switch per run of polygons. A stroked outline is a closed `line` over it.",
2147 },
2148 ElementDef {
2149 name: "path",
2150 jsx_own: &["d", "fillRule", "rotate", "pivot", "dash", "dashOffset"],
2154 lua_own: &[
2155 "d",
2156 "ops",
2157 "fill_rule",
2158 "rotate",
2159 "pivot",
2160 "dash",
2161 "dash_offset",
2162 ],
2163 jsx_rows: None,
2164 lua_rows: None,
2165 jsx: "`<path d=\"M … Z\" bg width color fillRule rotate pivot dash dashOffset/>`",
2166 lua: "`path { d = \"M … Z\", bg=, width=, color=, fill_rule=, rotate=, pivot=, dash=, dash_offset= }`",
2167 c: "`kui_path`",
2168 odin: "`kui.path`, `kui.path_d`",
2169 doc: "Any outline — SVG's `d`, a pie wedge with a round arc, a map's region, an icon — filled with `bg` by `fillRule` (`nonzero`, the default, or `evenodd`) and stroked `width` wide in `color` when `width` is given, the stroke over the fill (`docs/adr/0040-a-path-is-a-mask-in-the-atlas.md`). `d` is SVG path data (`M L H V C S Q T A Z`, absolute or relative), parsed by one parser in the core, so every binding draws the same shape; one that does not parse raises `path-malformed` and draws nothing. JSX also takes `d` as a flat number array of op codes and operands, Lua the same as `ops`, and C only that form (`kui_path_parse` turns a string into it). Placed as a `line` is — always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box two pixels out on each side (half the stroke's width further), so it takes no room in a row or column, held by the parent's clip as a child is and painted in the parent's layer at its place in the tree (backlog F123). `transition` eases the fill and, with `slide`, its position; the stroke's colour does not tween, as a box's border does not. Hit by its outline under the fill rule (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press inside hits it and one in its box past the outline falls through, so a pie's wedges need no hit boxes; a stroke with no fill is hit by its stroke as a line is; with input it derives an access row as a box would (a clickable wedge is a button), so name it. On the wire it is one glyph-mask quad per paint, fill and stroke: the outline is rasterized once per shape, scale and quarter-pixel position into the glyph atlas and tinted like a glyph, so a host that draws text draws paths, and nothing is re-rasterized for a colour tween, a hover or a slide. The fill bleeds half a pixel, so two paths sharing an edge meet without the background showing through; a chart that wants separators gaps its own geometry. A mask a quarter of the biggest atlas page or more, or a path whose ops change twice within a few frames, draws from a texture of its own instead (a `texture` quad), and one past 8192 px on a side draws nothing, with `path-too-large`. `rotate` turns the path, in turns clockwise, about `pivot` — a point in the path's own coordinates, the centre of its box without one (`docs/adr/0041-a-mask-turns-about-its-centre.md`): the turn is the quad's and not the mask's, so a path that only turns — a spinner's arc about its circle's centre — is rasterized once and stays in the atlas at every angle. A path with `rotate` or `pivot` is boxed by the square the turn sweeps, its mask centred on the pivot on a whole pixel, and it is hit where it is drawn; `rotate` does not tween. `dash` and `dashOffset` cut the stroke into marks and gaps as a `line`'s do (backlog V2) — lengths as seen, round-capped marks, a gap the dots overlap closed — restarting at every subpath as SVG's do; the pattern is part of the stroke's mask, so a dashed stroke costs what a solid one does, a stroke with no fill is still hit along its gaps, and a `dashOffset` that changes every frame is a shape that changes every frame: the path leaves the atlas for a texture of its own while it marches.",
2170 },
2171 ElementDef {
2172 name: "fragment",
2173 jsx_own: &["src", "image", "params", "animate"],
2174 lua_own: &["id", "image", "params", "animate"],
2175 jsx_rows: None,
2176 lua_rows: None,
2177 jsx: "`<fragment src={id} image={id} params={[…]} animate>`",
2178 lua: "`fragment { id=, image=, params={…}, animate= }`",
2179 c: "`kui_fragment`, `kui_fragment_with`",
2180 odin: "`kui.fragment`, `kui.fragment_with`; `kui.fragment_open` in an `if` holds children",
2181 doc: "A box a registered WGSL function paints (`docs/adr/0015-a-fragment-element-and-the-painter-it-is-not.md`): a conic or a moving gradient, rings, noise, shimmer — anything the paint vocabulary has no prop for. An ordinary node otherwise — it lays out, rounds, clips, fades, takes input and holds children, which paint over it — but with **no intrinsic size**, so give it a `width`/`height` or `fill` or it is zero by zero. `src` is a handle from `add_fragment`, which validates the source and warns rather than minting one that cannot compile. `params` is up to sixteen numbers the shader reads as four `vec4<f32>`; more are dropped with a warning. `image` is a registered image the function reads — `kui_sample(uv)` (bilinear) and `kui_sample_nearest(uv)` return its texels at `uv` in `[0,1]²`, and `in.image` is its texel rect, `zw` the size — which is what makes a replaced image a waveform, a heatmap, a 50k-point line or an image effect from one quad (`docs/adr/0025-the-image-is-the-canvas.md`, decision 7); the core binds the atlas or the image's own texture, whichever holds it, and a fragment whose image is not live draws nothing, as one whose `src` is not does. `animate` asks for a frame every frame, which is what a fragment that reads `time` needs and what a still one must not declare.",
2182 },
2183 ElementDef {
2184 name: "cells",
2185 jsx_own: &[
2186 "rows",
2187 "cols",
2188 "cells",
2189 "cursorAt",
2190 "cursorShape",
2191 "cursorColor",
2192 "originLine",
2193 ],
2194 lua_own: &[
2195 "rows",
2196 "cols",
2197 "lines",
2198 "runs",
2199 "cursor_at",
2200 "cursor_shape",
2201 "cursor_color",
2202 "origin_line",
2203 ],
2204 jsx_rows: None,
2205 lua_rows: None,
2206 jsx: "`<cells rows cols cells={Uint32Array} cursorAt={[row, col]} cursorShape cursorColor size family lineHeight/>`",
2207 lua: "`cells { rows=, cols=, lines={\"row text\", …}, runs={{row, col, len, fg, bg, flags}, …}, cursor_at={row, col}, cursor_shape=, cursor_color=, size=, family= }`",
2208 c: "`kui_cells`",
2209 odin: "`kui.cells`",
2210 doc: "A terminal's screen as one node (backlog C20): `rows × cols` cells, each a character, a foreground and background as `0xRRGGBBAA` (0 = no background), and attribute bits — 1 bold, 2 italic, 4 underline, 8 strikethrough, 16 wide (the glyph spans this cell and the next, which the app leaves blank), 32 the underline is a wave (a terminal's undercurl, SGR 4:3) and 64 dotted (SGR 4:4), either implying it — plus, optionally, the underline's own colour (SGR 58), 0 for the foreground (backlog K4). A glyph is shaped once per character and style variant and thereafter placed at `col × cell_w` without shaping, so a screen whose every cell is new each frame costs what a still one costs (~60 µs for 200 × 50). The cell width is `M`'s advance in the style's font snapped to whole pixels, the height its `lineHeight`; a cell is a cell, so ligatures never form. A character the family has no glyph for is asked of a monospaced face before the platform's fallback list, shaped smaller where it is still wider than its cells (two under wide), and drawn in their middle (backlog F120); the private use area's icons are left as they fall. Box drawing and block elements (U+2500–U+259F) and the Powerline separators (U+E0B0–U+E0BF: the arrows, and the Powerline Extra half circles and wedges) are not shaped at all but drawn from the cell box — a font's are its own line box tall, a cell is `lineHeight` tall, and through the font every `│` was a dash with a gap under it (backlog F66) and a rounded cap a fallback font's squiggle (F112) — so a TUI's frames and rounded rows are seamless in any font, and bold does not thicken a light line (the set has its heavy variants). JSX passes the cells as a `Uint32Array` (or number array) of four entries per cell — codepoint, fg, bg, flags — or five, with the underline colour, in row-major order; Lua a string per row in `lines` plus `runs` of `{row, col, len, fg, bg, flags, ul}` over them (a run's fg, bg or ul of 0 keeps the default: the style's colour, no background, the foreground); C a `KuiCell` array with `ul`. `cursorAt` (`cursor_at`) names a cell to paint under its glyph in `cursorColor` as a `block` (default), `bar` or `underline` — its own name, since `cursor` is the pointer shape. `originLine` (`origin_line`) is the absolute line number of row 0: a grid is one screenful of the app's own history, so a row number means a different line after every scroll, and stamping where the screen sits is what lets a selection keep its ends across one (`docs/adr/0017-selection-as-a-scope.md`). Saying nothing is 0, and a selection then holds only while the screen does not move. The node's own rows apply — an `onKey` makes it the terminal's sink, an `onClick` or `onDrag` carries `cell: {row, col}` on its events — and its access row is `terminal`, the rows joined as its value.",
2211 },
2212 ElementDef {
2213 name: "line",
2214 jsx_own: &["from", "to", "points", "curve", "dash", "dashOffset"],
2217 lua_own: &["from", "to", "points", "curve", "dash", "dash_offset"],
2218 jsx_rows: None,
2219 lua_rows: None,
2220 jsx: "`<line from={[x,y]} to={[x,y]} width color/>`, `<line points={[[x,y],…]} curve dash={[6, 4]} dashOffset/>`",
2221 lua: "`line { from={x,y}, to={x,y}, width=, color= }`, `line { points={{x,y},…}, curve=true, dash={6, 4}, dash_offset= }`",
2222 c: "`kui_line`, `kui_polyline`",
2223 odin: "`kui.line`, `kui.polyline` (points, `[][2]f32`)",
2224 doc: "A round-capped stroke: one segment, a polyline through `points`, or a smooth curve through them with `curve`. Always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box, so it takes no room in a row or column — but a float for the room alone: in its parent's box space it paints in the parent's layer at its place in the tree, over the siblings declared before it and under those after, as a child does, and opens no layer of its own (backlog F123; a connector meant to sit under two cards is declared before them). A stroke in its parent's box space is held by the parent's clip as a child is, its hit region with it, so it is cut at a scroller's edge with the row it is drawn in; a declared float is held that way only when it declares `clip` with a parent anchor, and a `float=\"viewport\"` stroke escapes, and is a layer of its own (backlog F78, `docs/adr/0010-a-segment-primitive.md` decision 5). `width` is the stroke width (default 1) and `color` the stroke colour; `transition` eases the colour, and with `slide` beside it the stroke's position too — the points ride its box, so a stroke whose ends all move together slides with them, while one whose ends move apart resizes at once (a canvas of floats eases everything or nothing, connectors included). Hit by its shape (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press within half the width of any piece hits it — at least 4 px of grab, so a hairline is a target — and a press elsewhere in its bounding box falls through to what is under; with none it takes no input and has no access row, and with input it derives one as a box would (a clickable connector is a button), so name it. What it costs: one quad per segment, and a curve is flattened in the core at one piece per 6 logical px of chord (at most 32 per span) — fixed rather than tolerance-driven so every binding gets the same pieces and the corpus can pin them — so a nine-point curve over ~50 px spans is ~60 quads, and a `quadCount` budget should expect it. `dash` cuts the stroke into marks and gaps (backlog V2): one length (marks and gaps alike), a mark and a gap, or four lengths for a dash-dot, in px **as seen** — every mark is a short stroke with the stroke's round caps, so `dash` 6, 4 is 6 px of ink and 4 px of nothing at any width up to 6 (SVG's `stroke-dasharray` measures the centre line instead, so with round caps its `4 4` at a width of 4 is solid; this pattern is SVG's `mark − width, gap + width`). A mark no longer than the stroke is wide is a dot as wide as the stroke, in the same period, so its gap is that much shorter; where a mark and its gap together come to no more than the width the dots meet and the gap closes — the marks either side of it are one, and a pattern with no gap left, `dash` 2, 2 at a width of 8, draws solid (backlog RG118). The pattern runs along the stroke's whole length, so it keeps its phase round the corners of a polyline and the pieces of a curve, and `dashOffset` starts that far into it — growing it moves the marks towards the first point, a marquee's marching ants; neither tweens. A pattern with no gap, a mark and gap under a physical pixel together, or more than 16384 marks draws solid. A dashed stroke is hit along its whole length, gaps included, and costs a quad per mark per piece the mark lies on.",
2225 },
2226 ElementDef {
2227 name: "titlebar",
2228 jsx_own: &[],
2229 lua_own: &["title"],
2232 jsx_rows: None,
2233 lua_rows: None,
2234 jsx: "`<titlebar title>` or `<titlebar>…</titlebar>`",
2235 lua: "`titlebar { title= }` / `titlebar { … }`",
2236 c: "`kui_titlebar`, `kui_titlebar_with`",
2237 odin: "`kui.titlebar`, `kui.titlebar_with`",
2238 doc: "Adaptive titlebar for custom chrome: drag strip, native-control inset, window buttons.",
2239 },
2240 ElementDef {
2241 name: "menuBar",
2242 jsx_own: &["menu"],
2243 lua_own: &["menu"],
2244 jsx_rows: None,
2245 lua_rows: None,
2246 jsx: "`<menuBar menu={[{ label, items: [{ label, id?, role?, accel?, enabled?, checked?, items? }] }]}/>`",
2247 lua: "`menu_bar { menu = { { label=, items= { { label=, id=, role=, accel=, enabled=, checked=, items= } } } } }`",
2248 c: "`kui_menu_bar`",
2249 odin: "`kui.menu_bar`",
2250 doc: "The application menu (`docs/adr/0018-a-menu-bar-the-app-declares.md`): `menu` is what it *is*, and where this element sits is where its titles go when they have to be drawn in the window. One call and not two, because declaring the menu and placing the strip are one decision. It draws **nothing** where the platform owns the bar — macOS, where the driver hands the same declaration to the OS — so the frame has still said what the app's menu is and the strip simply is not there; that is the contract `windowButtons` has under native decorations, and it is what makes one view portable. Its rows are the rows a context menu has: the same `role`s the core performs itself (`copy`, `paste`, `selectAll`, `cut`, `lookUp`), the same `id` payload, the same `accel` text, plus `checked` for a setting — and choosing one posts the same `{kind:\"menu\", role, item}` event, so an app handles one thing whichever menu it came from. Declared every frame and diffed: an unchanged menu costs a comparison, and an empty list takes it away. An accelerator kui can parse is rewritten into the platform's spelling, so `\"mod+s\"` reads as `⌘S` on macOS and `Ctrl+S` elsewhere and binds that key in the platform's own bar. On macOS the first menu is the application menu, which the OS titles with the app's own name whatever the label says. While a menu is open the bar is the frame's modal scope, so hovering across the titles moves the open menu, a press on the open title closes it, and Escape or a press in the app below closes it and reaches nothing else.",
2251 },
2252 ElementDef {
2253 name: "windowButtons",
2254 jsx_own: &[],
2255 lua_own: &[],
2256 jsx_rows: None,
2257 lua_rows: None,
2258 jsx: "`<windowButtons/>`",
2259 lua: "`window_buttons()`",
2260 c: "`kui_window_buttons`",
2261 odin: "`kui.window_buttons`",
2262 doc: "Just the min/max/close buttons, for fully custom titlebars.",
2263 },
2264 ElementDef {
2265 name: "tooltip",
2266 jsx_own: &["value"],
2267 lua_own: &["value"],
2268 jsx_rows: None,
2269 lua_rows: None,
2270 jsx: "`<tooltip value=\"hint\"/>` / `<tooltip>…</tooltip>` nodes, or the `tooltip=\"hint\"` prop (see composites)",
2271 lua: "`tooltip(\"hint\")` / `tooltip { … }` nodes, or the prop",
2272 c: "`kui_tooltip`, `kui_tooltip_with`",
2273 odin: "`kui.tooltip`, `kui.tooltip_with`",
2274 doc: "A float hanging below the parent; the node form always draws, the prop form is hover-gated.",
2275 },
2276 ElementDef {
2277 name: "latencyGraph",
2278 jsx_own: &["at"],
2279 lua_own: &["at"],
2280 jsx_rows: None,
2281 lua_rows: None,
2282 jsx: "`<latencyGraph/>`, `<latencyHud at/>`",
2283 lua: "`latency_graph()`, `latency_hud { at= }`",
2284 c: "`kui_latency_graph`, `kui_latency_hud`",
2285 odin: "`kui.latency_graph`, `kui.latency_hud`",
2286 doc: "Per-phase frame timing (windowed drivers fill it; headless shows the chrome empty).",
2287 },
2288 ElementDef {
2289 name: "audio",
2290 jsx_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2291 lua_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2292 jsx_rows: None,
2293 lua_rows: None,
2294 jsx: "`<audio src={id} loop volume paused finish tag/>`",
2295 lua: "`audio { src=, loop=, volume=, paused=, finish=, tag= }`",
2296 c: "`kui_audio`",
2297 odin: "`kui.audio`",
2298 doc: "A playback retained by node key: present = playing (once, or looped), gone = stopped; `volume` / `paused` apply live, a changed `src` restarts; a `tag` brings back `{kind:\"sound\", phase:\"ended\", tag}`. Draws nothing. `finish` changes what *gone* means: the node's removal releases the playback rather than stopping it, so a one-shot plays to its end and the view need not know the asset's length to declare the node for it (a loop still stops on removal — there is no end to reach — and a paused playback released has nothing to finish). Without it, the way to play a sound whole is to hold the node declared until the `tag`'s `ended` message arrives. A released playback is not free: it holds one of the device's 128 voices until its file ends, and the 129th play is refused — reported as a `playback-refused` warning and, for a `tag`, `phase: \"refused\"` rather than a wait that never returns. In the app's units, voices held = sound length × release rate: a 1.4 s chime released four times a second holds 6 of the 128 at any moment, a 10 s ambience released once a second holds 10, and every playback still declared (a loop included) counts beside them — a `refused` `sound` event is what arriving at 128 sounds like.",
2299 },
2300];
2301
2302pub struct EventDef {
2304 pub kind: &'static str,
2305 pub payload: &'static str,
2306 pub doc: &'static str,
2307}
2308
2309pub const EVENTS: &[EventDef] = &[
2310 EventDef {
2311 kind: "click",
2312 payload: "the `onClick` payload as-is",
2313 doc: "A press and release on the node (suppressed when a drag moved past the slop). A map payload gains fields where the node can say more: `cell: {row, col}` on a `cells` grid, and inside an `onKey` sink that draws `role=\"line\"` rows, `line`, `byte`, `inside` and `clicks` as a `drag` inside one carries them.",
2314 },
2315 EventDef {
2316 kind: "drag",
2317 payload: "`{ kind: \"drag\", phase: \"start\" | \"move\" | \"end\", x, y, dx, dy, parent: { x, y, w, h }, tag }`",
2318 doc: "A pointer-captured drag on an `onDrag` node. `x`/`y` are where the pointer is; `dx`/`dy` are its displacement **from the press point**, in every phase — `start` carries zero, a `move` how far the pointer is from where it pressed, `end` the whole distance — so a handler sets `value = start + dx` rather than summing deltas, and can commit from `end` alone. Nothing is dropped under the click slop (3 px, measured from the press): the first `move` already carries the whole distance. `parent` is the container rect, so fractions need no geometry query. On a `cells` grid every phase also carries `cell: {row, col}`. Inside an `onKey` sink that draws `role=\"line\"` rows — an editor the app owns — every phase carries `line` (the ordinal among the sink's lines, the numbering its `access` events use), `byte` (where the point falls in that line's text, what `textHit` would answer) and `clicks` (the press's count), so click-to-caret, drag-select and double-click-word are arithmetic on the event with no query and no frame of lag; a point above the first line is the first, below the last the last, and one in a `role=\"none\"` gutter is the line beside it, and `inside` says whether the point is within that line's own box at all — false above, below and in the margin beside a row, so a margin gesture (block selection) is told from a press on the text without comparing `x` to a rect. Nothing is added where the sink draws no lines.",
2319 },
2320 EventDef {
2321 kind: "key",
2322 payload: "`{ kind: \"key\", phase: \"down\" | \"up\", code, physical, shift, ctrl, alt, super, text, repeat, location, caps_lock, num_lock, tag }`",
2323 doc: "A key press or release on the focused `onKey` sink; `code` is a character or a name (`\"left\"`, `\"f5\"`) and is what a keymap binds against. `physical` is the US-QWERTY key at that *position*, spelled the same way — bind it instead when you want the finger rather than the label (WASD stays a square on every layout). `code` follows the layout while the layout speaks ASCII, so a chord lands on the key the user can see (Dvorak's `⌥v` on the key printed V); on a layout that does not (Cyrillic, Greek, Hebrew, Arabic) the position's US key stands in, as Shift prints it (`J`, `:`; unshifted under Alt, as a chord reads it), so a Latin keymap keeps matching instead of matching nothing. A shifted letter arrives as the upper-case letter — `Z` with `shift` set for ⇧⌘Z, `physical` staying `z` — so a keymap that binds letters folds a one-character `code` to lower case under a chord; a headless press is spelled the same way, since no door re-spells it (`\"z\"` with `shift` is a chord no keyboard produces). `repeat` marks a press the OS auto-repeated; `text` is what the press would insert — always the layout's own character — and is null on every release. A key only comes up where it went down: a release whose press the sink never got is dropped, and focus leaving while a key is held delivers the `up` first, so a held-key binding (WASD, press-and-hold) cannot be left stuck down. `location` says which of a key's twins it was (backlog F108): `\"left\"` or `\"right\"` for a modifier, `\"numpad\"` for the keypad's digits, operators, Enter and (Num Lock off) arrows — `code` still `\"1\"`, `\"enter\"` — else `\"standard\"`; `caps_lock` and `num_lock` what the lock keys held. The keys F13–F35, `printscreen`, `pause`, `menu`, `clear` and the media keys (`mediaplaypause`, `volumeup`, …) are keys like any other; the modifier and lock keys themselves (`shift`, `ctrl`, `alt`, `super`, `capslock`, `numlock`, `scrolllock`) reach only a sink that says `modifierKeys`.",
2324 },
2325 EventDef {
2326 kind: "text",
2327 payload: "`{ kind: \"text\", text, pasted?: true, concealed?: true, transient?: true, tag }`",
2328 doc: "Text an IME committed at the end of a composition — or the clipboard's text, when the app asked for a paste with `requestPaste` / `request_paste` / `kui_request_paste` — on the focused `onKey` sink (or the nearest one above the focused control, or the root sink with nothing focused) — the one committed text the platform never reports as a key press carrying `text`, so a custom editor inserts it as it would a key's `text`. Plain typing does not arrive this way: the `key` event already carries what the press would insert, and a sink hearing both would type every character twice. A focused `<edit>` takes the commit itself and reports `changed`. A paste's answer carries `pasted: true` (backlog DX14) — an answer being the host's paste reply, or any commit while a paste is outstanding — so a sink that asked tells the clipboard's text from an IME's commit without keeping its own flag; an IME commit has no `pasted`. It also says what the pasteboard marked it (backlog F84): `concealed: true` for a secret — a password manager's copy, which a view should not show, log or keep — and `transient: true` for text not to keep in a history, after the nspasteboard.org convention (on Windows the clipboard's exclusion formats); a marker that is not set is absent, never false. The runner reads them on macOS and Windows; on Linux, and from a host that answers with a bare commit, a paste arrives unmarked.",
2329 },
2330 EventDef {
2331 kind: "preedit",
2332 payload: "`{ kind: \"preedit\", text, cursor: [start, end] | null, tag }`",
2333 doc: "An in-progress IME composition on the focused `onKey` sink: `text` is the uncommitted string to show inline at the caret, `cursor` the byte range inside it the IME's own caret covers (null when it does not say), and an empty `text` means the composition ended without a commit, so what was shown goes away. The OS candidate window is anchored for you: the `line` carrying `caret` says where. A focused `<edit>` draws the composition itself.",
2334 },
2335 EventDef {
2336 kind: "selectionrange",
2337 payload: "`{ kind: \"selectionrange\", from: { index, byte }, to: { index, byte } }` on the scope",
2338 doc: "A copy reached rows of a `selectable` virtual list that no frame built (`docs/adr/0017-selection-as-a-scope.md`, tier 3): the core cannot read text it never laid out, so it asks the app for the range — `index` is a row's data index (its `index` prop), `byte` an offset into that row's text, past the row's length for \"the whole row\" (a Select All over a list that declared `rowCount` ends that way, on its last row) — and the app answers with `answerSelectionRange(text)` / `answer_selection_range` / `kui_answer_selection_range`, which is what reaches the clipboard as a `setClipboard` action. Raised only while a copy is outstanding (`requestCopy()` answered `asked`, or the runner's Cmd/Ctrl-C did); a late answer changes nothing. `examples/rust/features/clipboard.rs` and its Node twin show the round trip.",
2339 },
2340 EventDef {
2341 kind: "contextmenu",
2342 payload: "`{ kind: \"contextmenu\", x, y, tag }`",
2343 doc: "A secondary-button press on an `onContextMenu` node, on the press rather than the release; `x`/`y` are logical viewport coordinates — where the menu goes. The core opens nothing: the app declares the menu (a `modal` float) and stops declaring it on `dismiss`.",
2344 },
2345 EventDef {
2346 kind: "menu",
2347 payload: "`{ kind: \"menu\", role, item }`",
2348 doc: "A row of the core's own context menu was chosen (`openMenu` / `open_menu` / `kui_open_menu`), on the node the menu was about. `item` is the row's `id`, or its label when it declared none; `role` is the row's standard role or `custom`. Every chosen row posts, the standard ones included: a `cut` or `paste` role is carried out by the core (its clipboard work queued for the host) *and* reported, so an app can hear its editor being cut from and is free to ignore it (`docs/adr/0017-selection-as-a-scope.md`, decision 5).",
2349 },
2350 EventDef {
2351 kind: "forceclick",
2352 payload: "`{ kind: \"forceclick\", x, y, tag }`",
2353 doc: "A press that deepened past the second stage of a Force Touch trackpad, on an `onForceClick` node, at the logical viewport point it happened at. Routed as a secondary press is — no focus moved, no caret placed, no click — but asked of the topmost node only, and the ordinary click the press is still producing arrives afterwards. Text needs none of this: over an `edit` or a `selectable` scope the core selects the word under it and asks the host for its Look Up panel instead. macOS-only in practice.",
2354 },
2355 EventDef {
2356 kind: "button",
2357 payload: "`{ kind: \"button\", phase: \"press\" | \"move\" | \"release\", button: \"secondary\" | \"middle\" | number, x, y, clicks, cell?: { row, col }, line?, byte?, inside?, tag }`",
2358 doc: "A non-primary button on an `onButton` node that claims it (`buttons`), backlog F105: `press` where it went down — with the driver's click count, `clicks`, which the native runner keeps for the primary button alone and so always reports as 1 here — then `move` for every pointer move while it is held and `release` where it came up, both on the same node wherever the pointer went, since the press captured the button. `button` is the button's name, or for one past the middle button its number (`3 + n`, as `kui_input_mouse_button` takes it; Node's `ctx.mouse` takes the three names only); `x`/`y` are logical viewport coordinates. On a `cells` grid each carries `cell: {row, col}`, clamped to the grid, and inside an `onKey` sink that draws `role=\"line\"` rows `line`, `byte` and `inside` as a drag does. A claimed secondary press is this event instead of `contextmenu`; the press moves no focus, caret, selection or scrollbar.",
2359 },
2360 EventDef {
2361 kind: "scroll",
2362 payload: "`{ kind: \"scroll\", x, y, dx, dy, lines, mods?: { shift, ctrl, alt, super }, tag }`",
2363 doc: "The wheel over an `onScroll` node, or a drag-select held past a `cells` grid's top or bottom edge: `dx`/`dy` the delta in logical px as the driver reported it (positive `dy` is the wheel rolling up, toward earlier content), `x`/`y` the pointer in logical viewport coordinates, `lines` the whole lines a `cells` grid's `dy` covers — positive is later history, the sign `originLine` grows in, the fraction carried to the next notch — and null on any other node. The core scrolls nothing for it: the app re-declares the grid's `originLine`, or zooms its canvas. From the edge drag it comes once a frame while the pointer is held past the edge, with the lines that frame's step covers, and the selection's absolute lines survive the scroll the app answers with (`docs/adr/0029-a-selection-follows-the-pointer-past-the-edge.md`).",
2364 },
2365 EventDef {
2366 kind: "focus",
2367 payload: "`{ kind: \"focus\", phase: \"in\" | \"out\", by: \"pointer\" | \"keyboard\" | \"assistive\" | \"program\", tag }`",
2368 doc: "Keyboard focus entered or left an `onFocus` node's subtree (backlog DX18). `by` is what moved it — a press, a key, a screen reader's request, or the view and the app — so a pane that follows a click into its sink tells that apart from a move the app made itself.",
2369 },
2370 EventDef {
2371 kind: "hover",
2372 payload: "`{ kind: \"hover\", phase: \"enter\" | \"leave\", by: \"pointer\" | \"content\", tag }`",
2373 doc: "The pointer entered or left an `onHover` node — also when a new frame moved it under a still cursor. `by` says which (backlog DX20): `pointer` when the pointer moved or left the window, `content` when it stayed and what is under it changed — a list scrolled by the wheel or the keys, a row that grew, a float that opened. A picker whose selection follows the pointer ignores `content`, or the rows sliding under a still pointer as the keys scroll the list drag the selection with them.",
2374 },
2375 EventDef {
2376 kind: "drop",
2377 payload: "`{ kind: \"drop\", phase: \"enter\" | \"move\" | \"leave\" | \"drop\", paths: string[], x, y, tag }`",
2378 doc: "Files dragged in from the OS over an `onDrop` node (`docs/adr/0031-a-drop-zone-is-a-row-and-the-files-are-an-event.md`): `enter` when they come over the zone, `move` while they move over it (never twice for one point), `leave` when they go to another zone, to no zone or out of the window, `drop` when they land — and no `leave` after a `drop`. `paths` are the OS paths as strings; `x`/`y` the pointer in logical viewport coordinates, absent on `leave`. The zone is the topmost one under the pointer by paint order; a node inside it is its, and a node that is no zone is looked past (an overlay shown on `enter` does not end the hover). Nothing is re-resolved when a frame lands: only the driver's next report moves the files, so a zone the view stops declaring hears its `leave` then.",
2379 },
2380 EventDef {
2381 kind: "files",
2382 payload: "`{ kind: \"files\", paths: string[], tag }`",
2383 doc: "A file dialog's answer (backlog C51): what an Open, Save or folder dialog asked for with `requestFiles` / `request_files` / `kui_request_files` picked — the OS paths, as a `drop` carries them — or no paths when the user cancelled. `tag` is the dialog's own. It reaches whoever asked: the host, or the extension whose fill asked; one dialog is out at a time.",
2384 },
2385 EventDef {
2386 kind: "open",
2387 payload: "`{ kind: \"open\", paths: string[] }` on the root",
2388 doc: "The OS asked the app to open documents (backlog F124): the Finder's Open With, a file dropped on the Dock icon, `open -a App file`, a double-click on a document of a type the app's `Info.plist` declares under `CFBundleDocumentTypes`. Delivered to the host on the root whether or not anything asked — unlike `files`, which answers an ask. `paths` are file-system paths as strings; a URL of a scheme the app registers is not one, and is not carried (room is left for a `urls` beside `paths`). The macOS runner sends it at launch — held until the main window has opened, since AppKit hands the documents over before it exists and puts none in the arguments — and while the app runs; a host driving its own window sends it as input (`openDocuments`, `kui_input_open`, `InputEvent::Open`). Windows and Linux pass documents in the process's arguments instead, and nothing sends it there.",
2389 },
2390 EventDef {
2391 kind: "layout",
2392 payload: "`{ kind: \"layout\", x, y, w, h, parent: { x, y, w, h }, scale, tag }`",
2393 doc: "The rect layout gave an `onLayout` node (logical px, viewport coords, after scrolling and easing): on its first frame and whenever it changes, never on a frame that left it alone. `scale` is physical px per logical px at the node — `w × scale` by `h × scale` is how many pixels to render for it before `updateImage` (the frame's scale today; where a zoom would compose in).",
2394 },
2395 EventDef {
2396 kind: "resize",
2397 payload: "`{ kind: \"resize\", width, height, scale }`",
2398 doc: "The viewport changed size or DPI (logical px, delivered to the host on the root): the window less the devtools' dock while the panel is docked (`docs/adr/0024`), so a dock coming, going or being dragged is a resize too. `KuiWindow.size()` queries the same numbers, before the first frame as well (backlog F43). The first frame establishes the viewport rather than reporting it, so a dock present at launch posts none.",
2399 },
2400 EventDef {
2401 kind: "window",
2402 payload: "`{ kind: \"window\", phase: \"opened\" | \"closed\" | \"focused\" | \"blurred\", name, id }`",
2403 doc: "A declared window opened (the diff queued its `Open`) or closed — because nothing declares it any more, or because the user closed it, in which case it stays closed while still declared: stop declaring `name`, then declare it again to reopen. `id` is what its events carry; the event itself is on the root of whichever window's frame noticed. `focused` and `blurred` are this window gaining and losing the keyboard (backlog DX18) — `env.focused` changing, as the driver reports it — so an app that saves on blur or re-reads the clipboard on return hears it once instead of diffing `env.focused` every frame.",
2404 },
2405 EventDef {
2406 kind: "system",
2407 payload: "`{ kind: \"system\", appearance, accent, motion, locale, assistive }`",
2408 doc: "An OS setting the user changed while the app was open — the light/dark appearance, the accent colour, reduced motion, or the UI language — or assistive technology starting to listen (delivered to the host on the root, one per window that noticed). The payload is `env.system` as it now reads, in the same spellings and with the same nulls, so a handler can keep the whole reading or take the one field it branches on. The first frame establishes the reading rather than reporting it, the way the viewport does; a host whose view is a function the runner calls every frame can equally re-read `env` and ignore this, but a host that retains the tree it was handed (Node, C, Lua) only re-runs its view for a message, so this is how a palette follows the OS.",
2409 },
2410 EventDef {
2411 kind: "fonts",
2412 payload: "`{ kind: \"fonts\" }`",
2413 doc: "The system's installed fonts changed: a rescan found a face installed or removed since the last one (delivered to the host on the root, one per window that noticed). The winit runner rescans itself when macOS or Windows says the set changed; elsewhere it is the app calling `reloadSystemFonts`. Re-read `systemFonts()` / `systemFontFamilies()` here if the model holds them; a view naming a family by `family` needs nothing, it resolves on the same frame. A font the app loads itself raises none, and the first frame establishes the set rather than reporting it.",
2414 },
2415 EventDef {
2416 kind: "modifiers",
2417 payload: "`{ kind: \"modifiers\", shift, ctrl, alt, super }`",
2418 doc: "The physical modifier state changed (delivered to the host on the root).",
2419 },
2420 EventDef {
2421 kind: "changed",
2422 payload: "`{ kind: \"changed\" }`, with the editor's key on the event",
2423 doc: "An editor's text changed.",
2424 },
2425 EventDef {
2426 kind: "submit",
2427 payload: "`{ kind: \"submit\" }`, with the editor's key on the event",
2428 doc: "Enter in a single-line editor.",
2429 },
2430 EventDef {
2431 kind: "cancel",
2432 payload: "`{ kind: \"cancel\" }`, with the editor's key on the event",
2433 doc: "Escape let go of a focused editor: the keyboard leaves it, as it does for a click elsewhere, and this says it was Escape — a draft abandoned, where `submit` is one confirmed and a plain blur is neither. A field that commits on blur cancels here instead.",
2434 },
2435 EventDef {
2436 kind: "boundary",
2437 payload: "`{ kind: \"boundary\", key: \"up\" | \"down\" | \"left\" | \"right\" | \"backspace\" | \"delete\", edge: \"start\" | \"end\", word, doc }`, with the editor's key on the event",
2438 doc: "An editing key that met the edge of an editor's text and did nothing: ↑ on the first line, ← or Backspace at the start (`edge: \"start\"`), ↓ on the last line, → or Delete at the end (`\"end\"`) — from a caret with no selection and without Shift. What a block editor joins blocks and moves between fields by. A field has one line, so its ↑ and ↓ always report. `word` and `doc` are the editing modifiers the key carried (Option or Ctrl, ⌘ or Ctrl — `docs/adr/0002`).",
2439 },
2440 EventDef {
2441 kind: "sound",
2442 payload: "`{ kind: \"sound\", phase: \"ended\" | \"refused\", playback, tag }`",
2443 doc: "A tagged playback (`play(id, { tag })` or `<audio tag>`) finished on its own — never when something stopped it. `phase: \"refused\"` instead when the device would not take the play at all (its 128 voices are all held, or the sound did not decode): that playback never starts and so never ends, so this is what arrives in place of the `ended` a view would otherwise wait forever for.",
2444 },
2445 EventDef {
2446 kind: "dismiss",
2447 payload: "`{ kind: \"dismiss\", reason: \"escape\" | \"outside\", tag }` on a node; `{ kind: \"dismiss\", reason, name, id }` on the root for a popup window",
2448 doc: "The user asked for a surface to go away — Escape, or a press that landed outside it. The core closes nothing: the app stops declaring the surface (or asks first). A `modal` node gets one on the node, carrying its tag, and only the modal in effect does; a `kind: \"popup\"` window gets one on the root, carrying the window's `name` and `id`, reported by the driver because a press outside a window and a key sent to a non-activating one are both facts only the OS has. The two are the same event, so a dropdown that graduates from a modal float to a popup window changes its declaration and not its handler.",
2449 },
2450 EventDef {
2451 kind: "access",
2452 payload: "`{ kind: \"access\", action, tag, text?, value?, anchor?: { line, offset }, focus?: { line, offset } }`",
2453 doc: "Assistive technology — or the keyboard — asked for what only the app can do: `increment` / `decrement` on a `slider` role that declared no `onChange` (a reader's nudge, or the arrow keys on the focused slider), and `setValue` there with the number asked for as `value` (Windows' UI Automation sets a slider rather than nudging it); `setValue` / `replaceSelectedText` (with `text`) / `setTextSelection` (with `anchor` and `focus` as line ordinals and byte offsets) on a custom editor. `tag` is the node's `onClick` payload (or its `onDrag` / `onKey` tag). Every other request resolves in the core and arrives as the events a pointer would have produced.",
2454 },
2455 EventDef {
2456 kind: "change",
2457 payload: "`{ kind: \"change\", value, phase: \"move\" | \"end\", tag }`",
2458 doc: "A `slider` that declared `onChange` (the stock `<slider>`, ADR 0034): the core turned a press into the value under the pointer, a drag into each new step, an arrow or assistive technology's increment / decrement into one `valueStep` and its set value into that value snapped, PageUp / PageDown into ten, Home / End into the ends — clamped to `valueMin`..`valueMax` and snapped to the step, the decimal the step names. `phase` is `move` while the pointer holds the slider and `end` when it lets go or a key moved it; a key that lands where the slider is proposes nothing. The value is proposed: declare it as `valueNow`. `tag` is the `onChange` payload.",
2459 },
2460];
2461
2462pub struct ResourceDef {
2464 pub what: &'static str,
2465 pub node: &'static str,
2466 pub lua: &'static str,
2467 pub c: &'static str,
2468}
2469
2470pub const RESOURCES: &[ResourceDef] = &[
2471 ResourceDef {
2472 what: "image",
2473 node: "`ctx.addImage(w, h, rgba)` → id for `<image src>`",
2474 lua: "the host registers; `image { id }`",
2475 c: "`kui_image_add` → `kui_image`",
2476 },
2477 ResourceDef {
2478 what: "fragment (WGSL)",
2479 node: "`ctx.addFragment(src)` → id for `<fragment src>`",
2480 lua: "the host registers; `fragment { id }`",
2481 c: "`kui_fragment_add` → `kui_fragment`",
2482 },
2483 ResourceDef {
2484 what: "font from bytes",
2485 node: "`ctx.addFont(buffer)` → id for `font`",
2486 lua: "the host registers; `font = id`",
2487 c: "`kui_font_add` → `KuiTextStyle.font`",
2488 },
2489 ResourceDef {
2490 what: "font file by path",
2491 node: "`ctx.loadFontFile(\"fonts/Antonio.ttf\")` → id for `font`",
2492 lua: "the host registers; `font = id`",
2493 c: "`kui_font_load_file`",
2494 },
2495 ResourceDef {
2496 what: "a folder of fonts",
2497 node: "`ctx.loadFontsDir(\"fonts\")`, then pick by name",
2498 lua: "the host loads",
2499 c: "`kui_font_load_dir`",
2500 },
2501 ResourceDef {
2502 what: "font by family name (installed or loaded)",
2503 node: "`ctx.addSystemFont(\"Antonio\")` (see `systemFontFamilies()`)",
2504 lua: "the host registers; `font = id`",
2505 c: "`kui_font_add_system` (see `kui_font_families`)",
2506 },
2507 ResourceDef {
2508 what: "sound (wav / ogg / mp3 / flac bytes)",
2509 node: "`ctx.addSound(buffer)` → id for `<audio src>`, `clickSound`, `play(id)`",
2510 lua: "the host registers; `audio { src = id }`, `click_sound = id`",
2511 c: "`kui_sound_add` → `kui_audio`, `KuiSpec.click_sound`, `kui_play`",
2512 },
2513];
2514
2515pub struct EnvField {
2535 pub name: &'static str,
2537 pub from: &'static str,
2540 pub node: &'static [&'static str],
2544 pub lua: &'static [&'static str],
2547 pub c: &'static str,
2551 pub doc: &'static str,
2552 pub get: fn(&EnvFacts) -> Value,
2560}
2561
2562#[derive(Clone, Copy, Debug)]
2565pub struct EnvFacts {
2566 pub env: crate::env::Env,
2567 pub viewport: crate::geom::Size,
2568 pub scale: f32,
2569 pub focus: Option<crate::key::Key>,
2570 pub focus_visible: bool,
2571 pub region: Option<crate::key::Key>,
2572 pub caret_visible: bool,
2573 pub now: f64,
2575}
2576
2577fn key_value(k: Option<crate::key::Key>) -> Value {
2578 k.map_or(Value::Null, |k| Value::Int(k.0 as i64))
2579}
2580
2581fn rect_value(r: crate::geom::Rect) -> Value {
2582 Value::map([
2583 ("x", Value::Float(r.x as f64)),
2584 ("y", Value::Float(r.y as f64)),
2585 ("w", Value::Float(r.w as f64)),
2586 ("h", Value::Float(r.h as f64)),
2587 ])
2588}
2589
2590pub const ENV_FIELDS: &[EnvField] = &[
2591 EnvField {
2592 name: "refresh_hz",
2593 get: |f| {
2594 f.env
2595 .refresh_hz
2596 .map_or(Value::Null, |hz| Value::Float(hz as f64))
2597 },
2598 from: "`Env::refresh_hz`",
2599 node: &["refreshHz"],
2600 lua: &["refresh_hz"],
2601 c: "`kui_env_set(refresh_hz)`",
2602 doc: "Display refresh rate in Hz. \"The host cannot tell\" is `null` in Node (a stable shape to destructure, typed `number | null`), an absent key in Lua, and a rate at or below zero in C.",
2603 },
2604 EnvField {
2605 name: "frame_budget_ms",
2606 get: |f| Value::Float(f.env.frame_budget_ms() as f64),
2607 from: "`Env::frame_budget_ms()`, derived",
2608 node: &["frameBudgetMs"],
2609 lua: &["frame_budget_ms"],
2610 c: "—",
2611 doc: "One vsync interval at `refresh_hz`, or at 120 Hz when the host cannot tell: the per-frame time budget, and what the latency HUD draws its line at. Derived, and in the reading anyway, so no view restates the fallback. A C host is the one that knows the rate and computes its own.",
2612 },
2613 EnvField {
2614 name: "focused",
2615 get: |f| Value::Bool(f.env.focused),
2616 from: "`Env::focused`",
2617 node: &["focused"],
2618 lua: &["focused"],
2619 c: "`kui_env_set(focused)`",
2620 doc: "Whether the *window* has the keyboard at all. Not the focused node — that is the `focus` row.",
2621 },
2622 EnvField {
2623 name: "system.appearance",
2624 get: |f| Value::str(f.env.system.appearance.name()),
2625 from: "`SystemEnv::appearance`",
2626 node: &["system.appearance"],
2627 lua: &["system.appearance"],
2628 c: "`kui_env_set_system(appearance)`",
2629 doc: "The OS light/dark setting: `\"light\"`, `\"dark\"`, or `\"unknown\"` when the host has no way to ask (`KUI_APPEARANCE_*` in C, where unknown is 0). Unknown is a real answer and the default — a view picks its own palette for it rather than being handed a guess. The core acts on it in one way: the theme is derived from it (ADR 0019), so the stock widgets and a `<text>` with no colour follow the setting — and nothing of the app's own repaints, because only the view knows which of its colours is the background.",
2630 },
2631 EnvField {
2632 name: "system.accent",
2633 get: |f| {
2634 f.env
2635 .system
2636 .accent
2637 .map_or(Value::Null, |c| Value::Int(c.to_hex() as i64))
2638 },
2639 from: "`SystemEnv::accent`",
2640 node: &["system.accent"],
2641 lua: &["system.accent"],
2642 c: "`kui_env_set_system(accent)`",
2643 doc: "The OS accent/highlight colour as `0xRRGGBBAA`, ready to pass straight back as a `bg` or `color`. \"The host cannot tell\" is `null` in Node, an absent key in Lua, and 0 in C — a fully transparent accent is not a colour anyone was given, the way a refresh rate of zero is not a rate. Node's `setEnv` also takes the `\"#rrggbb\"` spelling a prop takes.",
2644 },
2645 EnvField {
2646 name: "system.motion",
2647 get: |f| Value::str(f.env.system.motion.name()),
2648 from: "`SystemEnv::motion`",
2649 node: &["system.motion"],
2650 lua: &["system.motion"],
2651 c: "`kui_env_set_system(motion)`",
2652 doc: "The OS reduce-motion setting: `\"reduced\"` when the user asked for less animation, `\"full\"` when they did not, `\"unknown\"` when nobody asked the OS (`KUI_MOTION_*` in C, unknown 0). Spelled as what the user wants rather than as a `reduceMotion` boolean, because the third reading has no place in a boolean. Nothing in the core shortens an animation for it — a view that honours it does so where it declares one.",
2653 },
2654 EnvField {
2655 name: "system.locale",
2656 get: |f| {
2657 f.env
2658 .system
2659 .locale
2660 .map_or(Value::Null, |l| Value::str(l.as_str()))
2661 },
2662 from: "`SystemEnv::locale`",
2663 node: &["system.locale"],
2664 lua: &["system.locale"],
2665 c: "`kui_env_set_system(locale)`",
2666 doc: "The UI language as a BCP-47 tag (`\"en\"`, `\"en-US\"`, `\"zh-Hant-HK\"`), for whatever the view formats dates and numbers with; kui does not parse it. Carried inline (31 ASCII bytes, `Locale`) so the reading stays `Copy`, and anything that does not fit reads back as unknown: `null` in Node, an absent key in Lua, an empty `KuiStr` in C.",
2667 },
2668 EnvField {
2669 name: "system.assistive",
2670 get: |f| Value::str(f.env.system.assistive.name()),
2671 from: "`SystemEnv::assistive`",
2672 node: &["system.assistive"],
2673 lua: &["system.assistive"],
2674 c: "`kui_env_set_assistive(assistive)`",
2675 doc: "Whether assistive technology is listening: `\"listening\"` once an accessibility client has asked this window for its tree, `\"none\"` while the bridge is up and nobody has, `\"unknown\"` where there is no bridge — a headless `Ctx`, a runner built without `accesskit`, a C host that never called the setter (`KUI_ASSISTIVE_*`, unknown 0). The reading that changes what a view *says* rather than what it draws: an alert that announces when something is listening and blinks when nothing is. Reported through the `system` event when it changes, like the other four. Two limits are the platform's, not kui's. *Any* client counts — a probe, an accessibility inspector, a test driving the AX API and VoiceOver alike all ask for the tree, and nothing tells them apart — so it says something is listening, not that a person is. And it falls back to `\"none\"` only where the adapter reports deactivation, which in the pinned AccessKit is AT-SPI alone (the session's accessibility bus going away); on macOS and Windows nothing reports a client leaving, so once it has risen it stays `\"listening\"` for the window's life.",
2676 },
2677 EnvField {
2678 name: "window.id",
2679 get: |f| Value::Int(f.env.window.id.0 as i64),
2680 from: "`WindowEnv::id`",
2681 node: &["window.id"],
2682 lua: &["window.id"],
2683 c: "`kui_env_set_window(window)`, read back by `kui_ctx_window`",
2684 doc: "Which window this frame draws, assigned by the driver: 0 for the window the app starts in. Every event from it carries the same number.",
2685 },
2686 EnvField {
2687 name: "window.custom_chrome",
2688 get: |f| Value::Bool(f.env.window.custom_chrome),
2689 from: "`WindowEnv::custom_chrome`",
2690 node: &["window.customChrome"],
2691 lua: &["window.custom_chrome"],
2692 c: "`kui_env_set_window(custom_chrome)`",
2693 doc: "The host asked the app to draw its own chrome, so there is no native titlebar to sit under. `<titlebar>` and `<windowButtons>` build nothing when this is false.",
2694 },
2695 EnvField {
2696 name: "window.maximized",
2697 get: |f| Value::Bool(f.env.window.maximized),
2698 from: "`WindowEnv::maximized`",
2699 node: &["window.maximized"],
2700 lua: &["window.maximized"],
2701 c: "`kui_env_set_window(maximized)`",
2702 doc: "The window is maximized — what picks the restore glyph over the maximize one.",
2703 },
2704 EnvField {
2705 name: "window.fullscreen",
2706 get: |f| Value::Bool(f.env.window.fullscreen),
2707 from: "`WindowEnv::fullscreen`",
2708 node: &["window.fullscreen"],
2709 lua: &["window.fullscreen"],
2710 c: "`kui_env_set_window(fullscreen)`",
2711 doc: "The window is fullscreen.",
2712 },
2713 EnvField {
2714 name: "window.always_on_top",
2715 get: |f| Value::Bool(f.env.window.always_on_top),
2716 from: "`WindowEnv::always_on_top`",
2717 node: &["window.alwaysOnTop"],
2718 lua: &["window.always_on_top"],
2719 c: "`kui_env_set_always_on_top(always_on_top)`",
2720 doc: "The window is above every other app's: the level the driver set after the frame asked for it (`alwaysOnTop` / `always_on_top` / `kui_set_always_on_top`, backlog C30), on a platform that has one. On Wayland winit has no call for it, so a driver there reports false however often the app asks — which is why a pin button draws its state from this and not from the app's own flag. It is the driver's record of what it set and not a query (winit has no level getter), so a level the OS dropped afterwards — a fullscreen space, a tiling manager — is not seen here. A C host reports it through its own setter rather than an argument on `kui_env_set_window`, the way `kui_env_set_assistive` is, so an older host that never applies a level has nothing to recompile.",
2721 },
2722 EnvField {
2723 name: "window.native_controls",
2724 get: |f| f.env.window.native_controls.map_or(Value::Null, rect_value),
2725 from: "`WindowEnv::native_controls`",
2726 node: &["window.nativeControls"],
2727 lua: &["window.controls_w", "window.controls_h"],
2728 c: "`kui_env_set_window(controls_w, controls_h)`",
2729 doc: "Area (logical px, window coordinates) covered by controls the OS still draws over our content — the macOS traffic lights under custom chrome. Keep out of it. Node hands back the `Rect` the core holds (`{x, y, w, h}`, or `null` for none); Lua and C flatten it to a width and height anchored at the window origin (absent in Lua, `0` in C, for none), which is the shape C's two numbers can express and where the one real instance sits.",
2730 },
2731 EnvField {
2732 name: "window.backdrop",
2733 get: |f| Value::str(f.env.window.backdrop.name()),
2734 from: "`WindowEnv::backdrop`",
2735 node: &["window.backdrop"],
2736 lua: &["window.backdrop"],
2737 c: "`kui_env_set_backdrop(backdrop)`; read back with `kui_ctx_backdrop()`",
2738 doc: "What is behind the window's transparent pixels, as the driver got it (backlog F126): `\"opaque\"` (the default, and every headless core's), `\"transparent\"` (the desktop as it is), `\"blur\"` (a live blur of what is behind the window) or `\"tinted\"` (the desktop's colour, not live) — `KUI_BACKDROP_*` in C, opaque 0. The app asks with `Launcher::backdrop` and decides which regions show it by painting them with alpha; this is the answer, which is less where the platform has less — a blur asked of GNOME reads `\"tinted\"`, the wallpaper kui draws itself, or `\"opaque\"` where none could be read — so a view paints its translucent regions opaque when this says so. A C host reports it through its own setter, as `always_on_top` is; a C app asks with `KuiRunConfig.backdrop` and its view reads the answer with `kui_ctx_backdrop`.",
2739 },
2740 EnvField {
2741 name: "audio.device",
2742 get: |f| Value::str(f.env.audio.device.name()),
2743 from: "`AudioEnv::device`",
2744 node: &["audio.device"],
2745 lua: &["audio.device"],
2746 c: "`kui_env_set_audio(device)`",
2747 doc: "What the driver's output device is doing: `\"closed\"` (the default, and a headless driver's answer), `\"opening\"` (the ~90 ms open, on its own thread), `\"open\"`, or `\"failed\"` (it refused, and commands are dropped) — `KUI_AUDIO_DEVICE_*` in C, closed 0. A fact and not a verb: nothing lets a view close it, the driver does that itself once it has been idle a while. Worth reading because an open stream is a real-time thread whether or not anything plays, which is the whole of an idle app's CPU once a session has held a sound.",
2748 },
2749 EnvField {
2750 name: "audio.live",
2751 get: |f| Value::Int(f.env.audio.live as i64),
2752 from: "`AudioEnv::live`",
2753 node: &["audio.live"],
2754 lua: &["audio.live"],
2755 c: "`kui_env_set_audio(live)`",
2756 doc: "Playbacks started and not yet ended, plus any waiting on the device to open. Zero with the device still `\"open\"` is the idle stream the row above is about. A play that arrives while the device is `\"opening\"` counts here from the frame it was asked, until the open answers: if the device refuses, the play is refused on the next apply — `{kind:\"sound\", phase:\"refused\"}` for a tagged one — and leaves the count with it, so what a machine with no output device shows is `opening`/1 then `failed`/0 with the refusal between (backlog F63).",
2757 },
2758 EnvField {
2759 name: "viewport.w",
2760 get: |f| Value::Float(f.viewport.w as f64),
2761 from: "`Core::viewport()`, the frame's",
2762 node: &["viewport.width"],
2763 lua: &["viewport_w"],
2764 c: "`kui_frame_begin(w)`",
2765 doc: "The logical width of the current (or last) frame's viewport — the window less the devtools' dock while the panel is docked (`docs/adr/0024`), the same number a `resize` reports and Node's `KuiWindow.size()` answers — the other host fact a view wants at the same moment, so it rides in the same reading. Zero before the first frame, since the frame establishes it (backlog F43: this row once read the window instead, so an app under `KUI_DEVTOOLS` sized itself to a viewport it did not have). Node's `viewport` is the `WindowSize` shape `runWindowed` already uses.",
2766 },
2767 EnvField {
2768 name: "viewport.h",
2769 get: |f| Value::Float(f.viewport.h as f64),
2770 from: "`Core::viewport()`, the frame's",
2771 node: &["viewport.height"],
2772 lua: &["viewport_h"],
2773 c: "`kui_frame_begin(h)`",
2774 doc: "Its logical height.",
2775 },
2776 EnvField {
2777 name: "scale",
2778 get: |f| Value::Float(f.scale as f64),
2779 from: "`Core::scale()`, the frame's",
2780 node: &["viewport.scale"],
2781 lua: &[],
2782 c: "`kui_frame_begin(scale)`",
2783 doc: "Device pixels per logical px. Lua has no reading: a script sees logical px only.",
2784 },
2785 EnvField {
2786 name: "focus",
2787 get: |f| key_value(f.focus),
2788 from: "`Core::focus()`, the frame's",
2789 node: &[],
2790 lua: &["focus"],
2791 c: "`kui_focused()`",
2792 doc: "The focused *node*'s key, as events carry it (absent for none). A value the host wrote before the view ran, so it lags a same-frame verb by one frame; `env.is_focused(key)` is the live query. Node spells it as the call `focused()` on the context, and C as `kui_focused`, rather than a key on `env`.",
2793 },
2794 EnvField {
2795 name: "focus_visible",
2796 get: |f| Value::Bool(f.focus_visible),
2797 from: "`Core::focus_visible()`, the frame's",
2798 node: &[],
2799 lua: &["focus_visible"],
2800 c: "`kui_focus_visible()`",
2801 doc: "Whether focus shows — the keyboard or assistive technology put it where it is, or acted on it there; a click alone does not. Node: `focusVisible()` on the context.",
2802 },
2803 EnvField {
2804 name: "caret_visible",
2805 get: |f| Value::Bool(f.caret_visible),
2806 from: "`Core::caret_visible()`, the frame's",
2807 node: &[],
2808 lua: &["caret_visible"],
2809 c: "`kui_caret_visible()`",
2810 doc: "The caret's blink phase — `true` draws it (backlog C35). The driver's clock sets it while there is a caret to blink: a focused `edit`'s, or the `caret` a `line` under a focused `onKey` sink declares; a custom editor draws its caret node on the on phase and skips it on the off, keeping the `caret` row on its `line` either way, so it blinks in step with the stock editor and, in a window without the keyboard, not at all. Always `true` headless. Node: `caretVisible()` on the context (`setCaretVisible` is the driver's half, for a test that drives the phase).",
2811 },
2812 EnvField {
2813 name: "now",
2814 get: |f| Value::Float(f.now),
2815 from: "`Core::now()`, the frame's",
2816 node: &[],
2817 lua: &["now"],
2818 c: "`kui_now()`",
2819 doc: "The frame clock in seconds (backlog F134): the driver's monotonic clock, any origin, the one `transition` and `keyframes` read this frame — 0 before a driver sets one. Read a deadline off it (a toast's expiry, a sequence's beats) rather than off a clock of the app's own, so a test that moves the frame clock moves both. Node: `now()` on the context.",
2820 },
2821 EnvField {
2822 name: "region",
2823 get: |f| key_value(f.region),
2824 from: "`Core::region()`, the frame's",
2825 node: &[],
2826 lua: &["region"],
2827 c: "`kui_region()`",
2828 doc: "The focus region in effect — the key of the `focusRegion` node whose ring Tab walks (absent for the main ring; `docs/adr/0022-focus-regions.md`). What a chord that toggles between a dock and the app reads to know which way it is going. Node spells it as the call `region()` on the context, and C as `kui_region`.",
2829 },
2830];
2831
2832pub struct ThemeRole {
2843 pub name: &'static str,
2845 pub node: &'static str,
2847 pub doc: &'static str,
2848 pub get: fn(&crate::theme::Theme) -> crate::color::Color,
2850 pub set: fn(&mut crate::theme::Theme, crate::color::Color),
2853}
2854
2855pub const THEME_ROLES: &[ThemeRole] = &[
2856 ThemeRole {
2857 name: "bg",
2858 node: "bg",
2859 get: |t| t.bg,
2860 set: |t, c| t.bg = c,
2861 doc: "The window behind everything.",
2862 },
2863 ThemeRole {
2864 name: "surface",
2865 node: "surface",
2866 get: |t| t.surface,
2867 set: |t, c| t.surface = c,
2868 doc: "A card, panel or list sitting on `bg`.",
2869 },
2870 ThemeRole {
2871 name: "raised",
2872 node: "raised",
2873 get: |t| t.raised,
2874 set: |t, c| t.raised = c,
2875 doc: "A surface floating above content: a menu, a tooltip, a popover. Under a light theme it is no lighter than `surface` — a float on a white page separates by its border.",
2876 },
2877 ThemeRole {
2878 name: "sunken",
2879 node: "sunken",
2880 get: |t| t.sunken,
2881 set: |t, c| t.sunken = c,
2882 doc: "A well cut into a surface: a text field, a code block, a track.",
2883 },
2884 ThemeRole {
2885 name: "border",
2886 node: "border",
2887 get: |t| t.border,
2888 set: |t, c| t.border = c,
2889 doc: "The hairline between two surfaces.",
2890 },
2891 ThemeRole {
2892 name: "border_strong",
2893 node: "borderStrong",
2894 get: |t| t.border_strong,
2895 set: |t, c| t.border_strong = c,
2896 doc: "A border that has to be seen — a float's edge, a focused field.",
2897 },
2898 ThemeRole {
2899 name: "fg",
2900 node: "fg",
2901 get: |t| t.fg,
2902 set: |t, c| t.fg = c,
2903 doc: "Body text, and what a `color`-less text run resolves to.",
2904 },
2905 ThemeRole {
2906 name: "muted",
2907 node: "muted",
2908 get: |t| t.muted,
2909 set: |t, c| t.muted = c,
2910 doc: "Secondary text: captions, hints, an accelerator beside a label.",
2911 },
2912 ThemeRole {
2913 name: "faint",
2914 node: "faint",
2915 get: |t| t.faint,
2916 set: |t, c| t.faint = c,
2917 doc: "Text that is barely there: a placeholder, a gutter number.",
2918 },
2919 ThemeRole {
2920 name: "accent",
2921 node: "accent",
2922 get: |t| t.accent,
2923 set: |t, c| t.accent = c,
2924 doc: "The one saturated colour: the OS accent where the host reports one, the app's where it pinned one, kui's blue otherwise. The `accent` prop paints from this.",
2925 },
2926 ThemeRole {
2927 name: "accent_hover",
2928 node: "accentHover",
2929 get: |t| t.accent_hover,
2930 set: |t, c| t.accent_hover = c,
2931 doc: "`accent` under a pointer.",
2932 },
2933 ThemeRole {
2934 name: "accent_pressed",
2935 node: "accentPressed",
2936 get: |t| t.accent_pressed,
2937 set: |t, c| t.accent_pressed = c,
2938 doc: "`accent` under a press.",
2939 },
2940 ThemeRole {
2941 name: "on_accent",
2942 node: "onAccent",
2943 get: |t| t.on_accent,
2944 set: |t, c| t.on_accent = c,
2945 doc: "Black or white — whichever a reader can see on `accent`. What a button's label is.",
2946 },
2947 ThemeRole {
2948 name: "accent_soft",
2949 node: "accentSoft",
2950 get: |t| t.accent_soft,
2951 set: |t, c| t.accent_soft = c,
2952 doc: "The accent as a translucent wash rather than a fill: a selected menu row, a chosen tab, a highlighted list item. Keeps `fg` readable over it on both bases, which a fill does not.",
2953 },
2954 ThemeRole {
2955 name: "selection",
2956 node: "selection",
2957 get: |t| t.selection,
2958 set: |t, c| t.selection = c,
2959 doc: "What a text selection is painted under, in an editor and over a `selectable` scope alike.",
2960 },
2961 ThemeRole {
2962 name: "focus_ring",
2963 node: "focusRing",
2964 get: |t| t.focus_ring,
2965 set: |t, c| t.focus_ring = c,
2966 doc: "The default keyboard focus ring (ADR 0002).",
2967 },
2968 ThemeRole {
2969 name: "hover",
2970 node: "hover",
2971 get: |t| t.hover,
2972 set: |t, c| t.hover = c,
2973 doc: "A translucent wash over a hovered neutral control. An overlay, not a fill, so one value works on every surface.",
2974 },
2975 ThemeRole {
2976 name: "pressed",
2977 node: "pressed",
2978 get: |t| t.pressed,
2979 set: |t, c| t.pressed = c,
2980 doc: "The same over a pressed one, and the firmer of the two on both bases.",
2981 },
2982 ThemeRole {
2983 name: "success",
2984 node: "success",
2985 get: |t| t.success,
2986 set: |t, c| t.success = c,
2987 doc: "A good outcome. Readable on `surface` on both bases, which is why it is not one colour for both.",
2988 },
2989 ThemeRole {
2990 name: "warning",
2991 node: "warning",
2992 get: |t| t.warning,
2993 set: |t, c| t.warning = c,
2994 doc: "Something that wants attention.",
2995 },
2996 ThemeRole {
2997 name: "danger",
2998 node: "danger",
2999 get: |t| t.danger,
3000 set: |t, c| t.danger = c,
3001 doc: "A destructive action or a failure. The close button's hover, too.",
3002 },
3003 ThemeRole {
3004 name: "scrollbar",
3005 node: "scrollbar",
3006 get: |t| t.scrollbar,
3007 set: |t, c| t.scrollbar = c,
3008 doc: "The scrollbar thumb at rest.",
3009 },
3010 ThemeRole {
3011 name: "scrollbar_active",
3012 node: "scrollbarActive",
3013 get: |t| t.scrollbar_active,
3014 set: |t, c| t.scrollbar_active = c,
3015 doc: "The thumb while hovered or dragged.",
3016 },
3017];
3018
3019pub struct MetricRole {
3024 pub name: &'static str,
3026 pub node: &'static str,
3028 pub doc: &'static str,
3029 pub get: fn(&crate::metrics::Metrics) -> f32,
3030 pub set: fn(&mut crate::metrics::Metrics, f32),
3031 pub platform: Option<PlatformValue>,
3038}
3039
3040#[derive(Clone, Copy, Debug, PartialEq)]
3042pub struct PlatformValue {
3043 pub windows: f32,
3044 pub elsewhere: f32,
3045}
3046
3047impl PlatformValue {
3048 pub const fn here(self) -> f32 {
3050 if cfg!(target_os = "windows") {
3051 self.windows
3052 } else {
3053 self.elsewhere
3054 }
3055 }
3056}
3057
3058macro_rules! metric_role {
3059 ($field:ident, $node:literal, $doc:literal) => {
3060 MetricRole {
3061 name: stringify!($field),
3062 node: $node,
3063 get: |m| m.$field,
3064 set: |m, v| m.$field = v,
3065 doc: $doc,
3066 platform: None,
3067 }
3068 };
3069 ($field:ident, $node:literal, $doc:literal, windows $w:expr, elsewhere $e:expr) => {
3070 MetricRole {
3071 name: stringify!($field),
3072 node: $node,
3073 get: |m| m.$field,
3074 set: |m, v| m.$field = v,
3075 doc: $doc,
3076 platform: Some(PlatformValue {
3077 windows: $w,
3078 elsewhere: $e,
3079 }),
3080 }
3081 };
3082}
3083
3084pub const METRIC_ROLES: &[MetricRole] = &[
3085 metric_role!(
3086 control_text,
3087 "controlText",
3088 "A stock control's label: the button's text size."
3089 ),
3090 metric_role!(
3091 chrome_text,
3092 "chromeText",
3093 "The chrome's text: a menu row, a menu-bar title, the titlebar's title."
3094 ),
3095 metric_role!(hint_text, "hintText", "A tooltip's text."),
3096 metric_role!(
3097 radius,
3098 "radius",
3099 "The corner of every stock surface: a button, a field, a menu, a tooltip."
3100 ),
3101 metric_role!(
3102 radius_inner,
3103 "radiusInner",
3104 "The corner of a row inside one: a menu row, a menu-bar title."
3105 ),
3106 metric_role!(
3107 control_pad_x,
3108 "controlPadX",
3109 "A button's horizontal padding."
3110 ),
3111 metric_role!(control_pad_y, "controlPadY", "A button's vertical padding."),
3112 metric_role!(
3113 field_pad_x,
3114 "fieldPadX",
3115 "A text field's horizontal padding."
3116 ),
3117 metric_role!(field_pad_y, "fieldPadY", "A text field's vertical padding."),
3118 metric_role!(hint_pad_x, "hintPadX", "A tooltip's horizontal padding."),
3119 metric_role!(hint_pad_y, "hintPadY", "A tooltip's vertical padding."),
3120 metric_role!(
3121 menu_pad_x,
3122 "menuPadX",
3123 "A menu row's horizontal padding, and a menu-bar title's."
3124 ),
3125 metric_role!(
3126 menu_pad_y,
3127 "menuPadY",
3128 "A menu row's vertical padding; a menu-bar title's is two px less."
3129 ),
3130 metric_role!(menu_width, "menuWidth", "A menu panel's width."),
3131 metric_role!(menu_bar_h, "menuBarH", "The drawn menu bar's height."),
3132 metric_role!(
3133 titlebar_h,
3134 "titlebarH",
3135 "The titlebar strip's height: the platform's caption height, 32 on Windows and 34 elsewhere, or the window's own where the runner knows it (backlog W22) — 40 and 52 off macOS for a launcher's `medium` or `tall` titlebar under custom chrome, and under macOS custom chrome the OS's own titlebar as `window.native_controls` measures it (32, 40 or 52 on macOS 27). The stock number stands for that window's height, so a set of the app's keeps it unless it names a number of its own. Under macOS custom chrome the strip is drawn at the measured height whatever this row says (`widgets::titlebar_height`).",
3136 windows crate::metrics::TITLEBAR_H_WINDOWS,
3137 elsewhere crate::metrics::TITLEBAR_H_ELSEWHERE
3138 ),
3139];
3140
3141static SNAKE_NAMES: LazyLock<Vec<&'static str>> = LazyLock::new(|| {
3142 PROPS
3143 .iter()
3144 .map(|d| Box::leak(snake_case(d.name).into_boxed_str()) as &'static str)
3145 .collect()
3146});
3147
3148pub fn snake_case(name: &str) -> String {
3151 let mut out = String::with_capacity(name.len() + 2);
3152 let mut prev_upper = false;
3153 for c in name.chars() {
3154 if c.is_ascii_uppercase() {
3155 if !prev_upper {
3156 out.push('_');
3157 }
3158 out.push(c.to_ascii_lowercase());
3159 prev_upper = true;
3160 } else {
3161 out.push(c);
3162 prev_upper = false;
3163 }
3164 }
3165 out
3166}
3167
3168pub fn by_name(name: &str) -> Option<&'static PropDef> {
3169 PROPS.iter().find(|d| d.name == name)
3170}
3171
3172static BY_SNAKE: LazyLock<FxHashMap<&'static [u8], usize>> = LazyLock::new(|| {
3176 SNAKE_NAMES
3177 .iter()
3178 .enumerate()
3179 .map(|(i, n)| (n.as_bytes(), i))
3180 .collect()
3181});
3182
3183pub fn by_snake_name(name: &str) -> Option<&'static PropDef> {
3184 by_snake_bytes(name.as_bytes())
3185}
3186
3187pub fn by_snake_bytes(name: &[u8]) -> Option<&'static PropDef> {
3190 BY_SNAKE.get(name).map(|&i| &PROPS[i])
3191}
3192
3193pub fn by_id(id: u32) -> Option<&'static PropDef> {
3194 PROPS.iter().find(|d| d.id == id)
3195}
3196
3197#[derive(Clone, Copy, Debug, PartialEq, Eq)]
3202pub enum Spelling {
3203 Camel,
3204 Snake,
3205}
3206
3207pub const LUA_ALIASES: &[(&str, &str)] = &[("direction", "repeat")];
3212
3213pub fn lua_alias(name: &str) -> Option<&'static str> {
3216 LUA_ALIASES
3217 .iter()
3218 .find(|(alias, _)| *alias == name)
3219 .map(|(_, real)| *real)
3220}
3221
3222static SHARED_NAMES: LazyLock<[FxHashSet<&'static str>; 2]> = LazyLock::new(|| {
3225 let mut camel: FxHashSet<&'static str> = PROPS.iter().map(|d| d.name).collect();
3226 let mut snake: FxHashSet<&'static str> = PROPS.iter().map(|d| d.snake_name()).collect();
3227 for c in CUSTOM {
3228 camel.extend(c.jsx_names);
3229 snake.extend(c.lua_names);
3230 }
3231 snake.extend(LUA_ALIASES.iter().map(|(alias, _)| *alias));
3232 [camel, snake]
3233});
3234
3235fn shared_names(spelling: Spelling) -> &'static FxHashSet<&'static str> {
3236 &SHARED_NAMES[(spelling == Spelling::Snake) as usize]
3237}
3238
3239pub fn element_own(element: &str, spelling: Spelling) -> &'static [&'static str] {
3242 match ELEMENTS.iter().find(|e| e.name == element) {
3243 Some(e) if spelling == Spelling::Camel => e.jsx_own,
3244 Some(e) => e.lua_own,
3245 None => &[],
3246 }
3247}
3248
3249pub fn element_rows(element: &str, spelling: Spelling) -> Option<&'static [&'static str]> {
3253 let e = ELEMENTS.iter().find(|e| e.name == element)?;
3254 if spelling == Spelling::Camel {
3255 e.jsx_rows
3256 } else {
3257 e.lua_rows
3258 }
3259}
3260
3261pub fn shared_prop(name: &str, spelling: Spelling) -> bool {
3267 shared_names(spelling).contains(name)
3268}
3269
3270pub fn known_prop(element: &str, name: &str, spelling: Spelling) -> bool {
3275 if element_own(element, spelling).contains(&name) {
3276 return true;
3277 }
3278 match element_rows(element, spelling) {
3279 Some(rows) => rows.contains(&name),
3280 None => shared_names(spelling).contains(name),
3281 }
3282}
3283
3284pub fn suggest(element: &str, name: &str, spelling: Spelling) -> Option<&'static str> {
3289 let squash = |s: &str| s.replace('_', "").to_ascii_lowercase();
3290 let want = squash(name);
3291 let near = |c: &&&str| squash(c) == want;
3292 let own = element_own(element, spelling).iter();
3293 match element_rows(element, spelling) {
3295 Some(rows) => rows.iter().chain(own).find(near).copied(),
3296 None => shared_names(spelling).iter().chain(own).find(near).copied(),
3297 }
3298}
3299
3300pub enum Parsed {
3302 F32(f32),
3303 Color(Color),
3304 Flag,
3305 Enum(usize),
3306 Sizing(Sizing),
3307 Bound(Bound),
3309 Msg(Value),
3310 Str(String),
3311 Resource(u64),
3312 Keyframes(Vec<Keyframe>),
3313 Enter(Enter),
3314 Gradient(crate::gradient::Gradient),
3315 Family(FontFamily),
3317}
3318
3319#[derive(Clone, Debug, PartialEq)]
3321pub struct PropsOut {
3322 pub spec: NodeSpec,
3323 pub style: TextStyle,
3324 pub key: Option<String>,
3325 pub index: Option<u64>,
3328 pub row_count: Option<u64>,
3331 pub title: Option<String>,
3332 pub always_on_top: bool,
3335 pub secure_input: bool,
3338 pub option_as_alt: crate::OptionAsAlt,
3341 pub ime_off: bool,
3344 pub key_focus: bool,
3345 pub tooltip: Option<String>,
3348 pub windows: Vec<(String, WindowConfig)>,
3350 pub wrap: bool,
3355}
3356
3357#[derive(Clone, Copy, Debug, PartialEq)]
3361pub enum Identity<'a> {
3362 Auto,
3363 Label(&'a str),
3364 Index(u64),
3365}
3366
3367impl PropsOut {
3368 pub fn identity(&self) -> Identity<'_> {
3370 match (self.index, &self.key) {
3371 (Some(i), _) => Identity::Index(i),
3372 (None, Some(label)) => Identity::Label(label),
3373 (None, None) => Identity::Auto,
3374 }
3375 }
3376
3377 pub fn new() -> Self {
3378 PropsOut {
3379 spec: NodeSpec::column(),
3380 style: TextStyle::new(16.0),
3381 key: None,
3382 index: None,
3383 row_count: None,
3384 title: None,
3385 always_on_top: false,
3386 secure_input: false,
3387 option_as_alt: crate::OptionAsAlt::None,
3388 ime_off: false,
3389 key_focus: false,
3390 tooltip: None,
3391 windows: Vec::new(),
3392 wrap: false,
3393 }
3394 }
3395
3396 pub fn with_spec(&mut self, f: impl FnOnce(NodeSpec) -> NodeSpec) {
3398 self.spec = f(std::mem::take(&mut self.spec));
3399 }
3400
3401 pub fn apply_tooltip(&mut self, hint: impl Into<String>) {
3406 let hint = hint.into();
3407 self.with_spec(|s| s.apply_tooltip(&hint));
3408 self.tooltip = Some(hint);
3409 }
3410
3411 pub fn for_leaf(mut self) -> Self {
3420 if self.tooltip.is_some() {
3421 self.spec.access_mut().tooltip = true;
3422 }
3423 self
3424 }
3425
3426 pub fn apply_pad(&mut self, pad: PadShorthand) {
3430 if pad.declared() {
3431 let edges = pad.resolve();
3432 self.with_spec(|s| s.padding(edges));
3433 }
3434 }
3435}
3436
3437impl Default for PropsOut {
3438 fn default() -> Self {
3439 Self::new()
3440 }
3441}
3442
3443pub fn apply(def: &PropDef, value: Parsed, out: &mut PropsOut) -> Result<(), String> {
3447 let spec = std::mem::take(&mut out.spec);
3448 let style = out.style;
3449 out.wrap |= def.id == P_WRAP;
3452 match (&def.apply, value) {
3453 (Apply::SpecF32(f), Parsed::F32(v)) => out.spec = f(spec, v),
3454 (Apply::SpecColor(f), Parsed::Color(v)) => out.spec = f(spec, v),
3455 (Apply::SpecFlag(f), Parsed::Flag) => out.spec = f(spec),
3456 (Apply::SpecEnum(f), Parsed::Enum(v)) => out.spec = f(spec, v),
3457 (Apply::SpecSizing(f), Parsed::Sizing(v)) => out.spec = f(spec, v),
3458 (Apply::SpecBound(f), Parsed::Bound(v)) => out.spec = f(spec, v),
3459 (Apply::SpecMsg(f), Parsed::Msg(v)) => out.spec = f(spec, v),
3460 (Apply::SpecStr(f), Parsed::Str(v)) => out.spec = f(spec, &v),
3461 (Apply::SpecKeyframes(f), Parsed::Keyframes(v)) => out.spec = f(spec, v),
3462 (Apply::SpecEnter(f), Parsed::Enter(v)) => out.spec = f(spec, v),
3463 (Apply::SpecGradient(f), Parsed::Gradient(v)) => out.spec = f(spec, v),
3464 (Apply::SpecResource(f), Parsed::Resource(v)) => out.spec = f(spec, v),
3465 (Apply::StyleF32(f), Parsed::F32(v)) => {
3466 out.spec = spec;
3467 out.style = f(style, v);
3468 }
3469 (Apply::StyleColor(f), Parsed::Color(v)) => {
3470 out.spec = spec;
3471 out.style = f(style, v);
3472 }
3473 (Apply::StyleEnum(f), Parsed::Enum(v)) => {
3474 out.spec = spec;
3475 out.style = f(style, v);
3476 }
3477 (Apply::StyleFlag(f), Parsed::Flag) => {
3478 out.spec = spec;
3479 out.style = f(style);
3480 }
3481 (Apply::StyleResource(f), Parsed::Resource(v)) => {
3482 out.spec = spec;
3483 out.style = f(style, v);
3484 }
3485 (Apply::StyleStr(f), Parsed::Str(v)) => {
3486 out.spec = spec;
3487 out.style = f(style, &v);
3488 }
3489 (Apply::StyleFamily(f), Parsed::Family(v)) => {
3490 out.spec = spec;
3491 out.style = f(style, v);
3492 }
3493 _ => {
3494 out.spec = spec;
3495 return Err(format!("prop {} value/kind mismatch", def.name));
3496 }
3497 }
3498 Ok(())
3499}
3500
3501pub fn enum_index(names: &[&str], s: &str) -> Result<usize, String> {
3503 names
3504 .iter()
3505 .position(|n| *n == s)
3506 .ok_or_else(|| format!("bad value {s:?} (one of {names:?})"))
3507}
3508
3509pub fn color_num(hex: u32) -> Color {
3514 if hex == 0 {
3515 Color::TRANSPARENT
3516 } else {
3517 Color::hex(hex)
3518 }
3519}
3520
3521pub fn color_hex_str(s: &str) -> Result<Color, String> {
3523 let bad = || format!("bad color {s:?}");
3524 let hex = s.strip_prefix('#').ok_or_else(bad)?;
3525 let expanded = match hex.len() {
3526 3 => hex
3527 .chars()
3528 .flat_map(|c| [c, c])
3529 .chain("ff".chars())
3530 .collect::<String>(),
3531 6 => format!("{hex}ff"),
3532 8 => hex.to_string(),
3533 _ => return Err(bad()),
3534 };
3535 let n = u32::from_str_radix(&expanded, 16).map_err(|_| bad())?;
3536 Ok(Color::hex(n))
3537}
3538
3539pub const SIZE_MODE_CALC: u32 = 4;
3542
3543pub const SIZE_MODE_TREE: u32 = 5;
3548
3549pub fn min_str(s: &str) -> Result<Bound, String> {
3552 match s {
3553 "fit" => Ok(Bound::Fit),
3554 _ => crate::calc::bound(s)
3555 .map_err(|e| format!("bad min {s:?} (number | \"fit\" | a size expression): {e}")),
3556 }
3557}
3558
3559pub fn max_str(s: &str) -> Result<Bound, String> {
3561 crate::calc::bound(s).map_err(|e| format!("bad max {s:?} (number | a size expression): {e}"))
3562}
3563
3564pub fn sizing_str(s: &str) -> Result<Sizing, String> {
3567 match s {
3568 "fit" => Ok(Sizing::Fit),
3569 "grow" => Ok(Sizing::Grow(1.0)),
3570 _ => crate::calc::sizing(s).map_err(|e| {
3571 format!("bad sizing {s:?} (fit | grow | number | \"N%\" | a size expression): {e}")
3572 }),
3573 }
3574}
3575
3576#[cfg(test)]
3577mod tests {
3578 use super::*;
3579
3580 #[test]
3587 fn every_enum_list_is_its_enum_s_all_by_name() {
3588 fn names(it: &[&'static str]) -> Vec<&'static str> {
3589 it.to_vec()
3590 }
3591 assert_eq!(
3592 Easing::ALL.iter().map(|e| e.name()).collect::<Vec<_>>(),
3593 names(EASINGS)
3594 );
3595 assert_eq!(
3596 Repeat::ALL.iter().map(|r| r.name()).collect::<Vec<_>>(),
3597 names(REPEATS)
3598 );
3599 assert_eq!(
3600 crate::access::Live::ALL
3601 .iter()
3602 .map(|l| l.name())
3603 .collect::<Vec<_>>(),
3604 names(LIVE)
3605 );
3606 assert_eq!(
3607 FontFamily::ALL
3608 .iter()
3609 .map(|f| f.name().expect("a stock family has a name"))
3610 .collect::<Vec<_>>(),
3611 names(FAMILIES)
3612 );
3613 for (i, e) in Easing::ALL.iter().enumerate() {
3615 assert_eq!(easing_idx(i), *e);
3616 }
3617 for (i, r) in Repeat::ALL.iter().enumerate() {
3618 assert_eq!(repeat_idx(i), *r);
3619 }
3620 for (i, l) in crate::access::Live::ALL.iter().enumerate() {
3621 assert_eq!(crate::access::Live::from_index(i), *l);
3622 }
3623 for (i, f) in FontFamily::ALL.iter().enumerate() {
3624 assert_eq!(FontFamily::from_index(i), *f);
3625 }
3626 assert_eq!(easing_idx(99), Easing::default());
3628 assert_eq!(repeat_idx(99), Repeat::default());
3629 assert_eq!(FontFamily::from_index(99), FontFamily::Sans);
3630 }
3631
3632 #[test]
3633 fn ids_and_names_are_unique() {
3634 let all: Vec<(&str, u32)> = PROPS
3635 .iter()
3636 .map(|d| (d.name, d.id))
3637 .chain(CUSTOM.iter().map(|c| (c.name, c.id)))
3638 .collect();
3639 for (i, (name, id)) in all.iter().enumerate() {
3640 for (other_name, other_id) in &all[i + 1..] {
3641 assert_ne!(name, other_name, "duplicate prop name");
3642 assert_ne!(id, other_id, "duplicate wire id for {name} / {other_name}");
3643 }
3644 }
3645 }
3646
3647 fn snake_to_camel(name: &str) -> String {
3649 let mut out = String::new();
3650 let mut up = false;
3651 for ch in name.chars() {
3652 if ch == '_' {
3653 up = true;
3654 } else if up {
3655 out.extend(ch.to_uppercase());
3656 up = false;
3657 } else {
3658 out.push(ch);
3659 }
3660 }
3661 out
3662 }
3663
3664 #[test]
3668 fn metric_roles_restate_the_metrics_exactly() {
3669 use crate::metrics::Metrics;
3670 let m = Metrics::compact();
3671 let Metrics {
3672 control_text,
3673 chrome_text,
3674 hint_text,
3675 radius,
3676 radius_inner,
3677 control_pad_x,
3678 control_pad_y,
3679 field_pad_x,
3680 field_pad_y,
3681 hint_pad_x,
3682 hint_pad_y,
3683 menu_pad_x,
3684 menu_pad_y,
3685 menu_width,
3686 menu_bar_h,
3687 titlebar_h,
3688 } = m;
3689 let fields: &[(&str, f32)] = &[
3690 ("control_text", control_text),
3691 ("chrome_text", chrome_text),
3692 ("hint_text", hint_text),
3693 ("radius", radius),
3694 ("radius_inner", radius_inner),
3695 ("control_pad_x", control_pad_x),
3696 ("control_pad_y", control_pad_y),
3697 ("field_pad_x", field_pad_x),
3698 ("field_pad_y", field_pad_y),
3699 ("hint_pad_x", hint_pad_x),
3700 ("hint_pad_y", hint_pad_y),
3701 ("menu_pad_x", menu_pad_x),
3702 ("menu_pad_y", menu_pad_y),
3703 ("menu_width", menu_width),
3704 ("menu_bar_h", menu_bar_h),
3705 ("titlebar_h", titlebar_h),
3706 ];
3707 assert_eq!(METRIC_ROLES.len(), fields.len(), "a metric has no row");
3708 for (name, value) in fields {
3709 let row = METRIC_ROLES
3710 .iter()
3711 .find(|r| r.name == *name)
3712 .unwrap_or_else(|| panic!("no METRIC_ROLES row for {name}"));
3713 assert_eq!((row.get)(&m), *value, "{name}'s row reads another field");
3714 let mut w = m;
3715 (row.set)(&mut w, 1.0);
3716 assert_eq!((row.get)(&w), 1.0, "{name}'s row writes another field");
3717 }
3718 for row in METRIC_ROLES {
3719 assert!(
3720 fields.iter().any(|(n, _)| *n == row.name),
3721 "METRIC_ROLES names a field Metrics does not have: {}",
3722 row.name
3723 );
3724 let camel = snake_to_camel(row.name);
3725 assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3726 if let Some(p) = row.platform {
3730 assert_eq!(
3731 (row.get)(&Metrics::default()),
3732 p.here(),
3733 "{}'s stock value",
3734 row.name
3735 );
3736 assert_eq!(
3737 (row.get)(&m),
3738 p.here(),
3739 "{}: compact leaves a platform row alone",
3740 row.name
3741 );
3742 }
3743 }
3744 assert!(
3745 METRIC_ROLES.iter().any(|r| r.platform.is_some()),
3746 "titlebar_h is the platform's; its row says so"
3747 );
3748 }
3749
3750 #[test]
3758 fn theme_roles_restate_the_theme_exactly() {
3759 use crate::theme::Theme;
3760 let t = Theme::dark();
3761 let Theme {
3762 appearance: _,
3763 disabled_opacity: _,
3764 bg,
3765 surface,
3766 raised,
3767 sunken,
3768 border,
3769 border_strong,
3770 fg,
3771 muted,
3772 faint,
3773 accent,
3774 accent_hover,
3775 accent_pressed,
3776 on_accent,
3777 accent_soft,
3778 selection,
3779 focus_ring,
3780 hover,
3781 pressed,
3782 success,
3783 warning,
3784 danger,
3785 scrollbar,
3786 scrollbar_active,
3787 } = t;
3788 let fields: &[(&str, crate::color::Color)] = &[
3789 ("bg", bg),
3790 ("surface", surface),
3791 ("raised", raised),
3792 ("sunken", sunken),
3793 ("border", border),
3794 ("border_strong", border_strong),
3795 ("fg", fg),
3796 ("muted", muted),
3797 ("faint", faint),
3798 ("accent", accent),
3799 ("accent_hover", accent_hover),
3800 ("accent_pressed", accent_pressed),
3801 ("on_accent", on_accent),
3802 ("accent_soft", accent_soft),
3803 ("selection", selection),
3804 ("focus_ring", focus_ring),
3805 ("hover", hover),
3806 ("pressed", pressed),
3807 ("success", success),
3808 ("warning", warning),
3809 ("danger", danger),
3810 ("scrollbar", scrollbar),
3811 ("scrollbar_active", scrollbar_active),
3812 ];
3813 assert_eq!(THEME_ROLES.len(), fields.len(), "a role has no row");
3814 for (name, value) in fields {
3815 let row = THEME_ROLES
3816 .iter()
3817 .find(|r| r.name == *name)
3818 .unwrap_or_else(|| panic!("no THEME_ROLES row for {name}"));
3819 assert_eq!((row.get)(&t), *value, "{name}'s row reads another field");
3820 }
3821 for row in THEME_ROLES {
3822 assert!(
3823 fields.iter().any(|(n, _)| *n == row.name),
3824 "{} names no field",
3825 row.name
3826 );
3827 let camel = {
3829 let mut out = String::new();
3830 let mut up = false;
3831 for ch in row.name.chars() {
3832 if ch == '_' {
3833 up = true;
3834 } else if up {
3835 out.extend(ch.to_uppercase());
3836 up = false;
3837 } else {
3838 out.push(ch);
3839 }
3840 }
3841 out
3842 };
3843 assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3844 }
3845 }
3846
3847 #[test]
3854 fn env_fields_restate_env_and_window_env_exactly() {
3855 use crate::env::{AudioEnv, Env, SystemEnv};
3856 use crate::window::WindowEnv;
3857 let Env {
3858 refresh_hz: _,
3859 focused: _,
3860 system,
3861 window,
3862 audio,
3863 } = Env::default();
3864 let AudioEnv { device: _, live: _ } = audio;
3865 let SystemEnv {
3866 appearance: _,
3867 accent: _,
3868 motion: _,
3869 locale: _,
3870 assistive: _,
3871 } = system;
3872 let WindowEnv {
3873 id: _,
3874 custom_chrome: _,
3875 maximized: _,
3876 fullscreen: _,
3877 always_on_top: _,
3878 native_controls: _,
3879 backdrop: _,
3880 } = window;
3881 let stored = [
3882 "refresh_hz",
3883 "focused",
3884 "system.appearance",
3885 "system.accent",
3886 "system.motion",
3887 "system.locale",
3888 "system.assistive",
3889 "window.id",
3890 "window.custom_chrome",
3891 "window.maximized",
3892 "window.fullscreen",
3893 "window.always_on_top",
3894 "window.native_controls",
3895 "window.backdrop",
3896 "audio.device",
3897 "audio.live",
3898 ];
3899 let from_structs: Vec<&str> = ENV_FIELDS
3902 .iter()
3903 .filter(|f| !f.from.contains('('))
3904 .map(|f| {
3905 let (strukt, field) = match f.name.split_once('.') {
3906 Some(("window", field)) => ("WindowEnv", field),
3907 Some(("system", field)) => ("SystemEnv", field),
3908 Some(("audio", field)) => ("AudioEnv", field),
3909 Some((group, _)) => panic!("{}: no struct holds a {group} fact", f.name),
3910 None => ("Env", f.name),
3911 };
3912 assert_eq!(f.from, format!("`{strukt}::{field}`"), "{}", f.name);
3913 f.name
3914 })
3915 .collect();
3916 assert_eq!(from_structs, stored);
3917 for f in ENV_FIELDS.iter().filter(|f| f.from.contains('(')) {
3918 assert!(
3919 f.from.contains("derived") || f.from.contains("the frame's"),
3920 "{}: a call in `from` is derived or the frame's, and says which",
3921 f.name
3922 );
3923 }
3924 }
3925
3926 #[test]
3930 fn env_field_spellings_are_unique_and_complete() {
3931 let mut names: Vec<&str> = ENV_FIELDS.iter().map(|f| f.name).collect();
3932 let mut node: Vec<&str> = ENV_FIELDS
3933 .iter()
3934 .flat_map(|f| f.node.iter().copied())
3935 .collect();
3936 let mut lua: Vec<&str> = ENV_FIELDS
3937 .iter()
3938 .flat_map(|f| f.lua.iter().copied())
3939 .collect();
3940 for list in [&mut names, &mut node, &mut lua] {
3941 let before = list.len();
3942 list.sort_unstable();
3943 list.dedup();
3944 assert_eq!(list.len(), before, "a spelling is used twice");
3945 }
3946 for f in ENV_FIELDS {
3947 assert!(!f.c.is_empty() && !f.doc.is_empty(), "{}", f.name);
3948 if f.node.is_empty() {
3951 assert!(
3952 f.doc.contains("Node"),
3953 "{}: where does Node carry it?",
3954 f.name
3955 );
3956 }
3957 if f.lua.is_empty() {
3958 assert!(
3959 f.doc.contains("Lua"),
3960 "{}: where does Lua carry it?",
3961 f.name
3962 );
3963 }
3964 }
3965 }
3966
3967 #[test]
3971 fn admitted_rows_are_shared_rows_in_both_spellings() {
3972 for e in ELEMENTS {
3973 let (Some(jsx), Some(lua)) = (e.jsx_rows, e.lua_rows) else {
3974 assert!(
3975 e.jsx_rows.is_none() && e.lua_rows.is_none(),
3976 "{}: one spelling only",
3977 e.name
3978 );
3979 continue;
3980 };
3981 assert_eq!(
3982 jsx.len(),
3983 lua.len(),
3984 "{}: the lists differ in length",
3985 e.name
3986 );
3987 for (j, l) in jsx.iter().zip(lua) {
3988 assert!(
3989 shared_prop(j, Spelling::Camel),
3990 "{}: `{j}` is not a row",
3991 e.name
3992 );
3993 assert!(
3994 shared_prop(l, Spelling::Snake),
3995 "{}: `{l}` is not a row",
3996 e.name
3997 );
3998 assert_eq!(
3999 snake_case(j),
4000 *l,
4001 "{}: `{j}` and `{l}` are not one row",
4002 e.name
4003 );
4004 }
4005 if jsx.contains(&"onClick") {
4010 assert!(jsx.contains(&"label"), "{}: `label` missing", e.name);
4011 }
4012 }
4013 assert!(known_prop("button", "description", Spelling::Camel));
4014 assert!(known_prop("button", "on_click", Spelling::Snake));
4015 assert!(known_prop("button", "text", Spelling::Snake));
4016 assert!(!known_prop("button", "radius", Spelling::Camel));
4017 assert!(!known_prop("button", "text", Spelling::Camel));
4018 assert!(known_prop("box", "radius", Spelling::Camel));
4019 assert_eq!(
4022 suggest("button", "on_click", Spelling::Camel),
4023 Some("onClick")
4024 );
4025 assert_eq!(suggest("button", "hover_bg", Spelling::Camel), None);
4026 assert_eq!(suggest("box", "hover_bg", Spelling::Camel), Some("hoverBg"));
4027 }
4028
4029 #[test]
4035 fn text_admits_exactly_the_style_rows() {
4036 let style: Vec<&str> = PROPS
4037 .iter()
4038 .filter(|d| d.target() == Target::Style)
4039 .map(|d| d.name)
4040 .collect();
4041 let mut expect = vec!["size"];
4042 expect.extend(style);
4043 let mut got = TEXT_ROWS_JSX.to_vec();
4044 expect.sort_unstable();
4045 got.sort_unstable();
4046 assert_eq!(got, expect, "TEXT_ROWS_JSX is not the style rows");
4047 for name in ["lineHeight", "color", "wrap", "size"] {
4048 assert!(known_prop("text", name, Spelling::Camel), "{name}");
4049 }
4050 for name in ["live", "role", "label", "onClick", "key", "pad", "bg"] {
4051 assert_eq!(
4052 known_prop("text", name, Spelling::Camel),
4053 name == "bg",
4054 "{name}: `bg` is the element's own (a span's), the rest are not rows it reads"
4055 );
4056 }
4057 assert!(known_prop("text", "line_height", Spelling::Snake));
4058 assert!(known_prop("text", "value", Spelling::Snake));
4059 assert!(!known_prop("text", "live", Spelling::Snake));
4060 assert!(!known_prop("text", "on_click", Spelling::Snake));
4061 assert_eq!(
4064 suggest("text", "max_lines", Spelling::Camel),
4065 Some("maxLines")
4066 );
4067 assert_eq!(suggest("text", "hover_bg", Spelling::Camel), None);
4068 }
4069
4070 #[test]
4071 fn snake_names_round_trip() {
4072 assert_eq!(by_snake_name("min_width").unwrap().name, "minWidth");
4073 assert_eq!(by_snake_name("on_click").unwrap().name, "onClick");
4074 assert_eq!(by_snake_name("bg").unwrap().name, "bg");
4075 assert!(by_snake_name("minWidth").is_none());
4076 assert_eq!(by_name("lineHeight").unwrap().snake_name(), "line_height");
4077 assert_eq!(by_name("radiusTL").unwrap().snake_name(), "radius_tl");
4078 assert_eq!(by_snake_name("radius_bl").unwrap().name, "radiusBL");
4079 }
4080
4081 #[test]
4085 fn the_allow_list_is_per_spelling() {
4086 use Spelling::{Camel, Snake};
4087 assert!(known_prop("box", "hoverBg", Camel));
4088 assert!(known_prop("box", "hover_bg", Snake));
4089 assert!(!known_prop("box", "hover_bg", Camel));
4090 assert!(!known_prop("box", "hoverBg", Snake));
4091 assert!(known_prop("box", "padX", Camel) && !known_prop("box", "padX", Snake));
4093 assert!(known_prop("box", "scroll", Snake) && !known_prop("box", "scroll", Camel));
4094 assert!(known_prop("box", "direction", Snake));
4096 assert_eq!(lua_alias("direction"), Some("repeat"));
4097 assert!(known_prop("edit", "initial", Camel));
4099 assert!(!known_prop("box", "initial", Camel));
4100 assert!(known_prop("edit", "wrap", Camel) && known_prop("edit", "wrap", Snake));
4103 assert!(known_prop("image", "src", Camel) && known_prop("image", "id", Snake));
4104 assert!(!known_prop("box", "colour", Camel));
4106 }
4107
4108 #[test]
4109 fn a_suggestion_is_the_same_word_in_the_right_convention() {
4110 use Spelling::{Camel, Snake};
4111 assert_eq!(suggest("box", "hoverBg", Snake), Some("hover_bg"));
4112 assert_eq!(suggest("box", "onclick", Camel), Some("onClick"));
4113 assert_eq!(suggest("box", "SCROLL_X", Camel), Some("scrollX"));
4114 assert_eq!(suggest("edit", "Initial", Camel), Some("initial"));
4115 assert_eq!(suggest("box", "colour", Camel), None);
4117 }
4118
4119 #[test]
4122 fn every_composite_and_element_prop_is_in_the_allow_list() {
4123 for c in CUSTOM {
4124 for n in c.jsx_names {
4125 assert!(known_prop("box", n, Spelling::Camel), "jsx `{n}`");
4126 }
4127 for n in c.lua_names {
4128 assert!(known_prop("box", n, Spelling::Snake), "lua `{n}`");
4129 }
4130 }
4131 for e in ELEMENTS {
4132 for n in e.jsx_own {
4133 assert!(known_prop(e.name, n, Spelling::Camel), "{}.{n}", e.name);
4134 }
4135 for n in e.lua_own {
4136 assert!(known_prop(e.name, n, Spelling::Snake), "{}.{n}", e.name);
4137 }
4138 }
4139 }
4140
4141 #[test]
4142 fn every_row_applies_a_sample_of_its_kind() {
4143 for def in PROPS {
4144 let f = if def.name == "opacity" { 0.5 } else { 7.0 };
4147 let sample = match def.kind {
4148 Kind::F32 => Parsed::F32(f),
4149 Kind::Color => Parsed::Color(Color::hex(0x11223344)),
4150 Kind::Flag => Parsed::Flag,
4151 Kind::Enum(_) => Parsed::Enum(1),
4152 Kind::Sizing => Parsed::Sizing(Sizing::Percent(0.5)),
4153 Kind::Min => Parsed::Bound(Bound::Fit),
4154 Kind::Max => Parsed::Bound(Bound::Px(10.0)),
4155 Kind::Msg | Kind::Tag => Parsed::Msg(Value::Int(1)),
4156 Kind::Str if def.name == "scrollMods" => Parsed::Str("ctrl".into()),
4159 Kind::Str => Parsed::Str("name".into()),
4160 Kind::Family => Parsed::Family(FontFamily::Mono),
4161 Kind::Resource => Parsed::Resource(7),
4162 Kind::Keyframes => Parsed::Keyframes(vec![Keyframe::default().radius(7.0)]),
4163 Kind::Enter => Parsed::Enter(Enter::from(-7.0, 0.0)),
4164 Kind::Gradient => Parsed::Gradient(crate::gradient::Gradient::to(
4165 crate::gradient::Side::Right,
4166 [Color::hex(0x11223344), Color::WHITE],
4167 )),
4168 };
4169 let mut out = PropsOut::new();
4170 apply(def, sample, &mut out).unwrap();
4171 let changed = match def.target() {
4172 Target::Spec => out.spec != NodeSpec::column(),
4173 Target::Style => out.style != TextStyle::new(16.0),
4174 };
4175 assert!(changed, "{} applied a sample but nothing changed", def.name);
4176 }
4177 }
4178
4179 #[test]
4182 fn a_null_tag_still_declares_the_behaviour() {
4183 let mut out = PropsOut::new();
4184 apply(
4185 by_name("onKey").unwrap(),
4186 Parsed::Msg(Value::Null),
4187 &mut out,
4188 )
4189 .unwrap();
4190 assert_eq!(out.spec.events().on_key, Some(Value::Null));
4191 assert!(out.spec.hover_tracked());
4192 let mut out = PropsOut::new();
4193 apply(
4194 by_name("onLayout").unwrap(),
4195 Parsed::Msg(Value::Null),
4196 &mut out,
4197 )
4198 .unwrap();
4199 assert_eq!(out.spec.events().on_layout, Some(Value::Null));
4200 }
4201
4202 #[test]
4212 fn every_declarable_role_name_is_a_real_role() {
4213 for (i, name) in ROLES.iter().enumerate() {
4214 let role = Role::parse(name)
4215 .unwrap_or_else(|| panic!("ROLES[{i}] = {name:?} is not a Role::ALL name"));
4216 assert_eq!(role_idx(i), role, "role index {i} lowers to the wrong role");
4217 assert_eq!(role_idx(i).name(), *name);
4218 }
4219 }
4220
4221 #[test]
4230 fn every_role_is_declarable_or_derived() {
4231 for role in Role::ALL {
4232 let declarable = ROLES.contains(&role.name());
4233 let derived = DERIVED_ONLY.iter().any(|(n, _)| *n == role.name());
4234 assert!(
4235 declarable || derived,
4236 "Role::{role:?} is in Role::ALL but no view can declare it and \
4237 DERIVED_ONLY does not say the core derives it — add {:?} to \
4238 ROLES, or to DERIVED_ONLY with the reason",
4239 role.name()
4240 );
4241 assert!(
4242 !(declarable && derived),
4243 "Role::{role:?} is in ROLES, so it is declarable — drop it from \
4244 DERIVED_ONLY"
4245 );
4246 }
4247 for (name, why) in DERIVED_ONLY {
4248 assert!(!why.is_empty(), "{name:?} is exempted without a reason");
4249 assert!(
4250 Role::parse(name).is_some(),
4251 "DERIVED_ONLY names {name:?}, which is not a Role::ALL name"
4252 );
4253 }
4254 let derived = roles_one_frame_derives();
4255 for (name, _) in DERIVED_ONLY {
4256 assert!(
4257 derived.contains(&Role::parse(name).unwrap()),
4258 "DERIVED_ONLY keeps {name:?} out of ROLES because the core \
4259 derives it, but no frame does any more — either it belongs in \
4260 ROLES now, or the exemption is stale"
4261 );
4262 }
4263 }
4264
4265 fn roles_one_frame_derives() -> Vec<Role> {
4269 let mut core = crate::Core::new();
4270 let mut ui = core.frame(crate::Size::new(200.0, 200.0), 1.0);
4271 ui.window_title("Demo");
4272 ui.configure_root(NodeSpec::column().fill());
4273 ui.leaf_keyed("titlebar", NodeSpec::row().window_drag());
4274 ui.text_in_keyed(
4275 "scroll",
4276 NodeSpec::column().height(40.0).scroll_y(),
4277 "hello",
4278 TextStyle::new(12.0),
4279 );
4280 ui.finish();
4281 core.access_tree().nodes.iter().map(|n| n.role).collect()
4282 }
4283
4284 #[test]
4285 fn colors_and_sizings_parse() {
4286 assert_eq!(color_hex_str("#fff").unwrap(), Color::hex(0xffffffff));
4287 assert_eq!(color_hex_str("#11223344").unwrap(), Color::hex(0x11223344));
4288 assert!(color_hex_str("fff").is_err());
4289 assert_eq!(sizing_str("50%").unwrap(), Sizing::Percent(0.5));
4290 assert_eq!(sizing_str("grow").unwrap(), Sizing::Grow(1.0));
4291 assert!(sizing_str("wide").is_err());
4292 }
4293}