1use std::sync::LazyLock;
33
34use rustc_hash::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;
175
176pub const ALIGNS: &[&str] = &[
181 "start",
182 "center",
183 "end",
184 "spaceBetween",
185 "spaceAround",
186 "spaceEvenly",
187 "baseline",
188];
189pub const WINDOW_ROLES: &[&str] = &["drag", "close", "minimize", "maximize"];
190pub const SCROLLBARS: &[&str] = &["visible", "hidden", "auto"];
195pub const OVERSCROLLS: &[&str] = &["auto", "contain"];
200pub const SCROLL_AXES: &[&str] = &["both", "x", "y"];
204pub const FAMILIES: &[&str] = &["sans", "serif", "mono"];
207pub const CURSORS: &[&str] = &[
210 "default",
211 "text",
212 "pointer",
213 "grab",
214 "grabbing",
215 "notAllowed",
216 "ewResize",
217 "nsResize",
218 "nwseResize",
219 "neswResize",
220];
221
222pub fn cursor_idx(i: usize) -> CursorShape {
223 CURSORS
224 .get(i)
225 .and_then(|n| CursorShape::parse(n))
226 .unwrap_or(CursorShape::Default)
227}
228pub const WRAPS: &[&str] = &["word", "glyph", "none", "break-spaces"];
229pub const UNDERLINE_STYLES: &[&str] = UnderlineStyle::NAMES;
231pub const EXPANDED: &[&str] = &["collapsed", "expanded"];
236pub const LIVE: &[&str] = &["off", "polite", "assertive"];
240pub const ROLES: &[&str] = &[
246 "none",
247 "button",
248 "checkbox",
249 "radio",
250 "switch",
251 "slider",
252 "tab",
253 "tabList",
254 "link",
255 "heading",
256 "list",
257 "listItem",
258 "image",
259 "dialog",
260 "group",
261 "textInput",
262 "multilineTextInput",
263 "line",
264 "radioGroup",
268 "menu",
269 "menuItem",
270 "terminal",
272];
273
274pub const ORIENTATIONS: &[&str] = &["horizontal", "vertical"];
280
281pub const APPEARANCES: &[&str] = &["unknown", "light", "dark"];
287
288pub const MOTIONS: &[&str] = &["unknown", "full", "reduced"];
291
292pub const ASSISTIVE: &[&str] = &["unknown", "none", "listening"];
296
297pub const AUDIO_DEVICES: &[&str] = &["closed", "opening", "open", "failed"];
301
302pub const DERIVED_ONLY: &[(&str, &str)] = &[
309 (
310 "window",
311 "the root node of a frame, named by the window title",
312 ),
313 ("titleBar", "a `windowDrag` node"),
314 ("staticText", "a text node"),
315 ("scrollView", "a `scrollX` / `scrollY` node"),
316];
317
318pub fn role_idx(i: usize) -> Role {
341 ROLES
342 .get(i)
343 .and_then(|n| Role::parse(n))
344 .unwrap_or(Role::Group)
345}
346pub const EASINGS: &[&str] = &[
349 "easeOut",
350 "linear",
351 "easeIn",
352 "easeInOut",
353 "spring",
354 "bouncy",
355 "smooth",
356 "snappy",
357];
358
359pub const REPEATS: &[&str] = &["normal", "reverse", "alternate", "alternateReverse"];
361
362pub fn repeat_idx(i: usize) -> Repeat {
363 Repeat::from_index(i)
364}
365
366pub fn easing_idx(i: usize) -> Easing {
367 Easing::from_index(i)
368}
369
370pub enum Kind {
372 F32,
374 Color,
377 Flag,
379 Enum(&'static [&'static str]),
381 Sizing,
387 Min,
392 Max,
396 Msg,
398 Tag,
405 Str,
407 Family,
411 Resource,
415 Keyframes,
419 Enter,
422 Gradient,
426}
427
428pub enum Apply {
430 SpecF32(fn(NodeSpec, f32) -> NodeSpec),
431 SpecColor(fn(NodeSpec, Color) -> NodeSpec),
432 SpecFlag(fn(NodeSpec) -> NodeSpec),
433 SpecEnum(fn(NodeSpec, usize) -> NodeSpec),
434 SpecSizing(fn(NodeSpec, Sizing) -> NodeSpec),
435 SpecBound(fn(NodeSpec, Bound) -> NodeSpec),
436 SpecMsg(fn(NodeSpec, Value) -> NodeSpec),
437 SpecStr(fn(NodeSpec, &str) -> NodeSpec),
438 SpecKeyframes(fn(NodeSpec, Vec<Keyframe>) -> NodeSpec),
439 SpecEnter(fn(NodeSpec, Enter) -> NodeSpec),
440 SpecGradient(fn(NodeSpec, crate::gradient::Gradient) -> NodeSpec),
441 SpecResource(fn(NodeSpec, u64) -> NodeSpec),
442 StyleF32(fn(TextStyle, f32) -> TextStyle),
443 StyleColor(fn(TextStyle, Color) -> TextStyle),
444 StyleEnum(fn(TextStyle, usize) -> TextStyle),
445 StyleFlag(fn(TextStyle) -> TextStyle),
446 StyleResource(fn(TextStyle, u64) -> TextStyle),
447 StyleStr(fn(TextStyle, &str) -> TextStyle),
448 StyleFamily(fn(TextStyle, FontFamily) -> TextStyle),
449}
450
451#[derive(Clone, Copy, Debug, PartialEq, Eq)]
452pub enum Target {
453 Spec,
455 Style,
457}
458
459pub struct PropDef {
460 pub name: &'static str,
462 pub id: u32,
463 pub kind: Kind,
464 pub apply: Apply,
465 pub doc: &'static str,
466}
467
468impl PropDef {
469 pub fn target(&self) -> Target {
470 match self.apply {
471 Apply::StyleF32(_)
472 | Apply::StyleColor(_)
473 | Apply::StyleEnum(_)
474 | Apply::StyleFlag(_)
475 | Apply::StyleResource(_)
476 | Apply::StyleStr(_)
477 | Apply::StyleFamily(_) => Target::Style,
478 _ => Target::Spec,
479 }
480 }
481
482 pub fn snake_name(&self) -> &'static str {
484 SNAKE_NAMES[self.index()]
485 }
486
487 fn index(&self) -> usize {
488 PROPS
491 .iter()
492 .position(|d| d.name == self.name)
493 .expect("PropDef not from PROPS")
494 }
495}
496
497pub fn align_idx(i: usize) -> Align {
498 match i {
499 1 => Align::Center,
500 2 => Align::End,
501 3 => Align::SpaceBetween,
502 4 => Align::SpaceAround,
503 5 => Align::SpaceEvenly,
504 6 => Align::Baseline,
505 _ => Align::Start,
506 }
507}
508
509pub fn min_num(mode: u32, value: f64) -> Bound {
513 match mode {
514 1 => Bound::Fit,
515 _ => Bound::Px(value as f32),
516 }
517}
518
519pub fn sizing_num(mode: u32, value: f64) -> Sizing {
521 match mode {
522 1 => Sizing::Fit,
523 2 => Sizing::Grow(value as f32),
524 3 => Sizing::Percent(value as f32),
525 _ => Sizing::Fixed(value as f32),
526 }
527}
528
529pub const PROPS: &[PropDef] = &[
530 PropDef {
531 name: "width",
532 id: P_WIDTH,
533 kind: Kind::Sizing,
534 apply: Apply::SpecSizing(|s, v| s.width(v)),
535 doc: "Horizontal size: px | \"fit\" | \"grow\" | \"N%\" | a size expression — \
536 `\"clamp(400px, 80%, 1000px)\"`, `\"min(720px, 100%)\"`, `\"max(50%, 300)\"`, \
537 nested — which layout resolves against the parent's content box, the box a \
538 percentage takes its cut of (backlog F109). An expression with no percentage \
539 in it is a length; a calc does not ease under `transition`. A percentage \
540 or an expression gives, with the fit children, when its parent overflows \
541 — two `\"50%\"` children and a gap fit their row (backlog F110) — where a \
542 px size keeps its own. A row holding one gives as CSS's flex items do: \
543 every child that can give gives in proportion to its size, and stops at \
544 its content — the widest thing in it that cannot wrap, a label's longest \
545 word — unless `minWidth` says otherwise (backlog RG92). The process keeps \
546 65 536 distinct expressions and never lets one go: past that a new one leaves \
547 its prop at its default, with a `size-expressions-full` warning, so declare \
548 one per layout — a px size for the part that moves each frame, a splitter's \
549 drag — not one per frame (backlog RG93).",
550 },
551 PropDef {
552 name: "height",
553 id: P_HEIGHT,
554 kind: Kind::Sizing,
555 apply: Apply::SpecSizing(|s, v| s.height(v)),
556 doc: "Vertical size: px | \"fit\" | \"grow\" | \"N%\" | a size expression (see `width`).",
557 },
558 PropDef {
559 name: "minWidth",
560 id: P_MIN_W,
561 kind: Kind::Min,
562 apply: Apply::SpecBound(|s, v| s.min_width(v)),
563 doc: "Lower width clamp: logical px, a size expression (see `width`; a percentage \
564 clamp is none until the parent's width is known, as in CSS), or \"fit\" for \
565 the node's own fit width. \
566 \"fit\" under `width=\"grow\"` is a content floor — CSS's `flex: 1 0 auto` — \
567 which is what an i3-style tab bar is: tabs that split the bar evenly \
568 while they fit and sit at their label's width, scrolling, once they do \
569 not. Opt-in, because a fit width is the unwrapped one: a paragraph in a \
570 grow column would stop wrapping under it. Left out, a child giving in an \
571 overflowing row that holds a percentage or a size expression stops at its \
572 content, CSS's `min-width: auto`; `0` lets it go below, CSS's \
573 `min-width: 0` (backlog RG92). A fit node across a column is no wider \
574 than the column's box — CSS's `fit-content` — down to this floor, 0 left \
575 out, unless the column scrolls x, so a text one wrapper deep in a capped \
576 card wraps there; \"fit\" keeps its content's width and runs past \
577 (backlog F116).",
578 },
579 PropDef {
580 name: "maxWidth",
581 id: P_MAX_W,
582 kind: Kind::Max,
583 apply: Apply::SpecBound(|s, v| s.max_width(v)),
584 doc: "Upper width clamp: logical px or a size expression (see `width`); \
585 grow+maxWidth is the responsive-width pattern.",
586 },
587 PropDef {
588 name: "minHeight",
589 id: P_MIN_H,
590 kind: Kind::Min,
591 apply: Apply::SpecBound(|s, v| s.min_height(v)),
592 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`).",
593 },
594 PropDef {
595 name: "maxHeight",
596 id: P_MAX_H,
597 kind: Kind::Max,
598 apply: Apply::SpecBound(|s, v| s.max_height(v)),
599 doc: "Upper height clamp: logical px or a size expression (see `width`).",
600 },
601 PropDef {
602 name: "gap",
603 id: P_GAP,
604 kind: Kind::F32,
605 apply: Apply::SpecF32(|s, v| s.gap(v)),
606 doc: "Space between children along the main axis.",
607 },
608 PropDef {
612 name: "wrapChildren",
613 id: P_WRAP_CHILDREN,
614 kind: Kind::Flag,
615 apply: Apply::SpecFlag(NodeSpec::wrap),
616 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.",
617 },
618 PropDef {
619 name: "crossGap",
620 id: P_CROSS_GAP,
621 kind: Kind::F32,
622 apply: Apply::SpecF32(|s, v| s.cross_gap(v)),
623 doc: "Space between wrap lines, across the main axis (`gap` stays the space along it).",
624 },
625 PropDef {
626 name: "mainAlign",
627 id: P_MAIN_ALIGN,
628 kind: Kind::Enum(ALIGNS),
629 apply: Apply::SpecEnum(|s, i| s.main_align(align_idx(i))),
630 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.",
631 },
632 PropDef {
633 name: "crossAlign",
634 id: P_CROSS_ALIGN,
635 kind: Kind::Enum(ALIGNS),
636 apply: Apply::SpecEnum(|s, i| s.cross_align(align_idx(i))),
637 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.",
638 },
639 PropDef {
640 name: "aspectRatio",
641 id: P_ASPECT_RATIO,
642 kind: Kind::F32,
643 apply: Apply::SpecF32(|s, v| s.aspect_ratio(v)),
644 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.",
645 },
646 PropDef {
647 name: "bg",
648 id: P_BG,
649 kind: Kind::Color,
650 apply: Apply::SpecColor(|s, c| s.bg(c)),
651 doc: "Background fill.",
652 },
653 PropDef {
654 name: "radius",
655 id: P_RADIUS,
656 kind: Kind::F32,
657 apply: Apply::SpecF32(|s, v| s.radius(v)),
658 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.",
659 },
660 PropDef {
661 name: "opacity",
662 id: P_OPACITY,
663 kind: Kind::F32,
664 apply: Apply::SpecF32(|s, v| s.opacity(v)),
665 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.",
666 },
667 PropDef {
668 name: "pixelSnap",
669 id: P_PIXEL_SNAP,
670 kind: Kind::Flag,
671 apply: Apply::SpecFlag(|s| s.pixel_snap()),
672 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.",
673 },
674 PropDef {
675 name: "shadowColor",
676 id: P_SHADOW_COLOR,
677 kind: Kind::Color,
678 apply: Apply::SpecColor(|s, c| s.shadow_color(c)),
679 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.",
680 },
681 PropDef {
682 name: "shadowBlur",
683 id: P_SHADOW_BLUR,
684 kind: Kind::F32,
685 apply: Apply::SpecF32(|s, v| s.shadow_blur(v)),
686 doc: "Drop-shadow blur radius (logical px): the edge ramps over this distance and reaches this far past the shape. 0 = a hard edge.",
687 },
688 PropDef {
689 name: "shadowX",
690 id: P_SHADOW_X,
691 kind: Kind::F32,
692 apply: Apply::SpecF32(|s, v| s.shadow_x(v)),
693 doc: "Drop-shadow horizontal offset (logical px).",
694 },
695 PropDef {
696 name: "shadowY",
697 id: P_SHADOW_Y,
698 kind: Kind::F32,
699 apply: Apply::SpecF32(|s, v| s.shadow_y(v)),
700 doc: "Drop-shadow vertical offset (logical px); positive casts downward.",
701 },
702 PropDef {
703 name: "shadowSpread",
704 id: P_SHADOW_SPREAD,
705 kind: Kind::F32,
706 apply: Apply::SpecF32(|s, v| s.shadow_spread(v)),
707 doc: "Grows (or, negative, shrinks) the drop shadow's shape before blurring (logical px).",
708 },
709 PropDef {
710 name: "radiusTL",
711 id: P_RADIUS_TL,
712 kind: Kind::F32,
713 apply: Apply::SpecF32(|s, v| s.radius_tl(v)),
714 doc: "Top-left corner radius (logical px).",
715 },
716 PropDef {
717 name: "radiusTR",
718 id: P_RADIUS_TR,
719 kind: Kind::F32,
720 apply: Apply::SpecF32(|s, v| s.radius_tr(v)),
721 doc: "Top-right corner radius (logical px).",
722 },
723 PropDef {
724 name: "radiusBR",
725 id: P_RADIUS_BR,
726 kind: Kind::F32,
727 apply: Apply::SpecF32(|s, v| s.radius_br(v)),
728 doc: "Bottom-right corner radius (logical px).",
729 },
730 PropDef {
731 name: "radiusBL",
732 id: P_RADIUS_BL,
733 kind: Kind::F32,
734 apply: Apply::SpecF32(|s, v| s.radius_bl(v)),
735 doc: "Bottom-left corner radius (logical px).",
736 },
737 PropDef {
738 name: "center",
739 id: P_CENTER,
740 kind: Kind::Flag,
741 apply: Apply::SpecFlag(|s| s.center()),
742 doc: "Center children on both axes.",
743 },
744 PropDef {
745 name: "hoverable",
746 id: P_HOVERABLE,
747 kind: Kind::Flag,
748 apply: Apply::SpecFlag(|s| s.hoverable()),
749 doc: "Hover-track without a click payload (for isHovered-driven styling).",
750 },
751 PropDef {
752 name: "animate",
753 id: P_ANIMATE,
754 kind: Kind::Flag,
755 apply: Apply::SpecFlag(|s| s.animate()),
756 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.",
757 },
758 PropDef {
759 name: "accent",
760 id: P_ACCENT,
761 kind: Kind::Flag,
762 apply: Apply::SpecFlag(|s| s.accent()),
763 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.",
764 },
765 PropDef {
766 name: "selectable",
767 id: P_SELECTABLE,
768 kind: Kind::Flag,
769 apply: Apply::SpecFlag(|s| s.selectable()),
770 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.",
771 },
772 PropDef {
773 name: "focusable",
774 id: P_FOCUSABLE,
775 kind: Kind::Flag,
776 apply: Apply::SpecFlag(|s| s.focusable()),
777 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.",
778 },
779 PropDef {
780 name: "keepFocus",
781 id: P_KEEP_FOCUS,
782 kind: Kind::Flag,
783 apply: Apply::SpecFlag(|s| s.keep_focus()),
784 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.",
785 },
786 PropDef {
787 name: "focusRegion",
788 id: P_FOCUS_REGION,
789 kind: Kind::Flag,
790 apply: Apply::SpecFlag(|s| s.focus_region()),
791 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.",
792 },
793 PropDef {
794 name: "scrollbar",
795 id: P_SCROLLBAR,
796 kind: Kind::Enum(SCROLLBARS),
797 apply: Apply::SpecEnum(|s, i| s.scrollbar(crate::spec::ScrollbarMode::ALL[i])),
798 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.",
799 },
800 PropDef {
801 name: "anchor",
802 id: P_ANCHOR,
803 kind: Kind::Flag,
804 apply: Apply::SpecFlag(|s| s.anchor()),
805 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.",
806 },
807 PropDef {
808 name: "scrollbarWidth",
809 id: P_SCROLLBAR_WIDTH,
810 kind: Kind::F32,
811 apply: Apply::SpecF32(|s, v| s.scrollbar_width(v)),
812 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.",
813 },
814 PropDef {
815 name: "scrollbarColor",
816 id: P_SCROLLBAR_COLOR,
817 kind: Kind::Color,
818 apply: Apply::SpecColor(|s, c| s.scrollbar_color(c)),
819 doc: "The thumb at rest; the default is the theme's `scrollbar` role, a translucent wash over whatever it sits on.",
820 },
821 PropDef {
822 name: "scrollbarActiveColor",
823 id: P_SCROLLBAR_ACTIVE_COLOR,
824 kind: Kind::Color,
825 apply: Apply::SpecColor(|s, c| s.scrollbar_active_color(c)),
826 doc: "The thumb under the pointer or while dragged; the default is the theme's `scrollbar_active` role.",
827 },
828 PropDef {
829 name: "overscroll",
830 id: P_OVERSCROLL,
831 kind: Kind::Enum(OVERSCROLLS),
832 apply: Apply::SpecEnum(|s, i| s.overscroll(crate::spec::Overscroll::ALL[i])),
833 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.",
834 },
835 PropDef {
836 name: "disabled",
837 id: P_DISABLED,
838 kind: Kind::Flag,
839 apply: Apply::SpecFlag(|s| s.disabled(true)),
840 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.",
841 },
842 PropDef {
843 name: "hoverBg",
844 id: P_HOVER_BG,
845 kind: Kind::Color,
846 apply: Apply::SpecColor(|s, c| s.hover_bg(c)),
847 doc: "Background while hovered (or while any node in its hoverGroup is); implies hover tracking, eases with `transition`.",
848 },
849 PropDef {
850 name: "gradient",
851 id: P_GRADIENT,
852 kind: Kind::Gradient,
853 apply: Apply::SpecGradient(|s, g| s.gradient(g)),
854 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.",
855 },
856 PropDef {
857 name: "rules",
858 id: P_RULES,
859 kind: Kind::Color,
860 apply: Apply::SpecColor(|s, c| s.rules(c)),
861 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.",
862 },
863 PropDef {
864 name: "ruleWidth",
865 id: P_RULE_WIDTH,
866 kind: Kind::F32,
867 apply: Apply::SpecF32(|s, v| s.rule_width(v)),
868 doc: "The width of a table's `rules` in logical px; 1 when unset.",
869 },
870 PropDef {
871 name: "dropBg",
872 id: P_DROP_BG,
873 kind: Kind::Color,
874 apply: Apply::SpecColor(|s, c| s.drop_bg(c)),
875 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`.",
876 },
877 PropDef {
878 name: "pressedBg",
879 id: P_PRESSED_BG,
880 kind: Kind::Color,
881 apply: Apply::SpecColor(|s, c| s.pressed_bg(c)),
882 doc: "Background while pressed (or while its hoverGroup is); implies hover tracking.",
883 },
884 PropDef {
885 name: "focusBg",
886 id: P_FOCUS_BG,
887 kind: Kind::Color,
888 apply: Apply::SpecColor(|s, c| s.focus_bg(c)),
889 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`.",
890 },
891 PropDef {
892 name: "modal",
893 id: P_MODAL,
894 kind: Kind::Tag,
895 apply: Apply::SpecMsg(|s, v| s.modal(v)),
896 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.",
897 },
898 PropDef {
899 name: "initialFocus",
900 id: P_INITIAL_FOCUS,
901 kind: Kind::Flag,
902 apply: Apply::SpecFlag(|s| s.initial_focus()),
903 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.",
904 },
905 PropDef {
906 name: "hoverGroup",
907 id: P_HOVER_GROUP,
908 kind: Kind::Str,
909 apply: Apply::SpecStr(|s, name| s.hover_group(name)),
910 doc: "Nodes sharing a group name show hoverBg/pressedBg together (a split button, a multi-piece shape).",
911 },
912 PropDef {
913 name: "onHover",
914 id: P_ON_HOVER,
915 kind: Kind::Tag,
916 apply: Apply::SpecMsg(|s, v| s.on_hover(v)),
917 doc: "Hover tag: the pointer entering/leaving emits {kind:\"hover\", phase:\"enter\"|\"leave\", tag} events.",
918 },
919 PropDef {
920 name: "onDrop",
921 id: P_ON_DROP,
922 kind: Kind::Tag,
923 apply: Apply::SpecMsg(|s, v| s.on_drop(v)),
924 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.",
925 },
926 PropDef {
927 name: "onLayout",
928 id: P_ON_LAYOUT,
929 kind: Kind::Tag,
930 apply: Apply::SpecMsg(|s, v| s.on_layout(v)),
931 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).",
932 },
933 PropDef {
934 name: "onClick",
935 id: P_ON_CLICK,
936 kind: Kind::Msg,
937 apply: Apply::SpecMsg(|s, v| s.on_click(v)),
938 doc: "Message emitted when clicked (data, not a callback).",
939 },
940 PropDef {
941 name: "onDrag",
942 id: P_ON_DRAG,
943 kind: Kind::Tag,
944 apply: Apply::SpecMsg(|s, v| s.on_drag(v)),
945 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.",
946 },
947 PropDef {
948 name: "onKey",
949 id: P_ON_KEY,
950 kind: Kind::Tag,
951 apply: Apply::SpecMsg(|s, v| s.on_key(v)),
952 doc: "Key-sink tag: with key focus held, presses arrive as {kind:\"key\", phase:\"down\", code, ...} events. Releases only with `keyUp` beside it.",
953 },
954 PropDef {
955 name: "keyUp",
956 id: P_KEY_UP,
957 kind: Kind::Flag,
958 apply: Apply::SpecFlag(|s| s.key_up()),
959 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.",
960 },
961 PropDef {
962 name: "modifierKeys",
963 id: P_MODIFIER_KEYS,
964 kind: Kind::Flag,
965 apply: Apply::SpecFlag(|s| s.modifier_keys()),
966 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.",
967 },
968 PropDef {
969 name: "onContextMenu",
970 id: P_ON_CONTEXT_MENU,
971 kind: Kind::Tag,
972 apply: Apply::SpecMsg(|s, v| s.on_context_menu(v)),
973 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.",
974 },
975 PropDef {
976 name: "onForceClick",
977 id: P_ON_FORCE_CLICK,
978 kind: Kind::Tag,
979 apply: Apply::SpecMsg(|s, v| s.on_force_click(v)),
980 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.",
981 },
982 PropDef {
983 name: "onButton",
984 id: P_ON_BUTTON,
985 kind: Kind::Tag,
986 apply: Apply::SpecMsg(|s, v| s.on_button(v)),
987 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.",
988 },
989 PropDef {
990 name: "buttons",
991 id: P_BUTTONS,
992 kind: Kind::Str,
993 apply: Apply::SpecStr(|s, v| s.buttons(crate::input::Buttons::parse(v))),
994 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`.",
995 },
996 PropDef {
997 name: "onScroll",
998 id: P_ON_SCROLL,
999 kind: Kind::Tag,
1000 apply: Apply::SpecMsg(|s, v| s.on_scroll(v)),
1001 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`).",
1002 },
1003 PropDef {
1004 name: "scrollAxes",
1005 id: P_SCROLL_AXES,
1006 kind: Kind::Enum(SCROLL_AXES),
1007 apply: Apply::SpecEnum(|s, i| s.scroll_axes(crate::spec::ScrollAxes::ALL[i])),
1008 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`.",
1009 },
1010 PropDef {
1011 name: "window",
1012 id: P_WINDOW,
1013 kind: Kind::Enum(WINDOW_ROLES),
1014 apply: Apply::SpecEnum(|s, i| match i {
1015 0 => s.window_drag(),
1016 1 => s.window_button(WindowButton::Close),
1017 2 => s.window_button(WindowButton::Minimize),
1018 3 => s.window_button(WindowButton::Maximize),
1019 _ => s,
1020 }),
1021 doc: "Window-chrome role: interactions become window commands, not events.",
1022 },
1023 PropDef {
1024 name: "cursor",
1025 id: P_CURSOR,
1026 kind: Kind::Enum(CURSORS),
1027 apply: Apply::SpecEnum(|s, i| s.cursor(cursor_idx(i))),
1028 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.",
1029 },
1030 PropDef {
1031 name: "transition",
1032 id: P_TRANSITION,
1033 kind: Kind::F32,
1034 apply: Apply::SpecF32(|s, v| s.transition(v)),
1035 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).",
1036 },
1037 PropDef {
1038 name: "easing",
1039 id: P_EASING,
1040 kind: Kind::Enum(EASINGS),
1041 apply: Apply::SpecEnum(|s, i| s.easing(easing_idx(i))),
1042 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.",
1043 },
1044 PropDef {
1045 name: "bounce",
1046 id: P_BOUNCE,
1047 kind: Kind::F32,
1048 apply: Apply::SpecF32(|s, v| s.bounce(v)),
1049 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.",
1050 },
1051 PropDef {
1052 name: "slide",
1053 id: P_SLIDE,
1054 kind: Kind::Flag,
1055 apply: Apply::SpecFlag(|s| s.slide()),
1056 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.",
1057 },
1058 PropDef {
1059 name: "keyframes",
1060 id: P_KEYFRAMES,
1061 kind: Kind::Keyframes,
1062 apply: Apply::SpecKeyframes(|s, k| s.keyframes(k)),
1063 doc: "CSS-style stops `[{ at?, width?, height?, bg?, radius?, opacity? }, …]`: the slots they name cycle through them over `transition` ms, forever, without the view redrawing; `at` is 0..1 and spreads evenly when omitted.",
1064 },
1065 PropDef {
1066 name: "enter",
1067 id: P_ENTER,
1068 kind: Kind::Enter,
1069 apply: Apply::SpecEnter(|s, e| s.enter(e)),
1070 doc: "Where the node starts the first frame it is seen `{ dx?, dy?, width?, height?, bg?, radius?, opacity? }`: 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).",
1071 },
1072 PropDef {
1073 name: "exit",
1074 id: P_EXIT,
1075 kind: Kind::Enter,
1076 apply: Apply::SpecEnter(|s, e| s.exit(e)),
1077 doc: "Where the node ends the frame after the view stops declaring it `{ dx?, dy?, width?, height?, bg?, radius?, opacity? }` — 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. Needs a stable key across frames.",
1078 },
1079 PropDef {
1080 name: "repeat",
1081 id: P_REPEAT,
1082 kind: Kind::Enum(REPEATS),
1083 apply: Apply::SpecEnum(|s, i| s.repeat(repeat_idx(i))),
1084 doc: "How `keyframes` cycle (CSS `animation-direction`, default normal). Lua: `direction`, since `repeat` is a keyword.",
1085 },
1086 PropDef {
1087 name: "delay",
1088 id: P_DELAY,
1089 kind: Kind::F32,
1090 apply: Apply::SpecF32(|s, v| s.delay(v)),
1091 doc: "Holds the `keyframes` cycle back by this many ms (CSS `animation-delay`); siblings with different delays run out of phase.",
1092 },
1093 PropDef {
1094 name: "clickSound",
1095 id: P_CLICK_SOUND,
1096 kind: Kind::Resource,
1097 apply: Apply::SpecResource(|s, id| s.click_sound(crate::resources::SoundId::from_ffi(id))),
1098 doc: "A registered sound (addSound) played when the node is clicked; implies hover tracking.",
1099 },
1100 PropDef {
1101 name: "hoverSound",
1102 id: P_HOVER_SOUND,
1103 kind: Kind::Resource,
1104 apply: Apply::SpecResource(|s, id| s.hover_sound(crate::resources::SoundId::from_ffi(id))),
1105 doc: "A registered sound (addSound) played when the pointer enters the node; implies hover tracking.",
1106 },
1107 PropDef {
1108 name: "lineHeight",
1109 id: P_LINE_HEIGHT,
1110 kind: Kind::F32,
1111 apply: Apply::StyleF32(|t, v| t.line_height(v)),
1112 doc: "Line height (logical px); default size * 1.35.",
1113 },
1114 PropDef {
1115 name: "color",
1116 id: P_COLOR,
1117 kind: Kind::Color,
1118 apply: Apply::StyleColor(|t, c| t.color(c)),
1119 doc: "Text color; default foreground when omitted.",
1120 },
1121 PropDef {
1122 name: "family",
1123 id: P_FAMILY,
1124 kind: Kind::Family,
1125 apply: Apply::StyleFamily(|t, f| t.family(f)),
1126 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.",
1127 },
1128 PropDef {
1129 name: "font",
1130 id: P_FONT,
1131 kind: Kind::Resource,
1132 apply: Apply::StyleResource(|t, id| t.font(crate::resources::FontId::from_ffi(id))),
1133 doc: "A registered font handle (addFont / addSystemFont); overrides `family`.",
1134 },
1135 PropDef {
1136 name: "wrap",
1137 id: P_WRAP,
1138 kind: Kind::Enum(WRAPS),
1139 apply: Apply::StyleEnum(|t, i| match i {
1140 1 => t.wrap(TextWrap::Glyph),
1141 2 => t.wrap(TextWrap::None),
1142 3 => t.wrap(TextWrap::BreakSpaces),
1143 _ => t.wrap(TextWrap::Word),
1144 }),
1145 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`).",
1146 },
1147 PropDef {
1148 name: "maxLines",
1149 id: P_MAX_LINES,
1150 kind: Kind::F32,
1151 apply: Apply::StyleF32(|t, v| t.max_lines(v.max(0.0) as u32)),
1152 doc: "Lay out at most this many lines (0 = unlimited); with `ellipsis`, a line clamp.",
1153 },
1154 PropDef {
1155 name: "ellipsis",
1156 id: P_ELLIPSIS,
1157 kind: Kind::Flag,
1158 apply: Apply::StyleFlag(|t| t.ellipsis()),
1159 doc: "End the last line with an ellipsis when the text is cut off: a single line unless `maxLines` says otherwise.",
1160 },
1161 PropDef {
1162 name: "underline",
1163 id: P_UNDERLINE,
1164 kind: Kind::Flag,
1165 apply: Apply::StyleFlag(|t| t.underline()),
1166 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.",
1167 },
1168 PropDef {
1169 name: "underlineColor",
1170 id: P_UNDERLINE_COLOR,
1171 kind: Kind::Color,
1172 apply: Apply::StyleColor(|t, c| t.underline_color(c)),
1173 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.",
1174 },
1175 PropDef {
1176 name: "underlineStyle",
1177 id: P_UNDERLINE_STYLE,
1178 kind: Kind::Enum(UNDERLINE_STYLES),
1179 apply: Apply::StyleEnum(|t, i| t.underline_style(UnderlineStyle::from_index(i as u32))),
1180 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.",
1181 },
1182 PropDef {
1183 name: "strikethrough",
1184 id: P_STRIKETHROUGH,
1185 kind: Kind::Flag,
1186 apply: Apply::StyleFlag(|t| t.strikethrough()),
1187 doc: "A line through the text, where the face puts its strikeout. Paint only; on a `<span>` the span alone, per line.",
1188 },
1189 PropDef {
1190 name: "features",
1191 id: P_FEATURES,
1192 kind: Kind::Str,
1193 apply: Apply::StyleStr(|t, s| t.features(crate::spec::FontFeatures::parse(s))),
1194 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.",
1195 },
1196 PropDef {
1197 name: "role",
1198 id: P_ROLE,
1199 kind: Kind::Enum(ROLES),
1200 apply: Apply::SpecEnum(|s, i| s.role(role_idx(i))),
1201 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. 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.",
1202 },
1203 PropDef {
1204 name: "label",
1205 id: P_LABEL,
1206 kind: Kind::Str,
1207 apply: Apply::SpecStr(|s, v| s.label(v)),
1208 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`).",
1209 },
1210 PropDef {
1211 name: "description",
1212 id: P_DESCRIPTION,
1213 kind: Kind::Str,
1214 apply: Apply::SpecStr(|s, v| s.description(v)),
1215 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.",
1216 },
1217 PropDef {
1218 name: "checked",
1219 id: P_CHECKED,
1220 kind: Kind::Flag,
1221 apply: Apply::SpecFlag(|s| s.checked(true)),
1222 doc: "The on state of a `checkbox` / `radio` / `switch` role.",
1223 },
1224 PropDef {
1225 name: "mixed",
1226 id: P_MIXED,
1227 kind: Kind::Flag,
1228 apply: Apply::SpecFlag(|s| s.mixed(true)),
1229 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.",
1230 },
1231 PropDef {
1232 name: "selected",
1233 id: P_SELECTED,
1234 kind: Kind::Flag,
1235 apply: Apply::SpecFlag(|s| s.selected(true)),
1236 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.",
1237 },
1238 PropDef {
1239 name: "expanded",
1240 id: P_EXPANDED,
1241 kind: Kind::Enum(EXPANDED),
1242 apply: Apply::SpecEnum(|s, i| s.expanded(i == 1)),
1243 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.",
1244 },
1245 PropDef {
1246 name: "live",
1247 id: P_LIVE,
1248 kind: Kind::Enum(LIVE),
1249 apply: Apply::SpecEnum(|s, i| s.live(crate::access::Live::from_index(i))),
1250 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.",
1251 },
1252 PropDef {
1253 name: "valueNow",
1254 id: P_VALUE_NOW,
1255 kind: Kind::F32,
1256 apply: Apply::SpecF32(|s, v| s.value_now(v)),
1257 doc: "A `slider` role's current value (the drawing stays yours; this is what assistive technology reads).",
1258 },
1259 PropDef {
1260 name: "valueMin",
1261 id: P_VALUE_MIN,
1262 kind: Kind::F32,
1263 apply: Apply::SpecF32(|s, v| s.value_min(v)),
1264 doc: "A `slider` role's minimum.",
1265 },
1266 PropDef {
1267 name: "valueMax",
1268 id: P_VALUE_MAX,
1269 kind: Kind::F32,
1270 apply: Apply::SpecF32(|s, v| s.value_max(v)),
1271 doc: "A `slider` role's maximum.",
1272 },
1273 PropDef {
1274 name: "valueText",
1275 id: P_VALUE_TEXT,
1276 kind: Kind::Str,
1277 apply: Apply::SpecStr(|s, v| s.value_text(v)),
1278 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.",
1279 },
1280 PropDef {
1281 name: "valueStep",
1282 id: P_VALUE_STEP,
1283 kind: Kind::F32,
1284 apply: Apply::SpecF32(|s, v| s.value_step(v)),
1285 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.",
1286 },
1287 PropDef {
1288 name: "onFocus",
1289 id: P_ON_FOCUS,
1290 kind: Kind::Tag,
1291 apply: Apply::SpecMsg(|s, v| s.on_focus(v)),
1292 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.",
1293 },
1294 PropDef {
1295 name: "onChange",
1296 id: P_ON_CHANGE,
1297 kind: Kind::Tag,
1298 apply: Apply::SpecMsg(|s, v| s.on_change(v)),
1299 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.",
1300 },
1301 PropDef {
1302 name: "caret",
1303 id: P_CARET,
1304 kind: Kind::F32,
1305 apply: Apply::SpecF32(|s, v| s.caret(v.max(0.0) as u32)),
1306 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.",
1307 },
1308 PropDef {
1309 name: "selectionAnchor",
1310 id: P_SELECTION_ANCHOR,
1311 kind: Kind::F32,
1312 apply: Apply::SpecF32(|s, v| s.selection_anchor(v.max(0.0) as u32)),
1313 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).",
1314 },
1315 PropDef {
1316 name: "caretSolid",
1317 id: P_CARET_SOLID,
1318 kind: Kind::Flag,
1319 apply: Apply::SpecFlag(|s| s.caret_solid()),
1320 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.",
1321 },
1322];
1323
1324pub struct CustomProp {
1328 pub name: &'static str,
1329 pub id: u32,
1330 pub jsx_names: &'static [&'static str],
1337 pub lua_names: &'static [&'static str],
1339 pub jsx: &'static str,
1341 pub lua: &'static str,
1343 pub c: &'static str,
1345 pub doc: &'static str,
1346}
1347
1348pub const CUSTOM: &[CustomProp] = &[
1349 CustomProp {
1350 name: "dir",
1351 id: P_DIR,
1352 jsx_names: &["dir"],
1353 lua_names: &[],
1354 jsx: "`dir=\"row\" | \"column\" | \"table\"`",
1355 lua: "`row { }` / `column { }` / `grid { }`",
1356 c: "`dir` (`KUI_ROW` / `KUI_COLUMN` / `KUI_TABLE`)",
1357 doc: "Main axis; column is the default. `table` is a column whose rows' children line up in columns (the `table` element).",
1358 },
1359 CustomProp {
1360 name: "size",
1361 id: P_SIZE,
1362 jsx_names: &["size"],
1363 lua_names: &["size"],
1364 jsx: "`size` (text)",
1365 lua: "`size`",
1366 c: "`KuiTextStyle.size`",
1367 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.",
1368 },
1369 CustomProp {
1370 name: "pad",
1371 id: P_PAD,
1372 jsx_names: &["pad", "padX", "padY", "padL", "padR", "padT", "padB"],
1373 lua_names: &["pad"],
1374 jsx: "`pad`, `padX`, `padY`, `padL`, `padR`, `padT`, `padB`",
1375 lua: "`pad = n` or `pad = { all=, x=, y=, l=, r=, t=, b= }`",
1376 c: "`pad_l`, `pad_r`, `pad_t`, `pad_b`",
1377 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.",
1378 },
1379 CustomProp {
1380 name: "border",
1381 id: P_BORDER,
1382 jsx_names: &["borderW", "borderColor"],
1383 lua_names: &["border"],
1384 jsx: "`borderW`, `borderColor`",
1385 lua: "`border = { w=, color= }`",
1386 c: "`border_w`, `border_color`",
1387 doc: "Border width and color (drawn inside the rect).",
1388 },
1389 CustomProp {
1390 name: "overflow",
1391 id: P_OVERFLOW,
1392 jsx_names: &["clip", "scrollX", "scrollY"],
1393 lua_names: &["clip", "scroll", "scroll_x", "scroll_y"],
1394 jsx: "`clip`, `scrollX`, `scrollY`",
1395 lua: "`clip`, `scroll_x`, `scroll_y` (`scroll` = `scroll_y`)",
1396 c: "`overflow` bits `KUI_CLIP` | `KUI_SCROLL_X` | `KUI_SCROLL_Y`",
1397 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).",
1398 },
1399 CustomProp {
1400 name: "float",
1401 id: P_FLOAT,
1402 jsx_names: &["float"],
1403 lua_names: &["float"],
1404 jsx: "`float=\"below\" | \"above\" | \"parent\" | \"viewport\"` or `{ anchor, at, self, dx, dy, fit, clip }`",
1405 lua: "`float = \"below\"` or `float = { anchor=, at=, self=, dx=, dy=, fit=, clip= }`",
1406 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",
1407 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`).",
1408 },
1409 CustomProp {
1410 name: "keyFocus",
1411 id: P_KEY_FOCUS,
1412 jsx_names: &["keyFocus"],
1413 lua_names: &["key_focus"],
1414 jsx: "`keyFocus`",
1415 lua: "`key_focus`",
1416 c: "`kui_set_key_focus`",
1417 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`).",
1418 },
1419 CustomProp {
1420 name: "key",
1421 id: P_KEY,
1422 jsx_names: &["key"],
1423 lua_names: &["key"],
1424 jsx: "`key`",
1425 lua: "`key`",
1426 c: "`kui_open_keyed` label",
1427 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).",
1428 },
1429 CustomProp {
1430 name: "index",
1431 id: P_INDEX,
1432 jsx_names: &["index"],
1433 lua_names: &["index"],
1434 jsx: "`index`",
1435 lua: "`index`",
1436 c: "`kui_open_indexed`",
1437 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.",
1438 },
1439 CustomProp {
1440 name: "rowCount",
1441 id: P_ROW_COUNT,
1442 jsx_names: &["rowCount"],
1443 lua_names: &["row_count"],
1444 jsx: "`rowCount`",
1445 lua: "`row_count`",
1446 c: "`kui_row_count`",
1447 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.",
1448 },
1449 CustomProp {
1450 name: "title",
1451 id: P_TITLE,
1452 jsx_names: &["title"],
1453 lua_names: &["window_title"],
1454 jsx: "`title` (root box only)",
1455 lua: "`window_title` (root table)",
1456 c: "`kui_window_title`",
1457 doc: "Declares the window title for this frame; the driver diffs and applies.",
1458 },
1459 CustomProp {
1460 name: "alwaysOnTop",
1461 id: P_ALWAYS_ON_TOP,
1462 jsx_names: &["alwaysOnTop"],
1463 lua_names: &["always_on_top"],
1464 jsx: "`alwaysOnTop` (root box only)",
1465 lua: "`always_on_top = true` (root table)",
1466 c: "`kui_set_always_on_top`",
1467 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.",
1468 },
1469 CustomProp {
1470 name: "secureInput",
1471 id: P_SECURE_INPUT,
1472 jsx_names: &["secureInput"],
1473 lua_names: &["secure_input"],
1474 jsx: "`secureInput` (root box only)",
1475 lua: "`secure_input = true` (root table)",
1476 c: "`kui_set_secure_input`",
1477 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.",
1478 },
1479 CustomProp {
1480 name: "optionAsAlt",
1481 id: P_OPTION_AS_ALT,
1482 jsx_names: &["optionAsAlt"],
1483 lua_names: &["option_as_alt"],
1484 jsx: "`optionAsAlt=\"left\"` — `\"none\"`, `\"left\"`, `\"right\"`, `\"both\"` (root box only)",
1485 lua: "`option_as_alt = \"left\"` (root table)",
1486 c: "`kui_set_option_as_alt` (`KUI_OPTION_AS_ALT_*`)",
1487 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.",
1488 },
1489 CustomProp {
1490 name: "windows",
1491 id: P_WINDOWS,
1492 jsx_names: &["windows"],
1493 lua_names: &["windows"],
1494 jsx: "`windows={[{ name, kind?, anchor?, width?, height?, activates? }]}` (root box only; `windows: (model) => [...]` in the loop config)",
1495 lua: "`windows = { { name=, kind=, anchor=, width=, height=, activates= } }` (root table)",
1496 c: "`kui_window_declare`",
1497 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.",
1498 },
1499 CustomProp {
1500 name: "tooltip",
1501 id: P_TOOLTIP,
1502 jsx_names: &["tooltip"],
1503 lua_names: &["tooltip"],
1504 jsx: "`tooltip=\"hint\"`",
1505 lua: "`tooltip = \"hint\"`",
1506 c: "`KuiSpec.tooltip` (`kui_tooltip` / `kui_tooltip_with` draw a hint that is not hover-gated)",
1507 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. The float is the node's last child, so it is drawn for a box or a `fragment`; on a leaf that holds no children — an `image`, an `edit`, a `cells` grid — the hint is tracked and spoken but not drawn, so put the tooltip on a box around it (backlog RG75).",
1508 },
1509];
1510
1511pub const C_FIELDS: &[(&str, &str)] = &[
1514 ("width", "`width` (KuiSizing)"),
1515 ("height", "`height` (KuiSizing)"),
1516 ("center", "`main_align` + `cross_align` = `KUI_CENTER`"),
1517 ("window", "`window_role` (`KUI_WINDOW_*`)"),
1518 ("transition", "`transition_ms`"),
1519 ("easing", "`easing` (`KUI_EASE_*`)"),
1520 (
1521 "keyframes",
1522 "`keyframes` + `keyframes_len` (`KuiKeyframe[]`)",
1523 ),
1524 ("gradient", "`gradient` (`const KuiGradient *`)"),
1525 ("repeat", "`repeat` (`KUI_REPEAT_*`)"),
1526 ("delay", "`delay_ms`"),
1527 ("enter", "`enter` (`KuiEnter`, with `set` bits)"),
1528 ("exit", "`exit` (`KuiEnter`, with `set` bits)"),
1529 ("opacity", "`opacity` with `opacity_set`"),
1530 ("radiusTL", "`radius_tl` with `per_corner`"),
1531 ("radiusTR", "`radius_tr` with `per_corner`"),
1532 ("radiusBR", "`radius_br` with `per_corner`"),
1533 ("radiusBL", "`radius_bl` with `per_corner`"),
1534 ("hoverGroup", "`hover_group` (KuiStr)"),
1535 ("role", "`role` (`KUI_ROLE_*`)"),
1536 ("expanded", "`expanded` (`KUI_EXPANDED_*`)"),
1537 ("live", "`live` (`KUI_LIVE_*`)"),
1538 ("cursor", "`cursor` (`KUI_CURSOR_*`)"),
1539 ("label", "`label` (KuiStr)"),
1540 (
1541 "valueNow",
1542 "`value_now` with `KUI_VALUE_NOW` in `value_set`",
1543 ),
1544 (
1545 "valueMin",
1546 "`value_min` with `KUI_VALUE_MIN` in `value_set`",
1547 ),
1548 (
1549 "valueMax",
1550 "`value_max` with `KUI_VALUE_MAX` in `value_set`",
1551 ),
1552 ("valueText", "`value_text` (KuiStr)"),
1553 ("caret", "`caret` with `KUI_VALUE_CARET` in `value_set`"),
1554 (
1555 "selectionAnchor",
1556 "`selection_anchor` with `KUI_VALUE_ANCHOR` in `value_set`",
1557 ),
1558 (
1559 "onClick",
1560 "`on_click` argument of `kui_open` / `kui_open_with`",
1561 ),
1562 (
1563 "onDrag",
1564 "`on_drag` argument of `kui_open_draggable` / `kui_open_with`",
1565 ),
1566 ("onKey", "`on_key` argument of `kui_open_with`"),
1567 (
1568 "onContextMenu",
1569 "`on_context_menu` (a borrowed `KuiValue*`, cloned while the node opens)",
1570 ),
1571 (
1572 "onButton",
1573 "`on_button` (a borrowed `KuiValue*`, cloned while the node opens)",
1574 ),
1575 (
1576 "buttons",
1577 "`buttons` (`KUI_BUTTONS_*` bits; zeroed, all three)",
1578 ),
1579 (
1580 "modal",
1581 "`modal` (a borrowed `KuiValue*`, cloned while the node opens)",
1582 ),
1583 (
1584 "onScroll",
1585 "`on_scroll` (a borrowed `KuiValue*`, cloned while the node opens)",
1586 ),
1587 ("onHover", "`on_hover` argument of `kui_open_with`"),
1588 (
1589 "onFocus",
1590 "`on_focus` (a borrowed `KuiValue*`, cloned while the node opens)",
1591 ),
1592 ("ruleWidth", "`rule_w`"),
1593 (
1594 "overscroll",
1595 "`overscroll` (`KUI_OVERSCROLL_*`; zeroed, auto)",
1596 ),
1597 (
1598 "scrollAxes",
1599 "`scroll_axes` (`KUI_SCROLL_AXES_*`; zeroed, both)",
1600 ),
1601 (
1602 "onDrop",
1603 "`on_drop` (a borrowed `KuiValue*`, cloned while the node opens)",
1604 ),
1605 (
1606 "onLayout",
1607 "`on_layout` (a borrowed `KuiValue*`, cloned while the node opens)",
1608 ),
1609 ("family", "`KuiTextStyle.family` (`KUI_FONT_*`)"),
1610 ("font", "`KuiTextStyle.font` (from `kui_font_add*`)"),
1611 ("lineHeight", "`KuiTextStyle.line_height`"),
1612 ("wrap", "`KuiTextStyle.wrap` (`KUI_WRAP_*`)"),
1613 ("maxLines", "`KuiTextStyle.max_lines`"),
1614 ("ellipsis", "`KuiTextStyle.ellipsis`"),
1615 (
1616 "features",
1617 "`KuiTextStyle.features` (a `KuiStr`, the same spelling)",
1618 ),
1619 (
1620 "underline",
1621 "`KuiTextStyle.decoration` (`KUI_DECO_UNDERLINE`); `KuiSpan.flags` (`KUI_SPAN_UNDERLINE`)",
1622 ),
1623 (
1624 "strikethrough",
1625 "`KuiTextStyle.decoration` (`KUI_DECO_STRIKETHROUGH`); `KuiSpan.flags` (`KUI_SPAN_STRIKETHROUGH`)",
1626 ),
1627 (
1628 "underlineColor",
1629 "`KuiTextStyle.underline_color`; `KuiSpan.underline_color`",
1630 ),
1631 (
1632 "underlineStyle",
1633 "`KuiTextStyle.underline_style` (`KUI_UNDERLINE_*`); `KuiSpan.underline_style`",
1634 ),
1635 ("color", "`KuiTextStyle.color`"),
1636];
1637
1638pub fn c_field(def: &PropDef) -> String {
1640 C_FIELDS
1641 .iter()
1642 .find(|(n, _)| *n == def.name)
1643 .map(|(_, c)| (*c).to_string())
1644 .unwrap_or_else(|| format!("`{}`", def.snake_name()))
1645}
1646
1647pub struct ElementDef {
1652 pub name: &'static str,
1653 pub jsx_own: &'static [&'static str],
1659 pub lua_own: &'static [&'static str],
1661 pub jsx_rows: Option<&'static [&'static str]>,
1669 pub lua_rows: Option<&'static [&'static str]>,
1670 pub jsx: &'static str,
1671 pub lua: &'static str,
1672 pub c: &'static str,
1673 pub doc: &'static str,
1674}
1675
1676pub const TEXT_ROWS_JSX: &[&str] = &[
1687 "size",
1688 "lineHeight",
1689 "color",
1690 "family",
1691 "font",
1692 "wrap",
1693 "maxLines",
1694 "ellipsis",
1695 "underline",
1696 "underlineColor",
1697 "underlineStyle",
1698 "strikethrough",
1699 "features",
1700];
1701pub const TEXT_ROWS_LUA: &[&str] = &[
1702 "size",
1703 "line_height",
1704 "color",
1705 "family",
1706 "font",
1707 "wrap",
1708 "max_lines",
1709 "ellipsis",
1710 "underline",
1711 "underline_color",
1712 "underline_style",
1713 "strikethrough",
1714 "features",
1715];
1716
1717pub const BUTTON_ROWS_JSX: &[&str] = &[
1725 "onClick",
1726 "key",
1727 "index",
1728 "label",
1729 "description",
1730 "tooltip",
1731 "disabled",
1732 "accent",
1733];
1734pub const BUTTON_ROWS_LUA: &[&str] = &[
1735 "on_click",
1736 "key",
1737 "index",
1738 "label",
1739 "description",
1740 "tooltip",
1741 "disabled",
1742 "accent",
1743];
1744
1745pub const TOGGLE_ROWS_JSX: &[&str] = &[
1750 "onClick",
1751 "key",
1752 "label",
1753 "description",
1754 "tooltip",
1755 "disabled",
1756 "checked",
1757 "mixed",
1758];
1759pub const TOGGLE_ROWS_LUA: &[&str] = &[
1760 "on_click",
1761 "key",
1762 "label",
1763 "description",
1764 "tooltip",
1765 "disabled",
1766 "checked",
1767 "mixed",
1768];
1769pub const SLIDER_ROWS_JSX: &[&str] = &[
1773 "key",
1774 "label",
1775 "description",
1776 "tooltip",
1777 "disabled",
1778 "valueNow",
1779 "valueMin",
1780 "valueMax",
1781 "valueStep",
1782 "valueText",
1783 "onChange",
1784 "width",
1785 "minWidth",
1786 "maxWidth",
1787];
1788pub const SLIDER_ROWS_LUA: &[&str] = &[
1789 "key",
1790 "label",
1791 "description",
1792 "tooltip",
1793 "disabled",
1794 "value_now",
1795 "value_min",
1796 "value_max",
1797 "value_step",
1798 "value_text",
1799 "on_change",
1800 "width",
1801 "min_width",
1802 "max_width",
1803];
1804
1805pub const ELEMENTS: &[ElementDef] = &[
1806 ElementDef {
1807 name: "box",
1808 jsx_own: &[],
1809 lua_own: &[],
1810 jsx_rows: None,
1811 lua_rows: None,
1812 jsx: "`<box>`",
1813 lua: "`row { }`, `column { }`",
1814 c: "`kui_open*` … `kui_close`",
1815 doc: "A container: every container prop applies.",
1816 },
1817 ElementDef {
1818 name: "table",
1819 jsx_own: &[],
1820 lua_own: &[],
1821 jsx_rows: None,
1822 lua_rows: None,
1823 jsx: "`<box dir=\"table\">`",
1824 lua: "`grid { }`",
1825 c: "`kui_open*` with `dir = KUI_TABLE`",
1826 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.",
1827 },
1828 ElementDef {
1829 name: "text",
1830 jsx_own: &["bold", "italic", "bg", "bgRadius"],
1831 lua_own: &["value", "spans"],
1832 jsx_rows: Some(TEXT_ROWS_JSX),
1833 lua_rows: Some(TEXT_ROWS_LUA),
1834 jsx: "`<text>` with `<span bold italic underline strikethrough bg bgRadius color>` children",
1835 lua: "`text(\"s\", {…})`, `text({ \"a\", { \"b\", bold = true, underline = true, bg = 0x.., bg_radius = 4 } })`",
1836 c: "`kui_text`, `kui_rich_text`",
1837 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`, `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 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.",
1838 },
1839 ElementDef {
1840 name: "button",
1841 jsx_own: &[],
1842 lua_own: &["text"],
1843 jsx_rows: Some(BUTTON_ROWS_JSX),
1844 lua_rows: Some(BUTTON_ROWS_LUA),
1845 jsx: "`<button onClick key|index label description tooltip disabled accent>`",
1846 lua: "`button { label=, on_click=, key= | index=, text=, description=, tooltip=, disabled=, accent= }`",
1847 c: "`kui_button`, `kui_button_with`",
1848 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.",
1849 },
1850 ElementDef {
1851 name: "edit",
1852 jsx_own: &["id", "initial", "multiline", "autofocus"],
1853 lua_own: &["initial", "multiline", "autofocus"],
1854 jsx_rows: None,
1855 lua_rows: None,
1856 jsx: "`<edit key initial multiline autofocus>`, `<input label initial>`",
1857 lua: "`edit { key=, initial=, … }`, `input { label=, initial= }`",
1858 c: "`kui_text_edit`, `kui_text_input`",
1859 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.",
1860 },
1861 ElementDef {
1862 name: "select",
1863 jsx_own: &["label", "options", "current"],
1864 lua_own: &["label", "options", "current"],
1865 jsx_rows: Some(&[]),
1868 lua_rows: Some(&[]),
1869 jsx: "`<select label options={[…]} current>`",
1870 lua: "`dropdown { label=, options={…}, current= }`",
1871 c: "`kui_select`",
1872 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.",
1873 },
1874 ElementDef {
1875 name: "checkbox",
1876 jsx_own: &[],
1877 lua_own: &["text"],
1878 jsx_rows: Some(TOGGLE_ROWS_JSX),
1879 lua_rows: Some(TOGGLE_ROWS_LUA),
1880 jsx: "`<checkbox checked mixed onClick key label description tooltip disabled>text</checkbox>`",
1881 lua: "`checkbox { label=, checked=, mixed=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1882 c: "`kui_checkbox`",
1883 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.",
1884 },
1885 ElementDef {
1886 name: "radio",
1887 jsx_own: &[],
1888 lua_own: &["text"],
1889 jsx_rows: Some(TOGGLE_ROWS_JSX),
1890 lua_rows: Some(TOGGLE_ROWS_LUA),
1891 jsx: "`<radio checked onClick key label description tooltip disabled>text</radio>`",
1892 lua: "`radio { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1893 c: "`kui_radio`",
1894 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.",
1895 },
1896 ElementDef {
1897 name: "radioGroup",
1898 jsx_own: &[],
1899 lua_own: &[],
1900 jsx_rows: None,
1901 lua_rows: None,
1902 jsx: "`<radioGroup label>…radios…</radioGroup>`",
1903 lua: "`radio_group { label=, … }`",
1904 c: "`kui_radio_group_open` … `kui_close`",
1905 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.",
1906 },
1907 ElementDef {
1908 name: "switch",
1909 jsx_own: &[],
1910 lua_own: &["text"],
1911 jsx_rows: Some(TOGGLE_ROWS_JSX),
1912 lua_rows: Some(TOGGLE_ROWS_LUA),
1913 jsx: "`<switch checked onClick key label description tooltip disabled>text</switch>`",
1914 lua: "`switch { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1915 c: "`kui_switch`",
1916 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.",
1917 },
1918 ElementDef {
1919 name: "slider",
1920 jsx_own: &[],
1921 lua_own: &[],
1922 jsx_rows: Some(SLIDER_ROWS_JSX),
1923 lua_rows: Some(SLIDER_ROWS_LUA),
1924 jsx: "`<slider label valueNow valueMin valueMax valueStep valueText onChange width description tooltip disabled/>`",
1925 lua: "`slider { label=, value_now=, value_min=, value_max=, value_step=, value_text=, on_change=, width=, … }`",
1926 c: "`kui_slider`",
1927 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.",
1928 },
1929 ElementDef {
1930 name: "image",
1931 jsx_own: &["src", "sampling", "fit"],
1932 lua_own: &["id", "sampling", "fit"],
1933 jsx_rows: None,
1934 lua_rows: None,
1935 jsx: "`<image src={id} sampling fit>`",
1936 lua: "`image { id=, sampling=, fit= }`",
1937 c: "`kui_image`, `kui_image_with`",
1938 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.",
1939 },
1940 ElementDef {
1941 name: "polygon",
1942 jsx_own: &["points"],
1944 lua_own: &["points"],
1945 jsx_rows: None,
1946 lua_rows: None,
1947 jsx: "`<polygon points={[[x,y],…]} bg/>`",
1948 lua: "`polygon { points={{x,y},…}, bg= }`",
1949 c: "`kui_polygon`",
1950 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. 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.",
1951 },
1952 ElementDef {
1953 name: "path",
1954 jsx_own: &["d", "fillRule", "rotate", "pivot", "dash", "dashOffset"],
1958 lua_own: &[
1959 "d",
1960 "ops",
1961 "fill_rule",
1962 "rotate",
1963 "pivot",
1964 "dash",
1965 "dash_offset",
1966 ],
1967 jsx_rows: None,
1968 lua_rows: None,
1969 jsx: "`<path d=\"M … Z\" bg width color fillRule rotate pivot dash dashOffset/>`",
1970 lua: "`path { d = \"M … Z\", bg=, width=, color=, fill_rule=, rotate=, pivot=, dash=, dash_offset= }`",
1971 c: "`kui_path`",
1972 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. `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 — 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.",
1973 },
1974 ElementDef {
1975 name: "fragment",
1976 jsx_own: &["src", "image", "params", "animate"],
1977 lua_own: &["id", "image", "params", "animate"],
1978 jsx_rows: None,
1979 lua_rows: None,
1980 jsx: "`<fragment src={id} image={id} params={[…]} animate>`",
1981 lua: "`fragment { id=, image=, params={…}, animate= }`",
1982 c: "`kui_fragment`, `kui_fragment_with`",
1983 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.",
1984 },
1985 ElementDef {
1986 name: "cells",
1987 jsx_own: &[
1988 "rows",
1989 "cols",
1990 "cells",
1991 "cursorAt",
1992 "cursorShape",
1993 "cursorColor",
1994 "originLine",
1995 ],
1996 lua_own: &[
1997 "rows",
1998 "cols",
1999 "lines",
2000 "runs",
2001 "cursor_at",
2002 "cursor_shape",
2003 "cursor_color",
2004 "origin_line",
2005 ],
2006 jsx_rows: None,
2007 lua_rows: None,
2008 jsx: "`<cells rows cols cells={Uint32Array} cursorAt={[row, col]} cursorShape cursorColor size family lineHeight/>`",
2009 lua: "`cells { rows=, cols=, lines={\"row text\", …}, runs={{row, col, len, fg, bg, flags}, …}, cursor_at={row, col}, cursor_shape=, cursor_color=, size=, family= }`",
2010 c: "`kui_cells`",
2011 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.",
2012 },
2013 ElementDef {
2014 name: "line",
2015 jsx_own: &["from", "to", "points", "curve", "dash", "dashOffset"],
2018 lua_own: &["from", "to", "points", "curve", "dash", "dash_offset"],
2019 jsx_rows: None,
2020 lua_rows: None,
2021 jsx: "`<line from={[x,y]} to={[x,y]} width color/>`, `<line points={[[x,y],…]} curve dash={[6, 4]} dashOffset/>`",
2022 lua: "`line { from={x,y}, to={x,y}, width=, color= }`, `line { points={{x,y},…}, curve=true, dash={6, 4}, dash_offset= }`",
2023 c: "`kui_line`, `kui_polyline`",
2024 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. 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 (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, and a mark no longer than the stroke is wide is a dot (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`). 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.",
2025 },
2026 ElementDef {
2027 name: "titlebar",
2028 jsx_own: &[],
2029 lua_own: &["title"],
2032 jsx_rows: None,
2033 lua_rows: None,
2034 jsx: "`<titlebar title>` or `<titlebar>…</titlebar>`",
2035 lua: "`titlebar { title= }` / `titlebar { … }`",
2036 c: "`kui_titlebar`, `kui_titlebar_with`",
2037 doc: "Adaptive titlebar for custom chrome: drag strip, native-control inset, window buttons.",
2038 },
2039 ElementDef {
2040 name: "menuBar",
2041 jsx_own: &["menu"],
2042 lua_own: &["menu"],
2043 jsx_rows: None,
2044 lua_rows: None,
2045 jsx: "`<menuBar menu={[{ label, items: [{ label, id?, role?, accel?, enabled?, checked? }] }]}/>`",
2046 lua: "`menu_bar { menu = { { label=, items= { { label=, id=, role=, accel=, enabled=, checked= } } } } }`",
2047 c: "`kui_menu_bar`",
2048 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.",
2049 },
2050 ElementDef {
2051 name: "windowButtons",
2052 jsx_own: &[],
2053 lua_own: &[],
2054 jsx_rows: None,
2055 lua_rows: None,
2056 jsx: "`<windowButtons/>`",
2057 lua: "`window_buttons()`",
2058 c: "`kui_window_buttons`",
2059 doc: "Just the min/max/close buttons, for fully custom titlebars.",
2060 },
2061 ElementDef {
2062 name: "tooltip",
2063 jsx_own: &["value"],
2064 lua_own: &["value"],
2065 jsx_rows: None,
2066 lua_rows: None,
2067 jsx: "`<tooltip value=\"hint\"/>` / `<tooltip>…</tooltip>` nodes, or the `tooltip=\"hint\"` prop (see composites)",
2068 lua: "`tooltip(\"hint\")` / `tooltip { … }` nodes, or the prop",
2069 c: "`kui_tooltip`, `kui_tooltip_with`",
2070 doc: "A float hanging below the parent; the node form always draws, the prop form is hover-gated.",
2071 },
2072 ElementDef {
2073 name: "latencyGraph",
2074 jsx_own: &["at"],
2075 lua_own: &["at"],
2076 jsx_rows: None,
2077 lua_rows: None,
2078 jsx: "`<latencyGraph/>`, `<latencyHud at/>`",
2079 lua: "`latency_graph()`, `latency_hud { at= }`",
2080 c: "`kui_latency_graph`, `kui_latency_hud`",
2081 doc: "Per-phase frame timing (windowed drivers fill it; headless shows the chrome empty).",
2082 },
2083 ElementDef {
2084 name: "audio",
2085 jsx_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2086 lua_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2087 jsx_rows: None,
2088 lua_rows: None,
2089 jsx: "`<audio src={id} loop volume paused finish tag/>`",
2090 lua: "`audio { src=, loop=, volume=, paused=, finish=, tag= }`",
2091 c: "`kui_audio`",
2092 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.",
2093 },
2094];
2095
2096pub struct EventDef {
2098 pub kind: &'static str,
2099 pub payload: &'static str,
2100 pub doc: &'static str,
2101}
2102
2103pub const EVENTS: &[EventDef] = &[
2104 EventDef {
2105 kind: "click",
2106 payload: "the `onClick` payload as-is",
2107 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` and `clicks` as a `drag` inside one carries them.",
2108 },
2109 EventDef {
2110 kind: "drag",
2111 payload: "`{ kind: \"drag\", phase: \"start\" | \"move\" | \"end\", x, y, dx, dy, parent: { x, y, w, h }, tag }`",
2112 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. Nothing is added where the sink draws no lines.",
2113 },
2114 EventDef {
2115 kind: "key",
2116 payload: "`{ kind: \"key\", phase: \"down\" | \"up\", code, physical, shift, ctrl, alt, super, text, repeat, location, caps_lock, num_lock, tag }`",
2117 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`.",
2118 },
2119 EventDef {
2120 kind: "text",
2121 payload: "`{ kind: \"text\", text, pasted?: true, concealed?: true, transient?: true, tag }`",
2122 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.",
2123 },
2124 EventDef {
2125 kind: "preedit",
2126 payload: "`{ kind: \"preedit\", text, cursor: [start, end] | null, tag }`",
2127 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.",
2128 },
2129 EventDef {
2130 kind: "selectionrange",
2131 payload: "`{ kind: \"selectionrange\", from: { index, byte }, to: { index, byte } }` on the scope",
2132 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.",
2133 },
2134 EventDef {
2135 kind: "contextmenu",
2136 payload: "`{ kind: \"contextmenu\", x, y, tag }`",
2137 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`.",
2138 },
2139 EventDef {
2140 kind: "menu",
2141 payload: "`{ kind: \"menu\", role, item }`",
2142 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).",
2143 },
2144 EventDef {
2145 kind: "forceclick",
2146 payload: "`{ kind: \"forceclick\", x, y, tag }`",
2147 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.",
2148 },
2149 EventDef {
2150 kind: "button",
2151 payload: "`{ kind: \"button\", phase: \"press\" | \"move\" | \"release\", button: \"secondary\" | \"middle\" | number, x, y, clicks, cell?: { row, col }, line?, byte?, tag }`",
2152 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` and `byte` as a drag does. A claimed secondary press is this event instead of `contextmenu`; the press moves no focus, caret, selection or scrollbar.",
2153 },
2154 EventDef {
2155 kind: "scroll",
2156 payload: "`{ kind: \"scroll\", x, y, dx, dy, lines, tag }`",
2157 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`).",
2158 },
2159 EventDef {
2160 kind: "focus",
2161 payload: "`{ kind: \"focus\", phase: \"in\" | \"out\", by: \"pointer\" | \"keyboard\" | \"assistive\" | \"program\", tag }`",
2162 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.",
2163 },
2164 EventDef {
2165 kind: "hover",
2166 payload: "`{ kind: \"hover\", phase: \"enter\" | \"leave\", by: \"pointer\" | \"content\", tag }`",
2167 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.",
2168 },
2169 EventDef {
2170 kind: "drop",
2171 payload: "`{ kind: \"drop\", phase: \"enter\" | \"move\" | \"leave\" | \"drop\", paths: string[], x, y, tag }`",
2172 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.",
2173 },
2174 EventDef {
2175 kind: "files",
2176 payload: "`{ kind: \"files\", paths: string[], tag }`",
2177 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.",
2178 },
2179 EventDef {
2180 kind: "layout",
2181 payload: "`{ kind: \"layout\", x, y, w, h, parent: { x, y, w, h }, scale, tag }`",
2182 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).",
2183 },
2184 EventDef {
2185 kind: "resize",
2186 payload: "`{ kind: \"resize\", width, height, scale }`",
2187 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.",
2188 },
2189 EventDef {
2190 kind: "window",
2191 payload: "`{ kind: \"window\", phase: \"opened\" | \"closed\" | \"focused\" | \"blurred\", name, id }`",
2192 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.",
2193 },
2194 EventDef {
2195 kind: "system",
2196 payload: "`{ kind: \"system\", appearance, accent, motion, locale, assistive }`",
2197 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.",
2198 },
2199 EventDef {
2200 kind: "fonts",
2201 payload: "`{ kind: \"fonts\" }`",
2202 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.",
2203 },
2204 EventDef {
2205 kind: "modifiers",
2206 payload: "`{ kind: \"modifiers\", shift, ctrl, alt, super }`",
2207 doc: "The physical modifier state changed (delivered to the host on the root).",
2208 },
2209 EventDef {
2210 kind: "changed",
2211 payload: "`{ kind: \"changed\" }`, with the editor's key on the event",
2212 doc: "An editor's text changed.",
2213 },
2214 EventDef {
2215 kind: "submit",
2216 payload: "`{ kind: \"submit\" }`, with the editor's key on the event",
2217 doc: "Enter in a single-line editor.",
2218 },
2219 EventDef {
2220 kind: "sound",
2221 payload: "`{ kind: \"sound\", phase: \"ended\" | \"refused\", playback, tag }`",
2222 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.",
2223 },
2224 EventDef {
2225 kind: "dismiss",
2226 payload: "`{ kind: \"dismiss\", reason: \"escape\" | \"outside\", tag }` on a node; `{ kind: \"dismiss\", reason, name, id }` on the root for a popup window",
2227 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.",
2228 },
2229 EventDef {
2230 kind: "access",
2231 payload: "`{ kind: \"access\", action, tag, text?, value?, anchor?: { line, offset }, focus?: { line, offset } }`",
2232 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.",
2233 },
2234 EventDef {
2235 kind: "change",
2236 payload: "`{ kind: \"change\", value, phase: \"move\" | \"end\", tag }`",
2237 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.",
2238 },
2239];
2240
2241pub struct ResourceDef {
2243 pub what: &'static str,
2244 pub node: &'static str,
2245 pub lua: &'static str,
2246 pub c: &'static str,
2247}
2248
2249pub const RESOURCES: &[ResourceDef] = &[
2250 ResourceDef {
2251 what: "image",
2252 node: "`ctx.addImage(w, h, rgba)` → id for `<image src>`",
2253 lua: "the host registers; `image { id }`",
2254 c: "`kui_image_add` → `kui_image`",
2255 },
2256 ResourceDef {
2257 what: "fragment (WGSL)",
2258 node: "`ctx.addFragment(src)` → id for `<fragment src>`",
2259 lua: "the host registers; `fragment { id }`",
2260 c: "`kui_fragment_add` → `kui_fragment`",
2261 },
2262 ResourceDef {
2263 what: "font from bytes",
2264 node: "`ctx.addFont(buffer)` → id for `font`",
2265 lua: "the host registers; `font = id`",
2266 c: "`kui_font_add` → `KuiTextStyle.font`",
2267 },
2268 ResourceDef {
2269 what: "font file by path",
2270 node: "`ctx.loadFontFile(\"fonts/Antonio.ttf\")` → id for `font`",
2271 lua: "the host registers; `font = id`",
2272 c: "`kui_font_load_file`",
2273 },
2274 ResourceDef {
2275 what: "a folder of fonts",
2276 node: "`ctx.loadFontsDir(\"fonts\")`, then pick by name",
2277 lua: "the host loads",
2278 c: "`kui_font_load_dir`",
2279 },
2280 ResourceDef {
2281 what: "font by family name (installed or loaded)",
2282 node: "`ctx.addSystemFont(\"Antonio\")` (see `systemFontFamilies()`)",
2283 lua: "the host registers; `font = id`",
2284 c: "`kui_font_add_system` (see `kui_font_families`)",
2285 },
2286 ResourceDef {
2287 what: "sound (wav / ogg / mp3 / flac bytes)",
2288 node: "`ctx.addSound(buffer)` → id for `<audio src>`, `clickSound`, `play(id)`",
2289 lua: "the host registers; `audio { src = id }`, `click_sound = id`",
2290 c: "`kui_sound_add` → `kui_audio`, `KuiSpec.click_sound`, `kui_play`",
2291 },
2292];
2293
2294pub struct EnvField {
2314 pub name: &'static str,
2316 pub from: &'static str,
2319 pub node: &'static [&'static str],
2323 pub lua: &'static [&'static str],
2326 pub c: &'static str,
2330 pub doc: &'static str,
2331 pub get: fn(&EnvFacts) -> Value,
2339}
2340
2341#[derive(Clone, Copy, Debug)]
2344pub struct EnvFacts {
2345 pub env: crate::env::Env,
2346 pub viewport: crate::geom::Size,
2347 pub scale: f32,
2348 pub focus: Option<crate::key::Key>,
2349 pub focus_visible: bool,
2350 pub region: Option<crate::key::Key>,
2351 pub caret_visible: bool,
2352}
2353
2354fn key_value(k: Option<crate::key::Key>) -> Value {
2355 k.map_or(Value::Null, |k| Value::Int(k.0 as i64))
2356}
2357
2358fn rect_value(r: crate::geom::Rect) -> Value {
2359 Value::map([
2360 ("x", Value::Float(r.x as f64)),
2361 ("y", Value::Float(r.y as f64)),
2362 ("w", Value::Float(r.w as f64)),
2363 ("h", Value::Float(r.h as f64)),
2364 ])
2365}
2366
2367pub const ENV_FIELDS: &[EnvField] = &[
2368 EnvField {
2369 name: "refresh_hz",
2370 get: |f| {
2371 f.env
2372 .refresh_hz
2373 .map_or(Value::Null, |hz| Value::Float(hz as f64))
2374 },
2375 from: "`Env::refresh_hz`",
2376 node: &["refreshHz"],
2377 lua: &["refresh_hz"],
2378 c: "`kui_env_set(refresh_hz)`",
2379 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.",
2380 },
2381 EnvField {
2382 name: "frame_budget_ms",
2383 get: |f| Value::Float(f.env.frame_budget_ms() as f64),
2384 from: "`Env::frame_budget_ms()`, derived",
2385 node: &["frameBudgetMs"],
2386 lua: &["frame_budget_ms"],
2387 c: "—",
2388 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.",
2389 },
2390 EnvField {
2391 name: "focused",
2392 get: |f| Value::Bool(f.env.focused),
2393 from: "`Env::focused`",
2394 node: &["focused"],
2395 lua: &["focused"],
2396 c: "`kui_env_set(focused)`",
2397 doc: "Whether the *window* has the keyboard at all. Not the focused node — that is the `focus` row.",
2398 },
2399 EnvField {
2400 name: "system.appearance",
2401 get: |f| Value::str(f.env.system.appearance.name()),
2402 from: "`SystemEnv::appearance`",
2403 node: &["system.appearance"],
2404 lua: &["system.appearance"],
2405 c: "`kui_env_set_system(appearance)`",
2406 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.",
2407 },
2408 EnvField {
2409 name: "system.accent",
2410 get: |f| {
2411 f.env
2412 .system
2413 .accent
2414 .map_or(Value::Null, |c| Value::Int(c.to_hex() as i64))
2415 },
2416 from: "`SystemEnv::accent`",
2417 node: &["system.accent"],
2418 lua: &["system.accent"],
2419 c: "`kui_env_set_system(accent)`",
2420 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.",
2421 },
2422 EnvField {
2423 name: "system.motion",
2424 get: |f| Value::str(f.env.system.motion.name()),
2425 from: "`SystemEnv::motion`",
2426 node: &["system.motion"],
2427 lua: &["system.motion"],
2428 c: "`kui_env_set_system(motion)`",
2429 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.",
2430 },
2431 EnvField {
2432 name: "system.locale",
2433 get: |f| {
2434 f.env
2435 .system
2436 .locale
2437 .map_or(Value::Null, |l| Value::str(l.as_str()))
2438 },
2439 from: "`SystemEnv::locale`",
2440 node: &["system.locale"],
2441 lua: &["system.locale"],
2442 c: "`kui_env_set_system(locale)`",
2443 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.",
2444 },
2445 EnvField {
2446 name: "system.assistive",
2447 get: |f| Value::str(f.env.system.assistive.name()),
2448 from: "`SystemEnv::assistive`",
2449 node: &["system.assistive"],
2450 lua: &["system.assistive"],
2451 c: "`kui_env_set_assistive(assistive)`",
2452 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.",
2453 },
2454 EnvField {
2455 name: "window.id",
2456 get: |f| Value::Int(f.env.window.id.0 as i64),
2457 from: "`WindowEnv::id`",
2458 node: &["window.id"],
2459 lua: &["window.id"],
2460 c: "`kui_env_set_window(window)`, read back by `kui_ctx_window`",
2461 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.",
2462 },
2463 EnvField {
2464 name: "window.custom_chrome",
2465 get: |f| Value::Bool(f.env.window.custom_chrome),
2466 from: "`WindowEnv::custom_chrome`",
2467 node: &["window.customChrome"],
2468 lua: &["window.custom_chrome"],
2469 c: "`kui_env_set_window(custom_chrome)`",
2470 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.",
2471 },
2472 EnvField {
2473 name: "window.maximized",
2474 get: |f| Value::Bool(f.env.window.maximized),
2475 from: "`WindowEnv::maximized`",
2476 node: &["window.maximized"],
2477 lua: &["window.maximized"],
2478 c: "`kui_env_set_window(maximized)`",
2479 doc: "The window is maximized — what picks the restore glyph over the maximize one.",
2480 },
2481 EnvField {
2482 name: "window.fullscreen",
2483 get: |f| Value::Bool(f.env.window.fullscreen),
2484 from: "`WindowEnv::fullscreen`",
2485 node: &["window.fullscreen"],
2486 lua: &["window.fullscreen"],
2487 c: "`kui_env_set_window(fullscreen)`",
2488 doc: "The window is fullscreen.",
2489 },
2490 EnvField {
2491 name: "window.always_on_top",
2492 get: |f| Value::Bool(f.env.window.always_on_top),
2493 from: "`WindowEnv::always_on_top`",
2494 node: &["window.alwaysOnTop"],
2495 lua: &["window.always_on_top"],
2496 c: "`kui_env_set_always_on_top(always_on_top)`",
2497 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.",
2498 },
2499 EnvField {
2500 name: "window.native_controls",
2501 get: |f| f.env.window.native_controls.map_or(Value::Null, rect_value),
2502 from: "`WindowEnv::native_controls`",
2503 node: &["window.nativeControls"],
2504 lua: &["window.controls_w", "window.controls_h"],
2505 c: "`kui_env_set_window(controls_w, controls_h)`",
2506 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.",
2507 },
2508 EnvField {
2509 name: "audio.device",
2510 get: |f| Value::str(f.env.audio.device.name()),
2511 from: "`AudioEnv::device`",
2512 node: &["audio.device"],
2513 lua: &["audio.device"],
2514 c: "`kui_env_set_audio(device)`",
2515 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.",
2516 },
2517 EnvField {
2518 name: "audio.live",
2519 get: |f| Value::Int(f.env.audio.live as i64),
2520 from: "`AudioEnv::live`",
2521 node: &["audio.live"],
2522 lua: &["audio.live"],
2523 c: "`kui_env_set_audio(live)`",
2524 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).",
2525 },
2526 EnvField {
2527 name: "viewport.w",
2528 get: |f| Value::Float(f.viewport.w as f64),
2529 from: "`Core::viewport()`, the frame's",
2530 node: &["viewport.width"],
2531 lua: &["viewport_w"],
2532 c: "`kui_frame_begin(w)`",
2533 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.",
2534 },
2535 EnvField {
2536 name: "viewport.h",
2537 get: |f| Value::Float(f.viewport.h as f64),
2538 from: "`Core::viewport()`, the frame's",
2539 node: &["viewport.height"],
2540 lua: &["viewport_h"],
2541 c: "`kui_frame_begin(h)`",
2542 doc: "Its logical height.",
2543 },
2544 EnvField {
2545 name: "scale",
2546 get: |f| Value::Float(f.scale as f64),
2547 from: "`Core::scale()`, the frame's",
2548 node: &["viewport.scale"],
2549 lua: &[],
2550 c: "`kui_frame_begin(scale)`",
2551 doc: "Device pixels per logical px. Lua has no reading: a script sees logical px only.",
2552 },
2553 EnvField {
2554 name: "focus",
2555 get: |f| key_value(f.focus),
2556 from: "`Core::focus()`, the frame's",
2557 node: &[],
2558 lua: &["focus"],
2559 c: "`kui_focused()`",
2560 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`.",
2561 },
2562 EnvField {
2563 name: "focus_visible",
2564 get: |f| Value::Bool(f.focus_visible),
2565 from: "`Core::focus_visible()`, the frame's",
2566 node: &[],
2567 lua: &["focus_visible"],
2568 c: "`kui_focus_visible()`",
2569 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.",
2570 },
2571 EnvField {
2572 name: "caret_visible",
2573 get: |f| Value::Bool(f.caret_visible),
2574 from: "`Core::caret_visible()`, the frame's",
2575 node: &[],
2576 lua: &["caret_visible"],
2577 c: "`kui_caret_visible()`",
2578 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).",
2579 },
2580 EnvField {
2581 name: "region",
2582 get: |f| key_value(f.region),
2583 from: "`Core::region()`, the frame's",
2584 node: &[],
2585 lua: &["region"],
2586 c: "`kui_region()`",
2587 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`.",
2588 },
2589];
2590
2591pub struct ThemeRole {
2602 pub name: &'static str,
2604 pub node: &'static str,
2606 pub doc: &'static str,
2607 pub get: fn(&crate::theme::Theme) -> crate::color::Color,
2609 pub set: fn(&mut crate::theme::Theme, crate::color::Color),
2612}
2613
2614pub const THEME_ROLES: &[ThemeRole] = &[
2615 ThemeRole {
2616 name: "bg",
2617 node: "bg",
2618 get: |t| t.bg,
2619 set: |t, c| t.bg = c,
2620 doc: "The window behind everything.",
2621 },
2622 ThemeRole {
2623 name: "surface",
2624 node: "surface",
2625 get: |t| t.surface,
2626 set: |t, c| t.surface = c,
2627 doc: "A card, panel or list sitting on `bg`.",
2628 },
2629 ThemeRole {
2630 name: "raised",
2631 node: "raised",
2632 get: |t| t.raised,
2633 set: |t, c| t.raised = c,
2634 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.",
2635 },
2636 ThemeRole {
2637 name: "sunken",
2638 node: "sunken",
2639 get: |t| t.sunken,
2640 set: |t, c| t.sunken = c,
2641 doc: "A well cut into a surface: a text field, a code block, a track.",
2642 },
2643 ThemeRole {
2644 name: "border",
2645 node: "border",
2646 get: |t| t.border,
2647 set: |t, c| t.border = c,
2648 doc: "The hairline between two surfaces.",
2649 },
2650 ThemeRole {
2651 name: "border_strong",
2652 node: "borderStrong",
2653 get: |t| t.border_strong,
2654 set: |t, c| t.border_strong = c,
2655 doc: "A border that has to be seen — a float's edge, a focused field.",
2656 },
2657 ThemeRole {
2658 name: "fg",
2659 node: "fg",
2660 get: |t| t.fg,
2661 set: |t, c| t.fg = c,
2662 doc: "Body text, and what a `color`-less text run resolves to.",
2663 },
2664 ThemeRole {
2665 name: "muted",
2666 node: "muted",
2667 get: |t| t.muted,
2668 set: |t, c| t.muted = c,
2669 doc: "Secondary text: captions, hints, an accelerator beside a label.",
2670 },
2671 ThemeRole {
2672 name: "faint",
2673 node: "faint",
2674 get: |t| t.faint,
2675 set: |t, c| t.faint = c,
2676 doc: "Text that is barely there: a placeholder, a gutter number.",
2677 },
2678 ThemeRole {
2679 name: "accent",
2680 node: "accent",
2681 get: |t| t.accent,
2682 set: |t, c| t.accent = c,
2683 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.",
2684 },
2685 ThemeRole {
2686 name: "accent_hover",
2687 node: "accentHover",
2688 get: |t| t.accent_hover,
2689 set: |t, c| t.accent_hover = c,
2690 doc: "`accent` under a pointer.",
2691 },
2692 ThemeRole {
2693 name: "accent_pressed",
2694 node: "accentPressed",
2695 get: |t| t.accent_pressed,
2696 set: |t, c| t.accent_pressed = c,
2697 doc: "`accent` under a press.",
2698 },
2699 ThemeRole {
2700 name: "on_accent",
2701 node: "onAccent",
2702 get: |t| t.on_accent,
2703 set: |t, c| t.on_accent = c,
2704 doc: "Black or white — whichever a reader can see on `accent`. What a button's label is.",
2705 },
2706 ThemeRole {
2707 name: "accent_soft",
2708 node: "accentSoft",
2709 get: |t| t.accent_soft,
2710 set: |t, c| t.accent_soft = c,
2711 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.",
2712 },
2713 ThemeRole {
2714 name: "selection",
2715 node: "selection",
2716 get: |t| t.selection,
2717 set: |t, c| t.selection = c,
2718 doc: "What a text selection is painted under, in an editor and over a `selectable` scope alike.",
2719 },
2720 ThemeRole {
2721 name: "focus_ring",
2722 node: "focusRing",
2723 get: |t| t.focus_ring,
2724 set: |t, c| t.focus_ring = c,
2725 doc: "The default keyboard focus ring (ADR 0002).",
2726 },
2727 ThemeRole {
2728 name: "hover",
2729 node: "hover",
2730 get: |t| t.hover,
2731 set: |t, c| t.hover = c,
2732 doc: "A translucent wash over a hovered neutral control. An overlay, not a fill, so one value works on every surface.",
2733 },
2734 ThemeRole {
2735 name: "pressed",
2736 node: "pressed",
2737 get: |t| t.pressed,
2738 set: |t, c| t.pressed = c,
2739 doc: "The same over a pressed one, and the firmer of the two on both bases.",
2740 },
2741 ThemeRole {
2742 name: "success",
2743 node: "success",
2744 get: |t| t.success,
2745 set: |t, c| t.success = c,
2746 doc: "A good outcome. Readable on `surface` on both bases, which is why it is not one colour for both.",
2747 },
2748 ThemeRole {
2749 name: "warning",
2750 node: "warning",
2751 get: |t| t.warning,
2752 set: |t, c| t.warning = c,
2753 doc: "Something that wants attention.",
2754 },
2755 ThemeRole {
2756 name: "danger",
2757 node: "danger",
2758 get: |t| t.danger,
2759 set: |t, c| t.danger = c,
2760 doc: "A destructive action or a failure. The close button's hover, too.",
2761 },
2762 ThemeRole {
2763 name: "scrollbar",
2764 node: "scrollbar",
2765 get: |t| t.scrollbar,
2766 set: |t, c| t.scrollbar = c,
2767 doc: "The scrollbar thumb at rest.",
2768 },
2769 ThemeRole {
2770 name: "scrollbar_active",
2771 node: "scrollbarActive",
2772 get: |t| t.scrollbar_active,
2773 set: |t, c| t.scrollbar_active = c,
2774 doc: "The thumb while hovered or dragged.",
2775 },
2776];
2777
2778pub struct MetricRole {
2783 pub name: &'static str,
2785 pub node: &'static str,
2787 pub doc: &'static str,
2788 pub get: fn(&crate::metrics::Metrics) -> f32,
2789 pub set: fn(&mut crate::metrics::Metrics, f32),
2790 pub platform: Option<PlatformValue>,
2797}
2798
2799#[derive(Clone, Copy, Debug, PartialEq)]
2801pub struct PlatformValue {
2802 pub windows: f32,
2803 pub elsewhere: f32,
2804}
2805
2806impl PlatformValue {
2807 pub const fn here(self) -> f32 {
2809 if cfg!(target_os = "windows") {
2810 self.windows
2811 } else {
2812 self.elsewhere
2813 }
2814 }
2815}
2816
2817macro_rules! metric_role {
2818 ($field:ident, $node:literal, $doc:literal) => {
2819 MetricRole {
2820 name: stringify!($field),
2821 node: $node,
2822 get: |m| m.$field,
2823 set: |m, v| m.$field = v,
2824 doc: $doc,
2825 platform: None,
2826 }
2827 };
2828 ($field:ident, $node:literal, $doc:literal, windows $w:expr, elsewhere $e:expr) => {
2829 MetricRole {
2830 name: stringify!($field),
2831 node: $node,
2832 get: |m| m.$field,
2833 set: |m, v| m.$field = v,
2834 doc: $doc,
2835 platform: Some(PlatformValue {
2836 windows: $w,
2837 elsewhere: $e,
2838 }),
2839 }
2840 };
2841}
2842
2843pub const METRIC_ROLES: &[MetricRole] = &[
2844 metric_role!(
2845 control_text,
2846 "controlText",
2847 "A stock control's label: the button's text size."
2848 ),
2849 metric_role!(
2850 chrome_text,
2851 "chromeText",
2852 "The chrome's text: a menu row, a menu-bar title, the titlebar's title."
2853 ),
2854 metric_role!(hint_text, "hintText", "A tooltip's text."),
2855 metric_role!(
2856 radius,
2857 "radius",
2858 "The corner of every stock surface: a button, a field, a menu, a tooltip."
2859 ),
2860 metric_role!(
2861 radius_inner,
2862 "radiusInner",
2863 "The corner of a row inside one: a menu row, a menu-bar title."
2864 ),
2865 metric_role!(
2866 control_pad_x,
2867 "controlPadX",
2868 "A button's horizontal padding."
2869 ),
2870 metric_role!(control_pad_y, "controlPadY", "A button's vertical padding."),
2871 metric_role!(
2872 field_pad_x,
2873 "fieldPadX",
2874 "A text field's horizontal padding."
2875 ),
2876 metric_role!(field_pad_y, "fieldPadY", "A text field's vertical padding."),
2877 metric_role!(hint_pad_x, "hintPadX", "A tooltip's horizontal padding."),
2878 metric_role!(hint_pad_y, "hintPadY", "A tooltip's vertical padding."),
2879 metric_role!(
2880 menu_pad_x,
2881 "menuPadX",
2882 "A menu row's horizontal padding, and a menu-bar title's."
2883 ),
2884 metric_role!(
2885 menu_pad_y,
2886 "menuPadY",
2887 "A menu row's vertical padding; a menu-bar title's is two px less."
2888 ),
2889 metric_role!(menu_width, "menuWidth", "A menu panel's width."),
2890 metric_role!(menu_bar_h, "menuBarH", "The drawn menu bar's height."),
2891 metric_role!(
2892 titlebar_h,
2893 "titlebarH",
2894 "The titlebar's height where the strip is the app's alone: the platform's caption height, 32 on Windows and 34 elsewhere. Under macOS custom chrome the strip is the OS's own titlebar, as tall as `window.native_controls` measures it (32 on macOS 27, 28 before), and this row is not read (`widgets::titlebar_height`).",
2895 windows crate::metrics::TITLEBAR_H_WINDOWS,
2896 elsewhere crate::metrics::TITLEBAR_H_ELSEWHERE
2897 ),
2898];
2899
2900static SNAKE_NAMES: LazyLock<Vec<&'static str>> = LazyLock::new(|| {
2901 PROPS
2902 .iter()
2903 .map(|d| Box::leak(snake_case(d.name).into_boxed_str()) as &'static str)
2904 .collect()
2905});
2906
2907pub fn snake_case(name: &str) -> String {
2910 let mut out = String::with_capacity(name.len() + 2);
2911 let mut prev_upper = false;
2912 for c in name.chars() {
2913 if c.is_ascii_uppercase() {
2914 if !prev_upper {
2915 out.push('_');
2916 }
2917 out.push(c.to_ascii_lowercase());
2918 prev_upper = true;
2919 } else {
2920 out.push(c);
2921 prev_upper = false;
2922 }
2923 }
2924 out
2925}
2926
2927pub fn by_name(name: &str) -> Option<&'static PropDef> {
2928 PROPS.iter().find(|d| d.name == name)
2929}
2930
2931pub fn by_snake_name(name: &str) -> Option<&'static PropDef> {
2932 SNAKE_NAMES
2933 .iter()
2934 .position(|n| *n == name)
2935 .map(|i| &PROPS[i])
2936}
2937
2938pub fn by_id(id: u32) -> Option<&'static PropDef> {
2939 PROPS.iter().find(|d| d.id == id)
2940}
2941
2942#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2947pub enum Spelling {
2948 Camel,
2949 Snake,
2950}
2951
2952pub const LUA_ALIASES: &[(&str, &str)] = &[("direction", "repeat")];
2957
2958pub fn lua_alias(name: &str) -> Option<&'static str> {
2961 LUA_ALIASES
2962 .iter()
2963 .find(|(alias, _)| *alias == name)
2964 .map(|(_, real)| *real)
2965}
2966
2967static SHARED_NAMES: LazyLock<[FxHashSet<&'static str>; 2]> = LazyLock::new(|| {
2970 let mut camel: FxHashSet<&'static str> = PROPS.iter().map(|d| d.name).collect();
2971 let mut snake: FxHashSet<&'static str> = PROPS.iter().map(|d| d.snake_name()).collect();
2972 for c in CUSTOM {
2973 camel.extend(c.jsx_names);
2974 snake.extend(c.lua_names);
2975 }
2976 snake.extend(LUA_ALIASES.iter().map(|(alias, _)| *alias));
2977 [camel, snake]
2978});
2979
2980fn shared_names(spelling: Spelling) -> &'static FxHashSet<&'static str> {
2981 &SHARED_NAMES[(spelling == Spelling::Snake) as usize]
2982}
2983
2984pub fn element_own(element: &str, spelling: Spelling) -> &'static [&'static str] {
2987 match ELEMENTS.iter().find(|e| e.name == element) {
2988 Some(e) if spelling == Spelling::Camel => e.jsx_own,
2989 Some(e) => e.lua_own,
2990 None => &[],
2991 }
2992}
2993
2994pub fn element_rows(element: &str, spelling: Spelling) -> Option<&'static [&'static str]> {
2998 let e = ELEMENTS.iter().find(|e| e.name == element)?;
2999 if spelling == Spelling::Camel {
3000 e.jsx_rows
3001 } else {
3002 e.lua_rows
3003 }
3004}
3005
3006pub fn shared_prop(name: &str, spelling: Spelling) -> bool {
3012 shared_names(spelling).contains(name)
3013}
3014
3015pub fn known_prop(element: &str, name: &str, spelling: Spelling) -> bool {
3020 if element_own(element, spelling).contains(&name) {
3021 return true;
3022 }
3023 match element_rows(element, spelling) {
3024 Some(rows) => rows.contains(&name),
3025 None => shared_names(spelling).contains(name),
3026 }
3027}
3028
3029pub fn suggest(element: &str, name: &str, spelling: Spelling) -> Option<&'static str> {
3034 let squash = |s: &str| s.replace('_', "").to_ascii_lowercase();
3035 let want = squash(name);
3036 let near = |c: &&&str| squash(c) == want;
3037 let own = element_own(element, spelling).iter();
3038 match element_rows(element, spelling) {
3040 Some(rows) => rows.iter().chain(own).find(near).copied(),
3041 None => shared_names(spelling).iter().chain(own).find(near).copied(),
3042 }
3043}
3044
3045pub enum Parsed {
3047 F32(f32),
3048 Color(Color),
3049 Flag,
3050 Enum(usize),
3051 Sizing(Sizing),
3052 Bound(Bound),
3054 Msg(Value),
3055 Str(String),
3056 Resource(u64),
3057 Keyframes(Vec<Keyframe>),
3058 Enter(Enter),
3059 Gradient(crate::gradient::Gradient),
3060 Family(FontFamily),
3062}
3063
3064#[derive(Clone, Debug, PartialEq)]
3066pub struct PropsOut {
3067 pub spec: NodeSpec,
3068 pub style: TextStyle,
3069 pub key: Option<String>,
3070 pub index: Option<u64>,
3073 pub row_count: Option<u64>,
3076 pub title: Option<String>,
3077 pub always_on_top: bool,
3080 pub secure_input: bool,
3083 pub option_as_alt: crate::OptionAsAlt,
3086 pub key_focus: bool,
3087 pub tooltip: Option<String>,
3090 pub windows: Vec<(String, WindowConfig)>,
3092 pub wrap: bool,
3097}
3098
3099#[derive(Clone, Copy, Debug, PartialEq)]
3103pub enum Identity<'a> {
3104 Auto,
3105 Label(&'a str),
3106 Index(u64),
3107}
3108
3109impl PropsOut {
3110 pub fn identity(&self) -> Identity<'_> {
3112 match (self.index, &self.key) {
3113 (Some(i), _) => Identity::Index(i),
3114 (None, Some(label)) => Identity::Label(label),
3115 (None, None) => Identity::Auto,
3116 }
3117 }
3118
3119 pub fn new() -> Self {
3120 PropsOut {
3121 spec: NodeSpec::column(),
3122 style: TextStyle::new(16.0),
3123 key: None,
3124 index: None,
3125 row_count: None,
3126 title: None,
3127 always_on_top: false,
3128 secure_input: false,
3129 option_as_alt: crate::OptionAsAlt::None,
3130 key_focus: false,
3131 tooltip: None,
3132 windows: Vec::new(),
3133 wrap: false,
3134 }
3135 }
3136
3137 pub fn with_spec(&mut self, f: impl FnOnce(NodeSpec) -> NodeSpec) {
3139 self.spec = f(std::mem::take(&mut self.spec));
3140 }
3141
3142 pub fn apply_tooltip(&mut self, hint: impl Into<String>) {
3147 let hint = hint.into();
3148 self.with_spec(|s| s.apply_tooltip(&hint));
3149 self.tooltip = Some(hint);
3150 }
3151
3152 pub fn apply_pad(&mut self, pad: PadShorthand) {
3156 if pad.declared() {
3157 let edges = pad.resolve();
3158 self.with_spec(|s| s.padding(edges));
3159 }
3160 }
3161}
3162
3163impl Default for PropsOut {
3164 fn default() -> Self {
3165 Self::new()
3166 }
3167}
3168
3169pub fn apply(def: &PropDef, value: Parsed, out: &mut PropsOut) -> Result<(), String> {
3173 let spec = std::mem::take(&mut out.spec);
3174 let style = out.style;
3175 out.wrap |= def.id == P_WRAP;
3178 match (&def.apply, value) {
3179 (Apply::SpecF32(f), Parsed::F32(v)) => out.spec = f(spec, v),
3180 (Apply::SpecColor(f), Parsed::Color(v)) => out.spec = f(spec, v),
3181 (Apply::SpecFlag(f), Parsed::Flag) => out.spec = f(spec),
3182 (Apply::SpecEnum(f), Parsed::Enum(v)) => out.spec = f(spec, v),
3183 (Apply::SpecSizing(f), Parsed::Sizing(v)) => out.spec = f(spec, v),
3184 (Apply::SpecBound(f), Parsed::Bound(v)) => out.spec = f(spec, v),
3185 (Apply::SpecMsg(f), Parsed::Msg(v)) => out.spec = f(spec, v),
3186 (Apply::SpecStr(f), Parsed::Str(v)) => out.spec = f(spec, &v),
3187 (Apply::SpecKeyframes(f), Parsed::Keyframes(v)) => out.spec = f(spec, v),
3188 (Apply::SpecEnter(f), Parsed::Enter(v)) => out.spec = f(spec, v),
3189 (Apply::SpecGradient(f), Parsed::Gradient(v)) => out.spec = f(spec, v),
3190 (Apply::SpecResource(f), Parsed::Resource(v)) => out.spec = f(spec, v),
3191 (Apply::StyleF32(f), Parsed::F32(v)) => {
3192 out.spec = spec;
3193 out.style = f(style, v);
3194 }
3195 (Apply::StyleColor(f), Parsed::Color(v)) => {
3196 out.spec = spec;
3197 out.style = f(style, v);
3198 }
3199 (Apply::StyleEnum(f), Parsed::Enum(v)) => {
3200 out.spec = spec;
3201 out.style = f(style, v);
3202 }
3203 (Apply::StyleFlag(f), Parsed::Flag) => {
3204 out.spec = spec;
3205 out.style = f(style);
3206 }
3207 (Apply::StyleResource(f), Parsed::Resource(v)) => {
3208 out.spec = spec;
3209 out.style = f(style, v);
3210 }
3211 (Apply::StyleStr(f), Parsed::Str(v)) => {
3212 out.spec = spec;
3213 out.style = f(style, &v);
3214 }
3215 (Apply::StyleFamily(f), Parsed::Family(v)) => {
3216 out.spec = spec;
3217 out.style = f(style, v);
3218 }
3219 _ => {
3220 out.spec = spec;
3221 return Err(format!("prop {} value/kind mismatch", def.name));
3222 }
3223 }
3224 Ok(())
3225}
3226
3227pub fn enum_index(names: &[&str], s: &str) -> Result<usize, String> {
3229 names
3230 .iter()
3231 .position(|n| *n == s)
3232 .ok_or_else(|| format!("bad value {s:?} (one of {names:?})"))
3233}
3234
3235pub fn color_num(hex: u32) -> Color {
3240 if hex == 0 {
3241 Color::TRANSPARENT
3242 } else {
3243 Color::hex(hex)
3244 }
3245}
3246
3247pub fn color_hex_str(s: &str) -> Result<Color, String> {
3249 let bad = || format!("bad color {s:?}");
3250 let hex = s.strip_prefix('#').ok_or_else(bad)?;
3251 let expanded = match hex.len() {
3252 3 => hex
3253 .chars()
3254 .flat_map(|c| [c, c])
3255 .chain("ff".chars())
3256 .collect::<String>(),
3257 6 => format!("{hex}ff"),
3258 8 => hex.to_string(),
3259 _ => return Err(bad()),
3260 };
3261 let n = u32::from_str_radix(&expanded, 16).map_err(|_| bad())?;
3262 Ok(Color::hex(n))
3263}
3264
3265pub const SIZE_MODE_CALC: u32 = 4;
3268
3269pub const SIZE_MODE_TREE: u32 = 5;
3274
3275pub fn min_str(s: &str) -> Result<Bound, String> {
3278 match s {
3279 "fit" => Ok(Bound::Fit),
3280 _ => crate::calc::bound(s)
3281 .map_err(|e| format!("bad min {s:?} (number | \"fit\" | a size expression): {e}")),
3282 }
3283}
3284
3285pub fn max_str(s: &str) -> Result<Bound, String> {
3287 crate::calc::bound(s).map_err(|e| format!("bad max {s:?} (number | a size expression): {e}"))
3288}
3289
3290pub fn sizing_str(s: &str) -> Result<Sizing, String> {
3293 match s {
3294 "fit" => Ok(Sizing::Fit),
3295 "grow" => Ok(Sizing::Grow(1.0)),
3296 _ => crate::calc::sizing(s).map_err(|e| {
3297 format!("bad sizing {s:?} (fit | grow | number | \"N%\" | a size expression): {e}")
3298 }),
3299 }
3300}
3301
3302#[cfg(test)]
3303mod tests {
3304 use super::*;
3305
3306 #[test]
3313 fn every_enum_list_is_its_enum_s_all_by_name() {
3314 fn names(it: &[&'static str]) -> Vec<&'static str> {
3315 it.to_vec()
3316 }
3317 assert_eq!(
3318 Easing::ALL.iter().map(|e| e.name()).collect::<Vec<_>>(),
3319 names(EASINGS)
3320 );
3321 assert_eq!(
3322 Repeat::ALL.iter().map(|r| r.name()).collect::<Vec<_>>(),
3323 names(REPEATS)
3324 );
3325 assert_eq!(
3326 crate::access::Live::ALL
3327 .iter()
3328 .map(|l| l.name())
3329 .collect::<Vec<_>>(),
3330 names(LIVE)
3331 );
3332 assert_eq!(
3333 FontFamily::ALL
3334 .iter()
3335 .map(|f| f.name().expect("a stock family has a name"))
3336 .collect::<Vec<_>>(),
3337 names(FAMILIES)
3338 );
3339 for (i, e) in Easing::ALL.iter().enumerate() {
3341 assert_eq!(easing_idx(i), *e);
3342 }
3343 for (i, r) in Repeat::ALL.iter().enumerate() {
3344 assert_eq!(repeat_idx(i), *r);
3345 }
3346 for (i, l) in crate::access::Live::ALL.iter().enumerate() {
3347 assert_eq!(crate::access::Live::from_index(i), *l);
3348 }
3349 for (i, f) in FontFamily::ALL.iter().enumerate() {
3350 assert_eq!(FontFamily::from_index(i), *f);
3351 }
3352 assert_eq!(easing_idx(99), Easing::default());
3354 assert_eq!(repeat_idx(99), Repeat::default());
3355 assert_eq!(FontFamily::from_index(99), FontFamily::Sans);
3356 }
3357
3358 #[test]
3359 fn ids_and_names_are_unique() {
3360 let all: Vec<(&str, u32)> = PROPS
3361 .iter()
3362 .map(|d| (d.name, d.id))
3363 .chain(CUSTOM.iter().map(|c| (c.name, c.id)))
3364 .collect();
3365 for (i, (name, id)) in all.iter().enumerate() {
3366 for (other_name, other_id) in &all[i + 1..] {
3367 assert_ne!(name, other_name, "duplicate prop name");
3368 assert_ne!(id, other_id, "duplicate wire id for {name} / {other_name}");
3369 }
3370 }
3371 }
3372
3373 fn snake_to_camel(name: &str) -> String {
3375 let mut out = String::new();
3376 let mut up = false;
3377 for ch in name.chars() {
3378 if ch == '_' {
3379 up = true;
3380 } else if up {
3381 out.extend(ch.to_uppercase());
3382 up = false;
3383 } else {
3384 out.push(ch);
3385 }
3386 }
3387 out
3388 }
3389
3390 #[test]
3394 fn metric_roles_restate_the_metrics_exactly() {
3395 use crate::metrics::Metrics;
3396 let m = Metrics::compact();
3397 let Metrics {
3398 control_text,
3399 chrome_text,
3400 hint_text,
3401 radius,
3402 radius_inner,
3403 control_pad_x,
3404 control_pad_y,
3405 field_pad_x,
3406 field_pad_y,
3407 hint_pad_x,
3408 hint_pad_y,
3409 menu_pad_x,
3410 menu_pad_y,
3411 menu_width,
3412 menu_bar_h,
3413 titlebar_h,
3414 } = m;
3415 let fields: &[(&str, f32)] = &[
3416 ("control_text", control_text),
3417 ("chrome_text", chrome_text),
3418 ("hint_text", hint_text),
3419 ("radius", radius),
3420 ("radius_inner", radius_inner),
3421 ("control_pad_x", control_pad_x),
3422 ("control_pad_y", control_pad_y),
3423 ("field_pad_x", field_pad_x),
3424 ("field_pad_y", field_pad_y),
3425 ("hint_pad_x", hint_pad_x),
3426 ("hint_pad_y", hint_pad_y),
3427 ("menu_pad_x", menu_pad_x),
3428 ("menu_pad_y", menu_pad_y),
3429 ("menu_width", menu_width),
3430 ("menu_bar_h", menu_bar_h),
3431 ("titlebar_h", titlebar_h),
3432 ];
3433 assert_eq!(METRIC_ROLES.len(), fields.len(), "a metric has no row");
3434 for (name, value) in fields {
3435 let row = METRIC_ROLES
3436 .iter()
3437 .find(|r| r.name == *name)
3438 .unwrap_or_else(|| panic!("no METRIC_ROLES row for {name}"));
3439 assert_eq!((row.get)(&m), *value, "{name}'s row reads another field");
3440 let mut w = m;
3441 (row.set)(&mut w, 1.0);
3442 assert_eq!((row.get)(&w), 1.0, "{name}'s row writes another field");
3443 }
3444 for row in METRIC_ROLES {
3445 assert!(
3446 fields.iter().any(|(n, _)| *n == row.name),
3447 "METRIC_ROLES names a field Metrics does not have: {}",
3448 row.name
3449 );
3450 let camel = snake_to_camel(row.name);
3451 assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3452 if let Some(p) = row.platform {
3456 assert_eq!(
3457 (row.get)(&Metrics::default()),
3458 p.here(),
3459 "{}'s stock value",
3460 row.name
3461 );
3462 assert_eq!(
3463 (row.get)(&m),
3464 p.here(),
3465 "{}: compact leaves a platform row alone",
3466 row.name
3467 );
3468 }
3469 }
3470 assert!(
3471 METRIC_ROLES.iter().any(|r| r.platform.is_some()),
3472 "titlebar_h is the platform's; its row says so"
3473 );
3474 }
3475
3476 #[test]
3484 fn theme_roles_restate_the_theme_exactly() {
3485 use crate::theme::Theme;
3486 let t = Theme::dark();
3487 let Theme {
3488 appearance: _,
3489 disabled_opacity: _,
3490 bg,
3491 surface,
3492 raised,
3493 sunken,
3494 border,
3495 border_strong,
3496 fg,
3497 muted,
3498 faint,
3499 accent,
3500 accent_hover,
3501 accent_pressed,
3502 on_accent,
3503 accent_soft,
3504 selection,
3505 focus_ring,
3506 hover,
3507 pressed,
3508 success,
3509 warning,
3510 danger,
3511 scrollbar,
3512 scrollbar_active,
3513 } = t;
3514 let fields: &[(&str, crate::color::Color)] = &[
3515 ("bg", bg),
3516 ("surface", surface),
3517 ("raised", raised),
3518 ("sunken", sunken),
3519 ("border", border),
3520 ("border_strong", border_strong),
3521 ("fg", fg),
3522 ("muted", muted),
3523 ("faint", faint),
3524 ("accent", accent),
3525 ("accent_hover", accent_hover),
3526 ("accent_pressed", accent_pressed),
3527 ("on_accent", on_accent),
3528 ("accent_soft", accent_soft),
3529 ("selection", selection),
3530 ("focus_ring", focus_ring),
3531 ("hover", hover),
3532 ("pressed", pressed),
3533 ("success", success),
3534 ("warning", warning),
3535 ("danger", danger),
3536 ("scrollbar", scrollbar),
3537 ("scrollbar_active", scrollbar_active),
3538 ];
3539 assert_eq!(THEME_ROLES.len(), fields.len(), "a role has no row");
3540 for (name, value) in fields {
3541 let row = THEME_ROLES
3542 .iter()
3543 .find(|r| r.name == *name)
3544 .unwrap_or_else(|| panic!("no THEME_ROLES row for {name}"));
3545 assert_eq!((row.get)(&t), *value, "{name}'s row reads another field");
3546 }
3547 for row in THEME_ROLES {
3548 assert!(
3549 fields.iter().any(|(n, _)| *n == row.name),
3550 "{} names no field",
3551 row.name
3552 );
3553 let camel = {
3555 let mut out = String::new();
3556 let mut up = false;
3557 for ch in row.name.chars() {
3558 if ch == '_' {
3559 up = true;
3560 } else if up {
3561 out.extend(ch.to_uppercase());
3562 up = false;
3563 } else {
3564 out.push(ch);
3565 }
3566 }
3567 out
3568 };
3569 assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3570 }
3571 }
3572
3573 #[test]
3580 fn env_fields_restate_env_and_window_env_exactly() {
3581 use crate::env::{AudioEnv, Env, SystemEnv};
3582 use crate::window::WindowEnv;
3583 let Env {
3584 refresh_hz: _,
3585 focused: _,
3586 system,
3587 window,
3588 audio,
3589 } = Env::default();
3590 let AudioEnv { device: _, live: _ } = audio;
3591 let SystemEnv {
3592 appearance: _,
3593 accent: _,
3594 motion: _,
3595 locale: _,
3596 assistive: _,
3597 } = system;
3598 let WindowEnv {
3599 id: _,
3600 custom_chrome: _,
3601 maximized: _,
3602 fullscreen: _,
3603 always_on_top: _,
3604 native_controls: _,
3605 } = window;
3606 let stored = [
3607 "refresh_hz",
3608 "focused",
3609 "system.appearance",
3610 "system.accent",
3611 "system.motion",
3612 "system.locale",
3613 "system.assistive",
3614 "window.id",
3615 "window.custom_chrome",
3616 "window.maximized",
3617 "window.fullscreen",
3618 "window.always_on_top",
3619 "window.native_controls",
3620 "audio.device",
3621 "audio.live",
3622 ];
3623 let from_structs: Vec<&str> = ENV_FIELDS
3626 .iter()
3627 .filter(|f| !f.from.contains('('))
3628 .map(|f| {
3629 let (strukt, field) = match f.name.split_once('.') {
3630 Some(("window", field)) => ("WindowEnv", field),
3631 Some(("system", field)) => ("SystemEnv", field),
3632 Some(("audio", field)) => ("AudioEnv", field),
3633 Some((group, _)) => panic!("{}: no struct holds a {group} fact", f.name),
3634 None => ("Env", f.name),
3635 };
3636 assert_eq!(f.from, format!("`{strukt}::{field}`"), "{}", f.name);
3637 f.name
3638 })
3639 .collect();
3640 assert_eq!(from_structs, stored);
3641 for f in ENV_FIELDS.iter().filter(|f| f.from.contains('(')) {
3642 assert!(
3643 f.from.contains("derived") || f.from.contains("the frame's"),
3644 "{}: a call in `from` is derived or the frame's, and says which",
3645 f.name
3646 );
3647 }
3648 }
3649
3650 #[test]
3654 fn env_field_spellings_are_unique_and_complete() {
3655 let mut names: Vec<&str> = ENV_FIELDS.iter().map(|f| f.name).collect();
3656 let mut node: Vec<&str> = ENV_FIELDS
3657 .iter()
3658 .flat_map(|f| f.node.iter().copied())
3659 .collect();
3660 let mut lua: Vec<&str> = ENV_FIELDS
3661 .iter()
3662 .flat_map(|f| f.lua.iter().copied())
3663 .collect();
3664 for list in [&mut names, &mut node, &mut lua] {
3665 let before = list.len();
3666 list.sort_unstable();
3667 list.dedup();
3668 assert_eq!(list.len(), before, "a spelling is used twice");
3669 }
3670 for f in ENV_FIELDS {
3671 assert!(!f.c.is_empty() && !f.doc.is_empty(), "{}", f.name);
3672 if f.node.is_empty() {
3675 assert!(
3676 f.doc.contains("Node"),
3677 "{}: where does Node carry it?",
3678 f.name
3679 );
3680 }
3681 if f.lua.is_empty() {
3682 assert!(
3683 f.doc.contains("Lua"),
3684 "{}: where does Lua carry it?",
3685 f.name
3686 );
3687 }
3688 }
3689 }
3690
3691 #[test]
3695 fn admitted_rows_are_shared_rows_in_both_spellings() {
3696 for e in ELEMENTS {
3697 let (Some(jsx), Some(lua)) = (e.jsx_rows, e.lua_rows) else {
3698 assert!(
3699 e.jsx_rows.is_none() && e.lua_rows.is_none(),
3700 "{}: one spelling only",
3701 e.name
3702 );
3703 continue;
3704 };
3705 assert_eq!(
3706 jsx.len(),
3707 lua.len(),
3708 "{}: the lists differ in length",
3709 e.name
3710 );
3711 for (j, l) in jsx.iter().zip(lua) {
3712 assert!(
3713 shared_prop(j, Spelling::Camel),
3714 "{}: `{j}` is not a row",
3715 e.name
3716 );
3717 assert!(
3718 shared_prop(l, Spelling::Snake),
3719 "{}: `{l}` is not a row",
3720 e.name
3721 );
3722 assert_eq!(
3723 snake_case(j),
3724 *l,
3725 "{}: `{j}` and `{l}` are not one row",
3726 e.name
3727 );
3728 }
3729 if jsx.contains(&"onClick") {
3734 assert!(jsx.contains(&"label"), "{}: `label` missing", e.name);
3735 }
3736 }
3737 assert!(known_prop("button", "description", Spelling::Camel));
3738 assert!(known_prop("button", "on_click", Spelling::Snake));
3739 assert!(known_prop("button", "text", Spelling::Snake));
3740 assert!(!known_prop("button", "radius", Spelling::Camel));
3741 assert!(!known_prop("button", "text", Spelling::Camel));
3742 assert!(known_prop("box", "radius", Spelling::Camel));
3743 assert_eq!(
3746 suggest("button", "on_click", Spelling::Camel),
3747 Some("onClick")
3748 );
3749 assert_eq!(suggest("button", "hover_bg", Spelling::Camel), None);
3750 assert_eq!(suggest("box", "hover_bg", Spelling::Camel), Some("hoverBg"));
3751 }
3752
3753 #[test]
3759 fn text_admits_exactly_the_style_rows() {
3760 let style: Vec<&str> = PROPS
3761 .iter()
3762 .filter(|d| d.target() == Target::Style)
3763 .map(|d| d.name)
3764 .collect();
3765 let mut expect = vec!["size"];
3766 expect.extend(style);
3767 let mut got = TEXT_ROWS_JSX.to_vec();
3768 expect.sort_unstable();
3769 got.sort_unstable();
3770 assert_eq!(got, expect, "TEXT_ROWS_JSX is not the style rows");
3771 for name in ["lineHeight", "color", "wrap", "size"] {
3772 assert!(known_prop("text", name, Spelling::Camel), "{name}");
3773 }
3774 for name in ["live", "role", "label", "onClick", "key", "pad", "bg"] {
3775 assert_eq!(
3776 known_prop("text", name, Spelling::Camel),
3777 name == "bg",
3778 "{name}: `bg` is the element's own (a span's), the rest are not rows it reads"
3779 );
3780 }
3781 assert!(known_prop("text", "line_height", Spelling::Snake));
3782 assert!(known_prop("text", "value", Spelling::Snake));
3783 assert!(!known_prop("text", "live", Spelling::Snake));
3784 assert!(!known_prop("text", "on_click", Spelling::Snake));
3785 assert_eq!(
3788 suggest("text", "max_lines", Spelling::Camel),
3789 Some("maxLines")
3790 );
3791 assert_eq!(suggest("text", "hover_bg", Spelling::Camel), None);
3792 }
3793
3794 #[test]
3795 fn snake_names_round_trip() {
3796 assert_eq!(by_snake_name("min_width").unwrap().name, "minWidth");
3797 assert_eq!(by_snake_name("on_click").unwrap().name, "onClick");
3798 assert_eq!(by_snake_name("bg").unwrap().name, "bg");
3799 assert!(by_snake_name("minWidth").is_none());
3800 assert_eq!(by_name("lineHeight").unwrap().snake_name(), "line_height");
3801 assert_eq!(by_name("radiusTL").unwrap().snake_name(), "radius_tl");
3802 assert_eq!(by_snake_name("radius_bl").unwrap().name, "radiusBL");
3803 }
3804
3805 #[test]
3809 fn the_allow_list_is_per_spelling() {
3810 use Spelling::{Camel, Snake};
3811 assert!(known_prop("box", "hoverBg", Camel));
3812 assert!(known_prop("box", "hover_bg", Snake));
3813 assert!(!known_prop("box", "hover_bg", Camel));
3814 assert!(!known_prop("box", "hoverBg", Snake));
3815 assert!(known_prop("box", "padX", Camel) && !known_prop("box", "padX", Snake));
3817 assert!(known_prop("box", "scroll", Snake) && !known_prop("box", "scroll", Camel));
3818 assert!(known_prop("box", "direction", Snake));
3820 assert_eq!(lua_alias("direction"), Some("repeat"));
3821 assert!(known_prop("edit", "initial", Camel));
3823 assert!(!known_prop("box", "initial", Camel));
3824 assert!(known_prop("edit", "wrap", Camel) && known_prop("edit", "wrap", Snake));
3827 assert!(known_prop("image", "src", Camel) && known_prop("image", "id", Snake));
3828 assert!(!known_prop("box", "colour", Camel));
3830 }
3831
3832 #[test]
3833 fn a_suggestion_is_the_same_word_in_the_right_convention() {
3834 use Spelling::{Camel, Snake};
3835 assert_eq!(suggest("box", "hoverBg", Snake), Some("hover_bg"));
3836 assert_eq!(suggest("box", "onclick", Camel), Some("onClick"));
3837 assert_eq!(suggest("box", "SCROLL_X", Camel), Some("scrollX"));
3838 assert_eq!(suggest("edit", "Initial", Camel), Some("initial"));
3839 assert_eq!(suggest("box", "colour", Camel), None);
3841 }
3842
3843 #[test]
3846 fn every_composite_and_element_prop_is_in_the_allow_list() {
3847 for c in CUSTOM {
3848 for n in c.jsx_names {
3849 assert!(known_prop("box", n, Spelling::Camel), "jsx `{n}`");
3850 }
3851 for n in c.lua_names {
3852 assert!(known_prop("box", n, Spelling::Snake), "lua `{n}`");
3853 }
3854 }
3855 for e in ELEMENTS {
3856 for n in e.jsx_own {
3857 assert!(known_prop(e.name, n, Spelling::Camel), "{}.{n}", e.name);
3858 }
3859 for n in e.lua_own {
3860 assert!(known_prop(e.name, n, Spelling::Snake), "{}.{n}", e.name);
3861 }
3862 }
3863 }
3864
3865 #[test]
3866 fn every_row_applies_a_sample_of_its_kind() {
3867 for def in PROPS {
3868 let f = if def.name == "opacity" { 0.5 } else { 7.0 };
3871 let sample = match def.kind {
3872 Kind::F32 => Parsed::F32(f),
3873 Kind::Color => Parsed::Color(Color::hex(0x11223344)),
3874 Kind::Flag => Parsed::Flag,
3875 Kind::Enum(_) => Parsed::Enum(1),
3876 Kind::Sizing => Parsed::Sizing(Sizing::Percent(0.5)),
3877 Kind::Min => Parsed::Bound(Bound::Fit),
3878 Kind::Max => Parsed::Bound(Bound::Px(10.0)),
3879 Kind::Msg | Kind::Tag => Parsed::Msg(Value::Int(1)),
3880 Kind::Str => Parsed::Str("name".into()),
3881 Kind::Family => Parsed::Family(FontFamily::Mono),
3882 Kind::Resource => Parsed::Resource(7),
3883 Kind::Keyframes => Parsed::Keyframes(vec![Keyframe::default().radius(7.0)]),
3884 Kind::Enter => Parsed::Enter(Enter::from(-7.0, 0.0)),
3885 Kind::Gradient => Parsed::Gradient(crate::gradient::Gradient::to(
3886 crate::gradient::Side::Right,
3887 [Color::hex(0x11223344), Color::WHITE],
3888 )),
3889 };
3890 let mut out = PropsOut::new();
3891 apply(def, sample, &mut out).unwrap();
3892 let changed = match def.target() {
3893 Target::Spec => out.spec != NodeSpec::column(),
3894 Target::Style => out.style != TextStyle::new(16.0),
3895 };
3896 assert!(changed, "{} applied a sample but nothing changed", def.name);
3897 }
3898 }
3899
3900 #[test]
3903 fn a_null_tag_still_declares_the_behaviour() {
3904 let mut out = PropsOut::new();
3905 apply(
3906 by_name("onKey").unwrap(),
3907 Parsed::Msg(Value::Null),
3908 &mut out,
3909 )
3910 .unwrap();
3911 assert_eq!(out.spec.events().on_key, Some(Value::Null));
3912 assert!(out.spec.hover_tracked());
3913 let mut out = PropsOut::new();
3914 apply(
3915 by_name("onLayout").unwrap(),
3916 Parsed::Msg(Value::Null),
3917 &mut out,
3918 )
3919 .unwrap();
3920 assert_eq!(out.spec.events().on_layout, Some(Value::Null));
3921 }
3922
3923 #[test]
3933 fn every_declarable_role_name_is_a_real_role() {
3934 for (i, name) in ROLES.iter().enumerate() {
3935 let role = Role::parse(name)
3936 .unwrap_or_else(|| panic!("ROLES[{i}] = {name:?} is not a Role::ALL name"));
3937 assert_eq!(role_idx(i), role, "role index {i} lowers to the wrong role");
3938 assert_eq!(role_idx(i).name(), *name);
3939 }
3940 }
3941
3942 #[test]
3951 fn every_role_is_declarable_or_derived() {
3952 for role in Role::ALL {
3953 let declarable = ROLES.contains(&role.name());
3954 let derived = DERIVED_ONLY.iter().any(|(n, _)| *n == role.name());
3955 assert!(
3956 declarable || derived,
3957 "Role::{role:?} is in Role::ALL but no view can declare it and \
3958 DERIVED_ONLY does not say the core derives it — add {:?} to \
3959 ROLES, or to DERIVED_ONLY with the reason",
3960 role.name()
3961 );
3962 assert!(
3963 !(declarable && derived),
3964 "Role::{role:?} is in ROLES, so it is declarable — drop it from \
3965 DERIVED_ONLY"
3966 );
3967 }
3968 for (name, why) in DERIVED_ONLY {
3969 assert!(!why.is_empty(), "{name:?} is exempted without a reason");
3970 assert!(
3971 Role::parse(name).is_some(),
3972 "DERIVED_ONLY names {name:?}, which is not a Role::ALL name"
3973 );
3974 }
3975 let derived = roles_one_frame_derives();
3976 for (name, _) in DERIVED_ONLY {
3977 assert!(
3978 derived.contains(&Role::parse(name).unwrap()),
3979 "DERIVED_ONLY keeps {name:?} out of ROLES because the core \
3980 derives it, but no frame does any more — either it belongs in \
3981 ROLES now, or the exemption is stale"
3982 );
3983 }
3984 }
3985
3986 fn roles_one_frame_derives() -> Vec<Role> {
3990 let mut core = crate::Core::new();
3991 let mut ui = core.frame(crate::Size::new(200.0, 200.0), 1.0);
3992 ui.window_title("Demo");
3993 ui.configure_root(NodeSpec::column().fill());
3994 ui.leaf_keyed("titlebar", NodeSpec::row().window_drag());
3995 ui.text_in_keyed(
3996 "scroll",
3997 NodeSpec::column().height(40.0).scroll_y(),
3998 "hello",
3999 TextStyle::new(12.0),
4000 );
4001 ui.finish();
4002 core.access_tree().nodes.iter().map(|n| n.role).collect()
4003 }
4004
4005 #[test]
4006 fn colors_and_sizings_parse() {
4007 assert_eq!(color_hex_str("#fff").unwrap(), Color::hex(0xffffffff));
4008 assert_eq!(color_hex_str("#11223344").unwrap(), Color::hex(0x11223344));
4009 assert!(color_hex_str("fff").is_err());
4010 assert_eq!(sizing_str("50%").unwrap(), Sizing::Percent(0.5));
4011 assert_eq!(sizing_str("grow").unwrap(), Sizing::Grow(1.0));
4012 assert!(sizing_str("wide").is_err());
4013 }
4014}