kui_core/spec.rs
1//! [`NodeSpec`] and [`TextStyle`]: everything a node and a text declare,
2//! as plain data with a builder.
3//!
4//! A `NodeSpec` is the contract every frontend lowers into, whether a Rust
5//! builder chain, a Lua table or a JSX element. It groups the layout
6//! ([`LayoutSpec`]: sizing, direction, padding, gap, alignment, overflow),
7//! the look ([`VisualStyle`]: background, border, radius, shadow, opacity)
8//! and, boxed because most nodes declare none of it, the events, animation,
9//! accessibility and interaction styling. Every builder method sets one of
10//! those fields; the field docs below say what each means.
11//!
12//! ```rust
13//! use kui_core::{Align, Color, NodeSpec, Sizing, TextStyle, TextWrap};
14//!
15//! // A card: grows across its parent, fits its content down, 12 px padding
16//! // and gap, rounded, with a hover background and a click payload.
17//! let card = NodeSpec::column()
18//! .width(Sizing::GROW)
19//! .pad(12.0)
20//! .gap(8.0)
21//! .bg(Color::hex(0x1e2230ff))
22//! .hover_bg(Color::hex(0x262b3aff))
23//! .radius(8.0)
24//! .on_click("open-card");
25//!
26//! // A toolbar row: fixed height, children centred across it.
27//! let toolbar = NodeSpec::row().size(Sizing::GROW, 36.0).cross_align(Align::Center);
28//!
29//! // A one-line title, cut with an ellipsis when it does not fit.
30//! let title = TextStyle::new(16.0).ellipsis().color(Color::WHITE);
31//! let code = TextStyle::new(13.0).mono().wrap(TextWrap::Glyph);
32//!
33//! assert_eq!(card.layout.padding.l, 12.0);
34//! assert!(card.events().on_click.is_some());
35//! assert_eq!(toolbar.layout.height, Sizing::Fixed(36.0));
36//! assert_eq!(title.max_lines, 0); // `ellipsis` alone means one line
37//! assert!(title.ellipsis && code.wrap == TextWrap::Glyph);
38//! ```
39
40use crate::anim::{Easing, Repeat, Transition};
41use crate::color::Color;
42use crate::cursor::CursorShape;
43use crate::enter::Enter;
44use crate::geom::Edges;
45use crate::input::Buttons;
46use crate::keyframes::Keyframe;
47use crate::value::Value;
48use crate::window::{WindowButton, WindowRole};
49
50pub use crate::access::{Label, Live, Role};
51
52/// How a node sizes one axis. A plain number converts to `Fixed`, so
53/// `.width(120.0)` and `.width(Sizing::Fixed(120.0))` are the same.
54#[derive(Clone, Copy, Debug, Default, PartialEq)]
55pub enum Sizing {
56 /// Size to content.
57 #[default]
58 Fit,
59 /// Share leftover space, weighted by factor.
60 Grow(f32),
61 /// Absolute logical pixels.
62 Fixed(f32),
63 /// Fraction of the parent's content box (0.0..=1.0).
64 Percent(f32),
65 /// A size expression resolved against the parent's content box, the
66 /// box a `Percent` takes its cut of: `"clamp(400px, 80%, 1000px)"`
67 /// (see [`crate::calc`]). Layout treats it as it treats a `Percent`:
68 /// nothing in the fit pass, its size once the parent's is known, and
69 /// a parent that overflows shrinks it as it would one.
70 Calc(crate::calc::Calc),
71}
72
73/// What a `min_width` / `max_width` / `min_height` / `max_height`
74/// declares: px, the node's own fit size (a min only), or a size
75/// expression that layout resolves against the parent's content box when
76/// it sizes the node. Until then a calc bound clamps like none, as a
77/// percentage clamp does in CSS's intrinsic sizing.
78///
79/// A calc clamp rides in the clamp's own `f32` as a negative, the way
80/// [`Min::FIT`] does (`min_w` below -1, [`Min::calc`]; `max_w` below 0,
81/// [`max_calc`]), and layout writes the resolved px over it. A reader
82/// after layout reads a number; one before it goes through
83/// [`LayoutSpec::max_w_px`].
84#[derive(Clone, Copy, Debug, PartialEq)]
85pub enum Bound {
86 Px(f32),
87 Fit,
88 Calc(crate::calc::Calc),
89}
90
91/// A ceiling that is a size expression, as `max_w` / `max_h` hold it
92/// until layout resolves it: -1 minus its number.
93pub fn max_of_calc(c: crate::calc::Calc) -> f32 {
94 -1.0 - c.id() as f32
95}
96
97/// A px ceiling as `max_w` / `max_h` hold it: never below zero, so a
98/// negative there is only ever [`max_of_calc`]'s. A negative or `NaN`
99/// ceiling is a ceiling of 0. Every binding's max clamp reaches the field
100/// through [`NodeSpec::max_width`] / [`NodeSpec::max_height`], which call
101/// this.
102pub fn px_ceiling(px: f32) -> f32 {
103 // `f32::max` takes the other operand over a `NaN`.
104 px.max(0.0)
105}
106
107/// The size expression a `max_w` / `max_h` waits on, if it is one.
108pub fn max_calc(v: f32) -> Option<crate::calc::Calc> {
109 (v < 0.0)
110 .then(|| crate::calc::Calc::from_id((-v - 1.0) as u32))
111 .flatten()
112}
113
114impl From<f32> for Bound {
115 fn from(px: f32) -> Self {
116 Bound::Px(px)
117 }
118}
119
120impl From<Min> for Bound {
121 fn from(m: Min) -> Self {
122 if m.is_fit() {
123 Bound::Fit
124 } else if let Some(c) = m.as_calc() {
125 Bound::Calc(c)
126 } else if m.is_auto() {
127 // Undeclared stays undeclared through `min_width`.
128 Bound::Px(-0.0)
129 } else {
130 Bound::Px(m.resolved())
131 }
132 }
133}
134
135/// A lower clamp on one axis: a number of logical px, or the node's own
136/// fit size on that axis ([`Min::FIT`], `minWidth: "fit"` in the
137/// bindings). `FIT` is what lets a `Grow` child keep a content floor, like
138/// CSS's `flex: 1 0 auto`: tabs split a bar evenly while they fit and sit
139/// at their label's width, scrolling, once they do not. Layout resolves it
140/// to a number in the fit pass of its axis, so every later clamp reads
141/// one; until then it clamps like no floor at all.
142///
143/// Undeclared is [`Min::AUTO`], which clamps as 0 everywhere but one
144/// place: a child giving in an overflowing row that holds a share of the
145/// room, where it is CSS's `min-width: auto`, the child's min-content. A
146/// declared 0 (`Min::px(0.0)`) is no floor there either, as CSS's
147/// `min-width: 0` is how a flex item is let go below its content.
148///
149/// Stored as one `f32` with `FIT` and a calc as negatives (the form the
150/// C struct's `min_w` takes too), because `LayoutSpec` is copied per node
151/// per frame.
152#[derive(Clone, Copy, Debug, PartialEq)]
153pub struct Min(f32);
154
155impl Default for Min {
156 fn default() -> Self {
157 Min::AUTO
158 }
159}
160
161impl Min {
162 /// The node's own fit size on this axis.
163 pub const FIT: Min = Min(-1.0);
164
165 /// No floor declared: the node's min-content where a share of the room
166 /// gives in CSS's way and down a column of fit children; 0 across a
167 /// run of fit children alone, across a column, where a fit node is
168 /// held to the column's box, and for a node that scrolls or clips.
169 /// Negative zero, so it is 0 to every clamp and to `==`, and told
170 /// apart from a declared 0 by its sign alone ([`Min::is_auto`]).
171 pub const AUTO: Min = Min(-0.0);
172
173 /// A floor of `v` logical px; a negative (or `NaN`) is a floor of 0,
174 /// declared — no automatic one either.
175 pub fn px(v: f32) -> Min {
176 Min(if v > 0.0 { v } else { 0.0 })
177 }
178
179 /// Whether no floor was declared ([`Min::AUTO`]).
180 pub fn is_auto(self) -> bool {
181 self.0 == 0.0 && self.0.is_sign_negative()
182 }
183
184 /// Whether this is the unresolved fit floor.
185 pub fn is_fit(self) -> bool {
186 self.0 == Min::FIT.0
187 }
188
189 /// A floor that is a size expression, until layout resolves it: -2
190 /// minus its number, below `FIT`'s -1.
191 pub fn calc(c: crate::calc::Calc) -> Min {
192 Min(-2.0 - c.id() as f32)
193 }
194
195 /// The size expression this floor waits on, if it is one.
196 pub fn as_calc(self) -> Option<crate::calc::Calc> {
197 (self.0 <= -2.0)
198 .then(|| crate::calc::Calc::from_id((-self.0 - 2.0) as u32))
199 .flatten()
200 }
201
202 /// Whether layout has yet to resolve this floor — a `FIT` or a calc,
203 /// the negatives — without asking the table which calc it is.
204 pub(crate) fn deferred(self) -> bool {
205 self.0 < 0.0
206 }
207
208 /// The clamp as a number: the px it holds, or 0 for a `FIT` or a calc
209 /// layout has not resolved yet (nothing to floor at).
210 pub fn resolved(self) -> f32 {
211 if self.0 > 0.0 { self.0 } else { 0.0 }
212 }
213}
214
215impl From<f32> for Min {
216 fn from(v: f32) -> Self {
217 Min::px(v)
218 }
219}
220
221/// A number is that many logical px, so `.width(120.0)` is
222/// `.width(Sizing::Fixed(120.0))`, the way `min_width(120.0)` already read.
223impl From<f32> for Sizing {
224 fn from(px: f32) -> Self {
225 Sizing::Fixed(px)
226 }
227}
228
229impl Sizing {
230 /// `Grow(1.0)`: an equal share of the leftover space, the weight
231 /// nearly every grow declares.
232 pub const GROW: Sizing = Sizing::Grow(1.0);
233}
234
235impl Sizing {
236 /// The sizing the way a spec spells it — `fit`, `grow(1)`, `120px`,
237 /// `50%` — for a reader: the devtools' inspector and a `nodes()` row.
238 pub fn describe(self) -> String {
239 match self {
240 Sizing::Fit => "fit".into(),
241 Sizing::Grow(w) => format!("grow({w})"),
242 Sizing::Fixed(px) => format!("{px}px"),
243 Sizing::Percent(p) => format!("{}%", p * 100.0),
244 Sizing::Calc(c) => c.describe(),
245 }
246 }
247
248 /// The animatable number inside: a grow factor, a px size, a fraction.
249 /// None for `Fit` and a `Calc`, which have nothing to ease.
250 pub fn amount(self) -> Option<f32> {
251 match self {
252 Sizing::Fit | Sizing::Calc(_) => None,
253 Sizing::Grow(v) | Sizing::Fixed(v) | Sizing::Percent(v) => Some(v),
254 }
255 }
256
257 /// The same form with a different amount (`Fit` and a `Calc` stay).
258 pub fn with_amount(self, v: f32) -> Self {
259 match self {
260 Sizing::Fit => Sizing::Fit,
261 Sizing::Calc(c) => Sizing::Calc(c),
262 Sizing::Grow(_) => Sizing::Grow(v),
263 Sizing::Fixed(_) => Sizing::Fixed(v),
264 Sizing::Percent(_) => Sizing::Percent(v),
265 }
266 }
267}
268
269/// Which way a container stacks its children.
270#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
271pub enum Dir {
272 Row,
273 #[default]
274 Column,
275}
276
277impl Dir {
278 /// The `dir` row's spelling.
279 pub fn name(self) -> &'static str {
280 match self {
281 Dir::Row => "row",
282 Dir::Column => "column",
283 }
284 }
285}
286
287/// Where children sit along an axis, and where a float attaches.
288///
289/// The first three apply to every axis. The rest each mean something on
290/// one axis only: the three spreads on `main_align`, `Baseline` on a row's
291/// `cross_align`. Anywhere else one lays out as `Start`
292/// (`SpaceAround`/`SpaceEvenly` as `Center`), with an `align-ignored`
293/// warning.
294#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
295pub enum Align {
296 #[default]
297 Start,
298 Center,
299 End,
300 /// Main axis: the free space goes between the children, none at the
301 /// ends — CSS's `space-between`. One child sits at the start.
302 SpaceBetween,
303 /// Main axis: each child gets an equal share of the free space, half
304 /// on either side, so the ends get half what a gap does — CSS's
305 /// `space-around`. One child is centred.
306 SpaceAround,
307 /// Main axis: the free space splits into equal gaps between the
308 /// children and at both ends — CSS's `space-evenly`. One child is
309 /// centred.
310 SpaceEvenly,
311 /// A row's cross axis: the first baselines of the children's text line
312 /// up, so a label and a larger value on one row read as one line. A
313 /// child with no text inside it aligns by its bottom edge; a `grow` or
314 /// percent height fills the line and sits at its top.
315 Baseline,
316}
317
318impl Align {
319 /// The `align` rows' spelling (`schema::ALIGNS`).
320 pub fn name(self) -> &'static str {
321 crate::schema::ALIGNS[self as usize]
322 }
323}
324
325/// What a floating node is positioned against.
326#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
327pub enum FloatAnchor {
328 /// The parent node's border box.
329 #[default]
330 Parent,
331 /// The whole viewport.
332 Viewport,
333 /// The border box of the node `Key` names, wherever it is in the
334 /// tree, even after this one in preorder: such a float is laid out
335 /// again in a sixth pass once its anchor is placed. What a devtools
336 /// tab's content is: built in the app's part of the tree, shown over
337 /// the panel's tab body. No binding spells it; the core builds it.
338 Node(crate::key::Key),
339}
340
341/// Takes a node out of flex flow: it does not consume space in its parent,
342/// sizes Grow/Percent against its anchor, is positioned by attach points,
343/// and escapes ancestor clips unless [`FloatConfig::clip`] keeps it in its
344/// parent's. It paints as a layer of its own, above the in-flow tree and
345/// every float that opened before it and under every one that opened
346/// after, and takes input in the same order.
347///
348/// ```rust
349/// use kui_core::{Align, FloatConfig, NodeSpec};
350///
351/// let tooltip = NodeSpec::column().float(FloatConfig::below().fit());
352/// let toast = NodeSpec::row().float(FloatConfig::viewport().inside(Align::End, Align::End).offset(-16.0, -16.0));
353/// assert!(tooltip.layout.float.unwrap().fit);
354/// assert_eq!(toast.layout.float.unwrap().offset.x, -16.0);
355/// ```
356#[derive(Clone, Copy, Debug, PartialEq)]
357pub struct FloatConfig {
358 pub anchor: FloatAnchor,
359 /// Attach point on the anchor rect (horizontal, vertical).
360 pub anchor_point: (Align, Align),
361 /// Attach point on the floating node itself.
362 pub self_point: (Align, Align),
363 /// Extra offset applied after attaching, logical px.
364 pub offset: Vec2Offset,
365 /// Keep the float on screen: if the attached placement leaves the
366 /// viewport on an axis, mirror the attachment across the anchor on that
367 /// axis (below ↔ above, after ↔ before) when that fits better, then
368 /// clamp whatever still overflows. Tooltips/menus want this.
369 ///
370 /// This is the in-window approximation of an OS popup: a float costs
371 /// one tree, one hit list and one draw call. What it cannot do is leave
372 /// the window, so a dropdown taller than the viewport, or a menu with
373 /// nowhere in-window to go, is clamped rather than placed.
374 pub fit: bool,
375 /// Take the parent's clip, as a child does, instead of escaping every
376 /// ancestor's: a node on a `clip` canvas panned past the canvas's edge
377 /// is cut there, and its hit region with it, rather than drawn over
378 /// and clicked through the toolbar beside it. Only a
379 /// [`FloatAnchor::Parent`] float reads it; a viewport or node anchor is
380 /// placed against something other than the parent, and escapes with it
381 /// set or not. A declared float's paint order is unchanged: it is a
382 /// layer of its own still. A `line`, `polygon` or `path` anchored in
383 /// its parent's box has it set by the core, and with it paints in the
384 /// parent's layer at its place in the tree, as a child does — it opens
385 /// no layer (backlog F123; `Tree::opens_layer`).
386 pub clip: bool,
387}
388
389/// Plain offset pair (kept separate from geometry to stay `Copy` + FFI-flat).
390#[derive(Clone, Copy, Debug, Default, PartialEq)]
391pub struct Vec2Offset {
392 pub x: f32,
393 pub y: f32,
394}
395
396impl Default for FloatConfig {
397 fn default() -> Self {
398 Self {
399 anchor: FloatAnchor::Parent,
400 anchor_point: (Align::Start, Align::Start),
401 self_point: (Align::Start, Align::Start),
402 offset: Vec2Offset::default(),
403 fit: false,
404 clip: false,
405 }
406 }
407}
408
409impl FloatConfig {
410 /// Anchored to the parent's top-left corner.
411 pub fn parent() -> Self {
412 Self::default()
413 }
414
415 /// Anchored to the viewport's top-left corner.
416 pub fn viewport() -> Self {
417 Self {
418 anchor: FloatAnchor::Viewport,
419 ..Self::default()
420 }
421 }
422
423 /// Tooltip-style: hang below the parent, centered.
424 pub fn below() -> Self {
425 Self {
426 anchor: FloatAnchor::Parent,
427 anchor_point: (Align::Center, Align::End),
428 self_point: (Align::Center, Align::Start),
429 offset: Vec2Offset { x: 0.0, y: 6.0 },
430 ..Self::default()
431 }
432 }
433
434 /// Tooltip-style: hover above the parent, centered.
435 pub fn above() -> Self {
436 Self {
437 anchor: FloatAnchor::Parent,
438 anchor_point: (Align::Center, Align::Start),
439 self_point: (Align::Center, Align::End),
440 offset: Vec2Offset { x: 0.0, y: -6.0 },
441 ..Self::default()
442 }
443 }
444
445 /// The attach point on the anchor.
446 pub fn at(mut self, x: Align, y: Align) -> Self {
447 self.anchor_point = (x, y);
448 self
449 }
450
451 /// The attach point on the float itself.
452 pub fn self_at(mut self, x: Align, y: Align) -> Self {
453 self.self_point = (x, y);
454 self
455 }
456
457 /// [`Self::at`] and [`Self::self_at`] at the same point: the float sits
458 /// inside the anchor against that edge or corner — `(End, End)` is a
459 /// toast in the viewport's bottom-right, `(Center, Center)` a dialog.
460 #[inline]
461 pub fn inside(self, x: Align, y: Align) -> Self {
462 self.at(x, y).self_at(x, y)
463 }
464
465 /// An extra offset after attaching, logical px.
466 pub fn offset(mut self, x: f32, y: f32) -> Self {
467 self.offset = Vec2Offset { x, y };
468 self
469 }
470
471 /// Flip across the anchor / clamp as needed to stay in the viewport;
472 /// see [`FloatConfig::fit`] for where that stops being enough.
473 pub fn fit(mut self) -> Self {
474 self.fit = true;
475 self
476 }
477
478 /// Cut by the parent's clip instead of escaping it; see
479 /// [`FloatConfig::clip`] for which anchors read it.
480 pub fn clipped(mut self) -> Self {
481 self.clip = true;
482 self
483 }
484
485 /// Whether this float takes its parent's clip: [`FloatConfig::clip`]
486 /// declared on a parent-anchored float. The one reading both paint
487 /// passes and the hit regions share.
488 pub fn clipped_by_parent(&self) -> bool {
489 self.clip && self.anchor == FloatAnchor::Parent
490 }
491
492 /// A preset by its wire index — its position in [`FLOAT_PRESETS`], which
493 /// is what the binary protocol carries and what `KUI_FLOAT_*` counts
494 /// from. `None` for an index no preset claims.
495 pub fn preset_at(i: usize) -> Option<Self> {
496 Some(match i {
497 0 => Self::parent(),
498 1 => Self::viewport(),
499 2 => Self::below(),
500 3 => Self::above(),
501 _ => return None,
502 })
503 }
504
505 /// A preset by name. Every binding that spells a float as a word —
506 /// `float="below"`, `float = "above"`, `kui_spec_float_preset` — resolves
507 /// it here, so "below" cannot mean one thing in JS and another in Lua.
508 pub fn preset(name: &str) -> Option<Self> {
509 Self::preset_at(FLOAT_PRESETS.iter().position(|p| *p == name)?)
510 }
511
512 /// One config from the pieces a binding can extract without deciding
513 /// anything: a `base` preset (from [`FloatConfig::preset`] or
514 /// [`FloatConfig::preset_at`]) and the overrides that were actually
515 /// declared. `None` leaves the base's own value — that is what lets
516 /// `float="below"` keep its 6px gap while `{ anchor: "below", dx: 2 }`
517 /// moves it sideways without flattening the gap to zero. `fit` and
518 /// `clip` are ORed in: no preset sets either.
519 pub fn build(
520 base: FloatConfig,
521 anchor_at: Option<(Align, Align)>,
522 self_at: Option<(Align, Align)>,
523 dx: Option<f32>,
524 dy: Option<f32>,
525 fit: bool,
526 clip: bool,
527 ) -> Self {
528 let mut cfg = base;
529 if let Some((x, y)) = anchor_at {
530 cfg.anchor_point = (x, y);
531 }
532 if let Some((x, y)) = self_at {
533 cfg.self_point = (x, y);
534 }
535 if let Some(x) = dx {
536 cfg.offset.x = x;
537 }
538 if let Some(y) = dy {
539 cfg.offset.y = y;
540 }
541 cfg.fit |= fit;
542 cfg.clip |= clip;
543 cfg
544 }
545}
546
547/// The float preset names, in wire order: the index of a name here is what
548/// the binary protocol writes for it and what `KUI_FLOAT_*` counts from.
549pub const FLOAT_PRESETS: &[&str] = &["parent", "viewport", "below", "above"];
550
551/// `overflow` as bits: the C struct's field, the binary wire's payload and
552/// what the `clip` / `scrollX` / `scrollY` booleans OR together. One set of
553/// values so a binding cannot invent its own numbering.
554pub const OVERFLOW_CLIP: u32 = 1 << 0;
555pub const OVERFLOW_SCROLL_X: u32 = 1 << 1;
556pub const OVERFLOW_SCROLL_Y: u32 = 1 << 2;
557
558/// The `pad` shorthand family as declared — any subset of the seven names,
559/// each `None` when the frontend did not see it. [`PadShorthand::resolve`]
560/// decides what a missing edge falls back to; a binding only reports what
561/// it found.
562#[derive(Clone, Copy, Debug, Default, PartialEq)]
563pub struct PadShorthand {
564 /// `pad`: all four edges.
565 pub all: Option<f32>,
566 /// `padX`: left and right.
567 pub x: Option<f32>,
568 /// `padY`: top and bottom.
569 pub y: Option<f32>,
570 pub l: Option<f32>,
571 pub r: Option<f32>,
572 pub t: Option<f32>,
573 pub b: Option<f32>,
574}
575
576impl PadShorthand {
577 /// True when the frontend saw any of the seven names.
578 pub fn declared(self) -> bool {
579 [self.all, self.x, self.y, self.l, self.r, self.t, self.b]
580 .iter()
581 .any(Option::is_some)
582 }
583
584 /// Four edges: an edge falls back to its axis, an axis to the all-round
585 /// `pad`, and `pad` to zero. The specific value always wins.
586 pub fn resolve(self) -> Edges {
587 let all = self.all.unwrap_or(0.0);
588 let (x, y) = (self.x.unwrap_or(all), self.y.unwrap_or(all));
589 Edges {
590 l: self.l.unwrap_or(x),
591 r: self.r.unwrap_or(x),
592 t: self.t.unwrap_or(y),
593 b: self.b.unwrap_or(y),
594 }
595 }
596}
597
598/// The layout half of a [`NodeSpec`]: sizing, clamps, direction, padding,
599/// gap, alignment, overflow and floating. Set through the `NodeSpec`
600/// builders; read by the solver.
601#[derive(Clone, Copy, Debug, PartialEq)]
602pub struct LayoutSpec {
603 pub width: Sizing,
604 pub height: Sizing,
605 /// Clamps applied after `width`/`height` resolve (Fit, Grow, Percent and
606 /// Fixed alike), so "grow but at most N" and "fit but at least N" work.
607 /// A min may also be [`Min::FIT`]: "grow but never below my content".
608 pub min_w: Min,
609 /// A ceiling in px, or, as a negative, a size expression layout has
610 /// yet to resolve ([`max_of_calc`]); set it through
611 /// [`NodeSpec::max_width`], which keeps a px one at or above zero
612 /// ([`px_ceiling`]). `max_h` is the same.
613 pub max_w: f32,
614 pub min_h: Min,
615 pub max_h: f32,
616 pub dir: Dir,
617 pub padding: Edges,
618 pub gap: f32,
619 /// Row children that don't fit the main-axis content box start a new
620 /// line instead of overflowing (or shrinking). Rows only: breaking
621 /// needs a definite main size, and the pass order gives a row one —
622 /// its width is final before its height is measured — where a column
623 /// would need its height first. Ignored on a column and on a
624 /// `scroll_x` row, both with a warning (`diag::WRAP_IGNORED`).
625 pub wrap: bool,
626 /// A column whose rows' children line up in columns: the nth in-flow
627 /// child of every in-flow row is a cell of column n, and
628 /// a column is as wide as its widest cell — its cells' own `width`s
629 /// say how the column sizes (a `Fixed` or `Fit` cell is content that
630 /// sets the column's fit width, a `Grow` cell makes the column grow,
631 /// a `Percent` one takes its cut of the row) and their `minWidth` /
632 /// `maxWidth` clamp it. The rows are ordinary rows — a row's `gap` is
633 /// the space between its cells, its `padding` its own, and it takes
634 /// its background, its click and its hover as any row does — except
635 /// that a row of a table never wraps (`diag::WRAP_IGNORED`). Set by
636 /// [`NodeSpec::table`], which is a column; `dir` stays `Column`, and
637 /// the flag is read on a column only ([`LayoutSpec::is_table`]): a
638 /// `Row` carrying it — a shape only these public fields can build —
639 /// is the row it says it is. The rows are the in-flow `Row` children;
640 /// a column, a table or a leaf straight under the table is a child
641 /// with its own width and no cells.
642 pub table: bool,
643 /// Space between wrap lines, across the main axis. `gap` is still the
644 /// space between children along it.
645 pub cross_gap: f32,
646 /// Alignment of children along the main axis, the spreads
647 /// (`SpaceBetween` / `SpaceAround` / `SpaceEvenly`) included.
648 pub main_align: Align,
649 /// Alignment of children across the main axis; `Baseline` on a row.
650 pub cross_align: Align,
651 /// Width over height (CSS's `aspect-ratio`); 0 = none.
652 /// It sizes the axis whose sizing is `Fit`: a fit height is the final
653 /// width over the ratio, and a fit width under a `Fixed` height is
654 /// that height times it. With both axes declared it has nothing to set.
655 /// The derived axis is neither shrunk nor fitted to the children,
656 /// which overflow it — `min_h: Min::FIT` floors it at them.
657 pub aspect: f32,
658 /// Clip children to this node's rect.
659 pub clip: bool,
660 /// Overflowing content scrolls (implies clipping). Offsets are retained
661 /// across frames in the core, keyed by this node's `Key`.
662 pub scroll_x: bool,
663 pub scroll_y: bool,
664 /// Scroll anchoring (CSS's `overflow-anchor`): the
665 /// first child in view keeps its place on screen when the content
666 /// before it changes size — a chat that prepends history, a log that
667 /// inserts above the viewport, a row whose estimate was corrected.
668 /// On the scroll axis that is the container's main axis only.
669 pub anchor: bool,
670 /// Out-of-flow positioning; see [`FloatConfig`].
671 pub float: Option<FloatConfig>,
672}
673
674impl Default for LayoutSpec {
675 fn default() -> Self {
676 Self {
677 width: Sizing::Fit,
678 height: Sizing::Fit,
679 min_w: Min::AUTO,
680 max_w: f32::INFINITY,
681 min_h: Min::AUTO,
682 max_h: f32::INFINITY,
683 dir: Dir::Column,
684 padding: Edges::default(),
685 gap: 0.0,
686 wrap: false,
687 table: false,
688 cross_gap: 0.0,
689 main_align: Align::Start,
690 cross_align: Align::Start,
691 aspect: 0.0,
692 clip: false,
693 scroll_x: false,
694 scroll_y: false,
695 anchor: false,
696 float: None,
697 }
698 }
699}
700
701impl LayoutSpec {
702 /// Whether this node clips its children.
703 pub fn clips(&self) -> bool {
704 self.clip || self.scroll_x || self.scroll_y
705 }
706
707 /// Whether this node is a table: the flag, on a column. Every reader
708 /// asks this and not the field, so a `Row` with the field set is a row
709 /// everywhere.
710 pub fn is_table(&self) -> bool {
711 self.table && self.dir == Dir::Column
712 }
713}
714
715impl LayoutSpec {
716 /// The width a declared aspect ratio gives a `Fit` width: its `Fixed`
717 /// height times the ratio. `None` when the ratio has no say over the
718 /// width.
719 pub(crate) fn aspect_width(&self) -> Option<f32> {
720 match (self.width, self.height) {
721 (Sizing::Fit, Sizing::Fixed(h)) if self.aspect > 0.0 => {
722 Some(self.clamp_h(h) * self.aspect)
723 }
724 _ => None,
725 }
726 }
727
728 /// Whether a declared aspect ratio sizes the height: a `Fit` height,
729 /// read off the final width. `aspect_width`'s pair.
730 pub(crate) fn aspect_height(&self) -> bool {
731 self.aspect > 0.0 && self.height == Sizing::Fit
732 }
733
734 pub(crate) fn clamp_w(&self, w: f32) -> f32 {
735 let min = self.min_w.resolved();
736 w.clamp(min, self.max_w_px().max(min))
737 }
738
739 pub(crate) fn clamp_h(&self, h: f32) -> f32 {
740 let min = self.min_h.resolved();
741 h.clamp(min, self.max_h_px().max(min))
742 }
743
744 /// `max_w` as px: a calc layout has not resolved yet is no ceiling.
745 pub fn max_w_px(&self) -> f32 {
746 if self.max_w < 0.0 {
747 f32::INFINITY
748 } else {
749 self.max_w
750 }
751 }
752
753 /// `max_h` as px, as [`Self::max_w_px`].
754 pub fn max_h_px(&self) -> f32 {
755 if self.max_h < 0.0 {
756 f32::INFINITY
757 } else {
758 self.max_h
759 }
760 }
761}
762
763/// The paint half of a [`NodeSpec`]: background, border, corner radii,
764/// opacity, shadow and pixel snapping.
765#[derive(Clone, Copy, Debug, PartialEq)]
766pub struct VisualStyle {
767 pub bg: Color,
768 pub border_color: Color,
769 pub border_w: f32,
770 /// Corner radii (logical px), clockwise from the top-left:
771 /// `[tl, tr, br, bl]`. `NodeSpec::radius` sets all four; the per-corner
772 /// builders (`radius_tl`, ...) override one — later calls win, like CSS
773 /// `border-radius` followed by `border-top-left-radius`.
774 pub radius: [f32; 4],
775 /// Group opacity, 0..=1 and 1 by default: multiplied into the alpha of
776 /// every quad this node and its subtree emit, and into every
777 /// descendant's own opacity. This is the *cheap* group opacity — a
778 /// per-quad alpha multiply, not an offscreen composite — so a subtree
779 /// whose own pieces overlap shows its seams through the fade where a
780 /// compositing implementation would not. Nothing else changes: an
781 /// invisible subtree still lays out, still takes clicks and is still
782 /// read by assistive technology, exactly like CSS `opacity: 0`.
783 pub opacity: f32,
784 /// The drop shadow cast behind this node (see [`Shadow`]).
785 pub shadow: Shadow,
786 /// Paint the background, border, shadow and fragment with each edge on
787 /// a whole physical pixel (`pixelSnap`). Off by default: a box is drawn where
788 /// layout put it, so a gap between two boxes is there at any scale.
789 /// On, its edges land where a text's backgrounds' do and where every
790 /// other snapped box's do, so snapped boxes that share an edge in
791 /// layout, and a snapped box beside a text's background, meet without
792 /// a seam. Layout, hit-testing and the children are untouched.
793 pub pixel_snap: bool,
794}
795
796impl Default for VisualStyle {
797 fn default() -> Self {
798 Self {
799 bg: Color::TRANSPARENT,
800 border_color: Color::TRANSPARENT,
801 border_w: 0.0,
802 radius: [0.0; 4],
803 opacity: 1.0,
804 shadow: Shadow::default(),
805 pixel_snap: false,
806 }
807 }
808}
809
810/// One outer drop shadow: the node's rounded rect, moved by `dx`/`dy`,
811/// grown by `spread` and its edge blurred over `blur`, painted in `color`
812/// behind the node. CSS's `box-shadow` without the inset and multi-shadow
813/// forms.
814///
815/// It draws whenever `color` is visible, so `shadowColor` alone is a hard
816/// shadow sitting exactly behind the node. The shape is not knocked out of
817/// the middle the way CSS knocks it out, so a translucent background shows
818/// the shadow through itself.
819#[derive(Clone, Copy, Debug, Default, PartialEq)]
820pub struct Shadow {
821 pub color: Color,
822 /// Offset (logical px); positive `dy` casts downward.
823 pub dx: f32,
824 pub dy: f32,
825 /// Blur radius (logical px): the edge ramps over this distance and the
826 /// shadow reaches this far past its shape. 0 = a hard edge.
827 pub blur: f32,
828 /// Grows (or, negative, shrinks) the shape before blurring.
829 pub spread: f32,
830}
831
832impl Shadow {
833 /// Whether anything would be painted.
834 pub fn is_visible(&self) -> bool {
835 self.color.is_visible()
836 }
837}
838
839/// Corner indices into `VisualStyle::radius` / `Quad::radius`.
840pub mod corner {
841 pub const TL: usize = 0;
842 pub const TR: usize = 1;
843 pub const BR: usize = 2;
844 pub const BL: usize = 3;
845}
846
847/// Everything one node declares. This, not any Rust trait, is the contract
848/// every frontend (Rust builders, Lua, JSX, C) lowers into. Start from
849/// [`NodeSpec::row`], [`NodeSpec::column`] or [`NodeSpec::table`] and
850/// chain builders; see the [module docs](self) for an example.
851#[derive(Clone, Debug, Default)]
852pub struct NodeSpec {
853 pub layout: LayoutSpec,
854 pub style: VisualStyle,
855 /// Track pointer hover for this node (`Ui::is_hovered`) without making
856 /// it clickable — tooltips on passive badges. Nodes with `on_click` /
857 /// `on_key` / `window` are always hover-tracked; clicks on a merely
858 /// hoverable node emit nothing.
859 pub hoverable: bool,
860 /// Ask the driver for another frame after this one, every frame this
861 /// node is declared (`animate`). What a `fragment` reading `time`
862 /// needs; opt-in, because it takes the loop off input-driven.
863 pub animate: bool,
864 /// Paint this node's background in the theme's accent: the OS's where
865 /// the host reported one, the app's where it pinned one, kui's blue
866 /// otherwise. A view says *that* this node is the accented one and the
867 /// palette says which colour that is. The stock button also repaints
868 /// its hover, pressed shade and label from the same accent.
869 pub accent: bool,
870 /// Window-chrome role (drag handle / window button). A chrome node's
871 /// interactions become `WindowCommand`s for the frame driver instead of
872 /// `UiEvent`s; `on_click` is ignored on such nodes.
873 pub window: Option<WindowRole>,
874 /// Eases this node's sizing amounts, colors and radius toward what the
875 /// view declares instead of snapping (see [`crate::anim`]). Keyed by
876 /// node identity, so the node needs a stable key across frames.
877 pub transition: Option<Transition>,
878 /// With `transition`: also ease this node's laid-out *position*, moving
879 /// its whole subtree — reordered siblings slide into their new slots.
880 /// Opt-in because a node whose position follows an already-easing
881 /// sibling (a split's second half) would lag twice.
882 pub slide: bool,
883 /// Reachable by Tab, and focused by a click or an assistive-technology
884 /// request, without a click payload or a control role — a list row
885 /// that opens on Enter, a card. Controls (editors, key sinks,
886 /// `on_click` boxes, the control roles) are focusable already.
887 pub focusable: bool,
888 /// Where focus lands when the `modal` scope containing this node is
889 /// entered: the first node in the modal's Tab ring declaring it,
890 /// instead of simply the ring's first — a destructive confirm opening
891 /// on its Cancel rather than on whichever control is declared first.
892 /// Read on entry only, so a Tab press afterwards stands; a node the
893 /// ring skips (disabled, decoration, not focusable) is not a
894 /// candidate, and with no candidate the entry is the ring's first
895 /// node as before.
896 pub initial_focus: bool,
897 /// Inert: keeps its hit region (so a tooltip can say why) and loses
898 /// everything else — no click, drag or key sink, no hover / pressed /
899 /// focus background, no place in the Tab ring; the access tree
900 /// reports it disabled.
901 pub disabled: bool,
902 /// The pointer shape over this node (see [`crate::cursor`]). Unset,
903 /// the pointer is the I-beam over an editor or a selection scope and
904 /// the plain arrow over everything else — a clickable or draggable
905 /// node included — so a hand over a button, a grab over a handle
906 /// (`grabbing` while its drag runs), a splitter's resize arrows and a
907 /// disabled control's `notAllowed` are all the view's to declare. The
908 /// stock button declares `Pointer` itself.
909 pub cursor: Option<CursorShape>,
910
911 /// See [`EventSpec`]. `None` when the node declares none of it.
912 pub events: Option<Box<EventSpec>>,
913
914 /// See [`AnimSpec`]. `None` when the node declares none of it.
915 pub anim: Option<Box<AnimSpec>>,
916
917 /// See [`AccessSpec`]. `None` when the node declares none of it.
918 pub access: Option<Box<AccessSpec>>,
919
920 /// See [`InteractSpec`]. `None` when the node declares none of it.
921 pub interact: Option<Box<InteractSpec>>,
922}
923
924/// Event payloads a node declares. Boxed on `NodeSpec` because most
925/// nodes declare none.
926#[derive(Clone, Debug, Default, PartialEq)]
927pub struct EventSpec {
928 /// Payload emitted as a `UiEvent` when this node is clicked.
929 pub on_click: Option<Value>,
930 /// Makes this node draggable: pressing it starts a pointer-captured
931 /// drag, and cursor motion until release emits `UiEvent`s of the form
932 /// `{kind="drag", phase="start"|"move"|"end", x, y, dx, dy, tag}` with
933 /// this payload merged in under `tag`. A drag past the click slop
934 /// suppresses the node's `on_click`, so both can coexist.
935 pub on_drag: Option<Value>,
936 /// Marks this node as a key sink: while it holds key focus, key
937 /// presses arrive as `UiEvent`s on it as `{kind="key", phase="down",
938 /// code, ...}`, with this payload merged in under `tag`. Clicking the
939 /// node takes key focus. Releases are not delivered unless the sink
940 /// also declares [`key_up`](Self::key_up): a keymap is the common
941 /// case, and a keymap that heard both halves would run every binding
942 /// twice.
943 pub on_key: Option<Value>,
944 /// With `on_key`: the sink hears releases too, as the same payload
945 /// with `phase="up"` (`text` null, `repeat` false). For a held-key
946 /// interaction — WASD, press-and-hold to preview, a key that arms a
947 /// mode while it is down. A key only comes up where it went down: a
948 /// release whose press the sink never got is dropped, and focus
949 /// leaving while a key is held delivers the `up` first, so nothing is
950 /// left stuck down. Without it a sink hears presses only, which is
951 /// what a keymap wants.
952 pub key_up: bool,
953 /// With `on_key`: the modifier and lock keys themselves arrive too
954 /// (Shift, Ctrl, Alt, Super, Caps Lock, Num Lock, Scroll Lock), as
955 /// codes of their own with their side in `location`.
956 /// Without it a modifier is only ever held — in the next key's
957 /// `shift` / `ctrl` / … and the `modifiers` event — so a keymap
958 /// mid-sequence does not read Shift as a key between two others. A
959 /// terminal speaking kitty's keyboard protocol asks, and so does a
960 /// game that binds a lone Shift.
961 pub modifier_keys: bool,
962 /// Asks for a context menu: a secondary-button press over this node
963 /// emits `{kind="contextmenu", x, y, tag}` on it with this payload
964 /// under `tag`, and does nothing else — the press moves no focus,
965 /// places no caret and produces no click, so right-clicking a
966 /// selection leaves it selected. `x`/`y` are the press in logical
967 /// viewport coordinates, which is where the menu goes. Asked of the
968 /// topmost node under the pointer; when that node offers no menu the
969 /// press reaches the nearest enclosing node that does, the way an
970 /// unclaimed key reaches the enclosing sink:
971 /// the event carries the owner's key and tag, a nested declaration
972 /// wins over its ancestor's, a disabled node's own is skipped, and
973 /// the walk stops at the modal boundary. Null = the behaviour without
974 /// a tag.
975 pub on_context_menu: Option<Value>,
976 /// Force-click events: a press that deepened past the second stage of
977 /// a Force Touch trackpad over this node emits `{kind="forceclick",
978 /// x, y, tag}` with this payload under `tag`. Routed as a secondary
979 /// press is — no focus moved, no caret, no click — but asked of the
980 /// topmost node only, with no walk to an enclosing declaration — and
981 /// the ordinary click the press produces still follows,
982 /// which is what macOS does.
983 ///
984 /// Text does not need this: a force click over an editor or a
985 /// `selectable` scope selects the word and asks the host to look it
986 /// up, which is what the gesture means on that platform. This is for
987 /// what the core cannot guess — a force click on a chart, a map, a
988 /// timeline.
989 pub on_force_click: Option<Value>,
990 /// The non-primary buttons as events: a press of a
991 /// button in [`buttons`](Self::buttons) over this node emits
992 /// `{kind="button", phase="press", button, x, y, clicks, tag}` on it
993 /// with this payload under `tag`, and the button is then captured by
994 /// the node — every pointer move while it is held arrives as
995 /// `phase="move"` and its release as `phase="release"`, on this node
996 /// wherever the pointer is. `button` is `"secondary"`, `"middle"` or,
997 /// for a button past those, its [`crate::MouseButton::code`]; `x`/`y`
998 /// are logical viewport coordinates, and on a `cells` grid the events
999 /// carry `cell: {row, col}` as a click does. Several buttons may be
1000 /// held at once, each its own capture; a primary drag is untouched.
1001 ///
1002 /// Asked of the topmost node under the pointer, and when that node
1003 /// claims no such button the press reaches the nearest enclosing node
1004 /// that does, as a context menu's does: a disabled node's own is
1005 /// skipped and the walk stops at the modal boundary. A claimed
1006 /// secondary press is this event *instead of* a `contextmenu` event
1007 /// and the stock menu — a nearer `on_context_menu` still wins, being
1008 /// the nested declaration. Like every non-primary press it moves no
1009 /// focus, places no caret and touches no selection or scrollbar. What
1010 /// it is for: a terminal's middle-click paste, and the mouse reports a
1011 /// program in it asked for. Null = the behaviour without a tag.
1012 pub on_button: Option<Value>,
1013 /// Which non-primary buttons [`on_button`](Self::on_button) claims:
1014 /// all three kinds unless the node says otherwise. A pane that wants
1015 /// the middle button and leaves the secondary one to its context menu
1016 /// says [`Buttons::MIDDLE`].
1017 pub buttons: Buttons,
1018 /// Scroll events: the wheel over this node emits `{kind="scroll", x,
1019 /// y, dx, dy, lines, tag}` with this payload under `tag` — the delta
1020 /// in logical px as the driver reported it (positive `dy` is the wheel
1021 /// rolling up, toward earlier content), the pointer's position, and
1022 /// on a `cells` grid the whole lines the delta covers (`null` on any
1023 /// other node), the fraction carried to the next notch. The node
1024 /// *takes* the wheel on the axes [`scroll_axes`](Self::scroll_axes)
1025 /// names: a scroll gesture that starts over it is its own, and stays
1026 /// its own until it ends wherever the pointer goes, except on an axis
1027 /// it also scrolls as a container (`scroll_x`, `scroll_y`, the offset
1028 /// the app sets from what it hears), where it is answered by its room
1029 /// as a container is: at its edge, a gesture that way passes to the
1030 /// scroller around it; it
1031 /// reaches no scroll container above it, and a container inside it
1032 /// still takes the axes it scrolls while it can move that way,
1033 /// passing this node the rest: the other axis, and a gesture that
1034 /// begins with the container at its limit (unless it says
1035 /// [`Overscroll::Contain`]). The core moves nothing — a grid's
1036 /// `origin_line` and a canvas's zoom are the app's to change. A
1037 /// drag-select held past a grid's top or bottom edge arrives here
1038 /// too, as the lines the frame scrolled by.
1039 pub on_scroll: Option<Value>,
1040 /// Which axes [`on_scroll`](Self::on_scroll) takes: both unless the
1041 /// node says otherwise. A scroll gesture on an axis
1042 /// the node does not take passes it by, to the scroller around it —
1043 /// a terminal that scrolls its history on `y` says
1044 /// [`ScrollAxes::Y`], and a sideways swipe that meets it goes on
1045 /// moving the strip it sits in. Meaningless without `on_scroll`.
1046 pub scroll_axes: ScrollAxes,
1047 /// The modifiers [`on_scroll`](Self::on_scroll) is for (backlog
1048 /// F122): with any named, the node hears only a scroll gesture that
1049 /// began with one of them held — and hears it *first*, wherever in
1050 /// the tree under the pointer the gesture began: ahead of every
1051 /// scroll container and every handler that names none, the innermost
1052 /// such node winning. A wheel with none of them held passes it by as
1053 /// if it declared no `on_scroll` — a node that is a scroll container
1054 /// too scrolls for it as any other does. What a Ctrl-wheel zoom is declared
1055 /// with, on the window's root or on the one canvas it zooms: a
1056 /// modified wheel is the more specific ask, and no list under the
1057 /// pointer scrolls for it. Its events carry `mods`, the modifiers
1058 /// held when the gesture began — the gesture stays this node's to
1059 /// its end, glide included, whatever is let go meanwhile. None named
1060 /// (the default): a handler like any other. Meaningless without
1061 /// `on_scroll`.
1062 pub scroll_mods: crate::input::KeyMods,
1063 /// Hover events: the pointer entering or leaving this node emits
1064 /// `{kind="hover", phase="enter"|"leave", tag}` with this payload under
1065 /// `tag` — for hover-dependent *layout* (a close button that appears)
1066 /// where a color swap isn't enough. Implies hover tracking.
1067 pub on_hover: Option<Value>,
1068 /// Drop-zone events: files dragged in from the OS over this node emit
1069 /// `{kind="drop", phase="enter"|"move"|"leave"|"drop", paths, x, y,
1070 /// tag}` with this payload under `tag` — `paths` the OS paths as
1071 /// strings, `x`/`y` the pointer in viewport coordinates (absent on
1072 /// `leave`). The zone under the files is the topmost *zone* by paint
1073 /// order: a node inside a zone resolves to it, and a node that is no
1074 /// zone and has none enclosing it is looked past, so an overlay shown
1075 /// on `enter` cannot make the zone lose the files. No `leave` follows
1076 /// a `drop`. Implies hover tracking.
1077 pub on_drop: Option<Value>,
1078 /// Layout events: the rect layout gave this node arrives as
1079 /// `{kind="layout", x, y, w, h, parent: {x, y, w, h}, tag}` (logical px,
1080 /// viewport coordinates, after scrolling and position easing) — on the
1081 /// node's first frame and again whenever the rect changes, never on a
1082 /// frame that left it alone. The view reads the numbers layout already
1083 /// produced instead of re-deriving them; a transition that moves the
1084 /// node reports every frame it moves. Needs a stable key across frames.
1085 pub on_layout: Option<Value>,
1086 /// Slider changes: on a node whose role is `Slider`, the core turns a
1087 /// press into the value under the pointer, a drag into the value under
1088 /// it, the arrows and assistive technology's Increment / Decrement
1089 /// into one `value_step`, PageUp / PageDown into ten, Home / End into
1090 /// the range's ends — clamped to `value_min..value_max`, snapped to the
1091 /// step — and emits `{kind="change", value, phase="move"|"end", tag}`
1092 /// with this payload under `tag`. The value is proposed, never
1093 /// applied: nothing moves until the view declares it as `value_now`.
1094 /// Without it a slider's keys reach the app as the `access` nudge.
1095 /// Ignored on any other role.
1096 pub on_change: Option<Value>,
1097 /// Modal: while this node is declared, the Tab ring is its subtree,
1098 /// everything outside it is inert to the pointer, the wheel and
1099 /// assistive technology, and Escape or a press outside emits
1100 /// `{kind="dismiss", reason, tag}` on it with this payload under
1101 /// `tag`. The last node declaring it in tree order is the one in
1102 /// effect (a confirm inside a dialog). Null = modal without a tag.
1103 pub modal: Option<Value>,
1104 /// A press on this node, or anywhere inside it, leaves keyboard focus
1105 /// where it was (`keepFocus`): a toolbar button, a tab, a divider
1106 /// that acts without taking the keyboard from the editor beside it.
1107 /// Its click, drag and hover are unchanged, and Tab
1108 /// and assistive technology still reach a focusable node in it — it
1109 /// is the pointer's press alone that stops moving focus.
1110 pub keep_focus: bool,
1111 /// Keyboard focus entering or leaving this node's subtree — the node
1112 /// itself or anything focused inside it — emits `{kind="focus",
1113 /// phase="in"|"out", by, tag}` with this payload under `tag`, where
1114 /// `by` is `"pointer"`, `"keyboard"`, `"assistive"` or `"program"`:
1115 /// what moved it. Reported once the move has settled —
1116 /// after the input that made it, or at the end of the frame that
1117 /// declared it — so a view reads a change instead of diffing
1118 /// `key_focus` every frame. Declares nothing interactive.
1119 pub on_focus: Option<Value>,
1120}
1121
1122impl EventSpec {
1123 /// The group as a node that declares none of it — what
1124 /// `NodeSpec`'s accessor hands back when the box is `None`.
1125 pub const EMPTY: Self = Self {
1126 on_click: None,
1127 on_drag: None,
1128 on_key: None,
1129 key_up: false,
1130 modifier_keys: false,
1131 on_context_menu: None,
1132 on_force_click: None,
1133 on_button: None,
1134 buttons: Buttons::ALL,
1135 on_scroll: None,
1136 scroll_axes: ScrollAxes::Both,
1137 scroll_mods: crate::input::KeyMods::NONE,
1138 on_hover: None,
1139 on_drop: None,
1140 on_layout: None,
1141 on_change: None,
1142 modal: None,
1143 keep_focus: false,
1144 on_focus: None,
1145 };
1146}
1147
1148/// Per-node animation declarations. Boxed on `NodeSpec`: `enter` and
1149/// `exit` are 60 bytes each and almost every node has neither.
1150#[derive(Clone, Debug, Default, PartialEq)]
1151pub struct AnimSpec {
1152 /// CSS-style stops for the animatable slots (see [`crate::keyframes`]):
1153 /// with a `transition`, the slots a stop names cycle through the stops
1154 /// over the transition's duration, in its `repeat` direction, offset by
1155 /// its `delay_ms` — forever, and without the view redrawing. Slots no
1156 /// stop names still tween toward what the view declares. Empty = none.
1157 pub keyframes: Vec<Keyframe>,
1158 /// Where this node's slots start the first frame it is seen (see
1159 /// [`crate::enter`]): with a `transition`, the slots it names ease in
1160 /// from there instead of snapping — `dx`/`dy` slide the node in from
1161 /// that far away, `bg` fades it in. A node that vanishes and returns
1162 /// enters again. None = first sight snaps.
1163 pub enter: Option<Enter>,
1164 /// Where this node's slots *end* the frame after the view stops
1165 /// declaring it (see [`crate::depart`]). An exit is an [`Enter`] read
1166 /// the other way: with a `transition`, the departing subtree is copied
1167 /// out of the last frame that had it and replayed — frozen where
1168 /// layout left it, on top, inert — while the slots this names ease
1169 /// from where they were toward what it declares. Needs a stable key
1170 /// across frames, and a `transition` with a duration; without both, a
1171 /// removed node vanishes at once as it always did.
1172 pub exit: Option<Enter>,
1173}
1174
1175impl AnimSpec {
1176 /// The group as a node that declares none of it — what
1177 /// `NodeSpec`'s accessor hands back when the box is `None`.
1178 pub const EMPTY: Self = Self {
1179 keyframes: Vec::new(),
1180 enter: None,
1181 exit: None,
1182 };
1183}
1184
1185/// Accessibility properties a view states outright, as opposed to the
1186/// ones the core derives (see [`crate::access`]). Boxed on `NodeSpec`:
1187/// read only while an access tree is being built, and unset on nearly
1188/// every node.
1189#[derive(Clone, Debug, Default, PartialEq)]
1190pub struct AccessSpec {
1191 /// What this node is to assistive technology (see [`crate::access`]).
1192 /// Unset, the core derives one: a node with `on_click` is a button,
1193 /// an editor a text input, a scrolling container a scroll view, and
1194 /// a plain box is structure that leaves no trace. `Role::None` hides
1195 /// the node and its subtree from the access tree (decoration).
1196 pub role: Option<Role>,
1197 /// The accessible name. Without one a button, link, tab or heading is
1198 /// named by the text inside it; an image or an icon button has no
1199 /// name at all, and the core says so (`control-without-name`,
1200 /// `image-without-label` warnings).
1201 pub label: Option<Label>,
1202 /// The accessible description, read after the name — what the
1203 /// `description` prop sets, and what the `tooltip` prop sets on the way
1204 /// to drawing the same string.
1205 pub description: Option<Label>,
1206 /// For checkbox / radio / switch roles: the on state.
1207 pub checked: bool,
1208 /// For a checkbox: neither on nor off, like the select-all box over a
1209 /// list some of whose rows are selected. Wins over `checked`, which it
1210 /// leaves as it was.
1211 pub mixed: bool,
1212 /// The current one of a set: a `Role::Tab`, a picked `Role::ListItem`,
1213 /// the `Role::Link` for the page you are on. A tab reports the state
1214 /// either way; a row or a link reports it only where it is set (see
1215 /// [`crate::access`]).
1216 pub selected: bool,
1217 /// For a node that shows and hides something: expanded, or collapsed.
1218 /// None = it does not expand, and says nothing about it.
1219 pub expanded: Option<bool>,
1220 /// For a slider role: the current value and its range, so assistive
1221 /// technology can read the position (the drawing stays the view's).
1222 pub value_now: Option<f32>,
1223 pub value_min: Option<f32>,
1224 pub value_max: Option<f32>,
1225 /// For a slider role: what the position *reads as* (ARIA's
1226 /// `aria-valuetext`). Without one a reader has only the three numbers
1227 /// above and says a percentage — 25 in [5..60] is "36 percent" — so a
1228 /// value whose unit matters says it here: "25 minutes". It replaces
1229 /// the number rather than joining it (see [`crate::access`]), and a
1230 /// nudge announces the new text, not the new number.
1231 pub value_text: Option<Label>,
1232 /// For a slider role: how far one arrow key moves it, and the grid a
1233 /// value set by the pointer snaps to. None = a hundredth of the range.
1234 pub value_step: Option<f32>,
1235 /// On a `Role::Line` of a custom editor: the caret's byte offset into
1236 /// the line's text, and the byte offset of the selection's other end
1237 /// (see [`crate::access`]).
1238 pub caret: Option<u32>,
1239 pub selection_anchor: Option<u32>,
1240 /// With `caret`: the caret this line declares does not blink — a
1241 /// block caret in a modal editor's normal mode — so a driver's blink
1242 /// clock is not armed on it (`Core::has_caret` leaves it out) while
1243 /// the offset still anchors the IME and reads to assistive
1244 /// technology. Without it a declared caret is a caret to blink.
1245 pub caret_solid: bool,
1246 /// Float `description` below the node while it is hovered — the
1247 /// `tooltip` prop's third effect, set by [`NodeSpec::tooltip`]. The core
1248 /// reads it as the node opens (`Core::hint`); a binding that lowers the
1249 /// prop floats the hint itself and leaves this off.
1250 pub tooltip: bool,
1251 /// When the text inside this node changes, a reader reads the change
1252 /// without being asked (ARIA's `aria-live`). Off by default; a node
1253 /// that declares it is semantic, so a plain box marked live is not
1254 /// elided.
1255 pub live: Live,
1256}
1257
1258impl AccessSpec {
1259 /// The group as a node that declares none of it — what
1260 /// `NodeSpec`'s accessor hands back when the box is `None`.
1261 pub const EMPTY: Self = Self {
1262 role: None,
1263 label: None,
1264 description: None,
1265 checked: false,
1266 mixed: false,
1267 selected: false,
1268 expanded: None,
1269 value_now: None,
1270 value_min: None,
1271 value_max: None,
1272 value_text: None,
1273 value_step: None,
1274 caret: None,
1275 selection_anchor: None,
1276 caret_solid: false,
1277 tooltip: false,
1278 live: Live::Off,
1279 };
1280}
1281
1282/// Hover / pressed / focus styling and the sounds that go with them.
1283/// Boxed on `NodeSpec` so the common node — which declares none of it —
1284/// costs one null check in `resolve_hover_style` instead of reading
1285/// several `Option`s spread across the struct.
1286#[derive(Clone, Debug, Default, PartialEq)]
1287pub struct InteractSpec {
1288 /// Background while the pointer hovers this node (or any node sharing
1289 /// its `hover_group`). Resolved by the core when the node opens, so a
1290 /// data-only view gets hover styling without querying `is_hovered` —
1291 /// and with `transition` the swap eases. Implies hover tracking.
1292 pub hover_bg: Option<Color>,
1293 /// Background while this node (or its group) is pressed. Implies hover
1294 /// tracking. Without a `hover_bg`, hover keeps the plain `bg`. An
1295 /// `on_drag` node holds this state for the whole captured drag, even
1296 /// while the cursor is off it.
1297 pub pressed_bg: Option<Color>,
1298 /// Hover group: nodes sharing an id count as one for `hover_bg` /
1299 /// `pressed_bg` — a two-piece elbow, a split button, a row whose cells
1300 /// highlight together. The id is a hash of a name (`hover_group`).
1301 /// Implies hover tracking.
1302 pub hover_group: Option<u64>,
1303 /// A registered sound played when this node is clicked (see
1304 /// [`crate::audio`]); the click itself still emits `on_click` if one is
1305 /// declared. Implies hover tracking.
1306 pub click_sound: Option<crate::resources::SoundId>,
1307 /// A registered sound played when the pointer enters this node.
1308 /// Implies hover tracking.
1309 pub hover_sound: Option<crate::resources::SoundId>,
1310 /// Background while this node holds keyboard-visible focus (focus
1311 /// moved by Tab or by assistive technology, not by a click).
1312 /// Declaring one replaces the ring the core draws by default. Pressed
1313 /// wins over focus wins over hover; eases with `transition`.
1314 pub focus_bg: Option<Color>,
1315 /// Background while files dragged in from the OS are over this node.
1316 /// Wins over pressed, focus and hover — a press
1317 /// cannot be held while the OS holds a drag — and eases with
1318 /// `transition`; clears when the files leave, land or the drag is
1319 /// cancelled. Implies hover tracking.
1320 pub drop_bg: Option<Color>,
1321 /// Makes this node a *selection scope*: the text of every node inside
1322 /// it is one selectable run of text, in tree order, and a press-drag
1323 /// inside it selects across all of them. Declared on the container
1324 /// rather than on each label, because what a reader selects is a
1325 /// paragraph or a card, not one run of it.
1326 ///
1327 /// Scopes do not nest: the innermost one containing a run owns it, and
1328 /// an outer one is warned about (`nested-selection-scope`). An `edit`
1329 /// is already its own scope and ignores this.
1330 pub selectable: bool,
1331 /// Makes this node's subtree a *focus region*: a Tab ring of its own
1332 /// that the ring outside never enters, and that never leaves — a
1333 /// devtools dock, an inspector beside the app. Entered on purpose:
1334 /// `Ui::focus_region`, a press inside it, or an explicit focus on a
1335 /// node in it. Nothing else about the node changes — it lays out,
1336 /// paints, takes the pointer and appears in the access tree as before,
1337 /// and keys bubble through it to the sink above.
1338 pub focus_region: bool,
1339 /// How this node's scrollbars look, when it scrolls (see
1340 /// [`Scrollbar`]). Cold: read once per scroller when its layer's
1341 /// chrome is emitted, which is why it lives in this box rather than
1342 /// beside `scroll_y` on every node.
1343 pub scrollbar: Scrollbar,
1344 /// Whether a scroll gesture that starts over this scroller while it
1345 /// is at its limit that way goes on to the scroller around it (see
1346 /// [`Overscroll`]). Cold like `scrollbar`: read once
1347 /// per scroller a gesture starts over.
1348 pub overscroll: Overscroll,
1349 /// On a table: lines of this colour between its columns and between
1350 /// its rows, drawn with the table's own box, under its cells, down the
1351 /// middle of each gap, so a table with a `gap` of at least `rule_w`
1352 /// gets a grid with no rule cells. The
1353 /// columns come from the row with the most cells; the lines run the
1354 /// table's content box. Ignored on anything that is not a table.
1355 pub rules: Option<Color>,
1356 /// The rules' width in logical px; 0 is 1.
1357 pub rule_w: f32,
1358 /// A gradient painted over the node's `bg` and under its border and
1359 /// its children (`docs/adr/0042-a-gradient-is-an-image-the-core-paints.md`):
1360 /// one image quad from the atlas, rounded by the node's radius. It
1361 /// does not tween, and the state backgrounds replace `bg`, not it.
1362 pub gradient: Option<crate::gradient::Gradient>,
1363}
1364
1365/// A scrolling node's bars, per node. Every field's default is the stock
1366/// bar — the theme's `scrollbar` / `scrollbar_active` colours, 4 px at
1367/// rest and 6 px under the pointer, always drawn while the content
1368/// overflows — so a binding that sets none of the four rows gets exactly
1369/// what it always had. The bars are overlays and take no layout space
1370/// whatever their width; the grabbable track is at least as wide as the
1371/// active thumb plus its inset.
1372#[derive(Clone, Copy, Debug, Default, PartialEq)]
1373pub struct Scrollbar {
1374 /// Whether the bars are drawn at all, and when (see [`ScrollbarMode`]).
1375 pub mode: ScrollbarMode,
1376 /// The thumb's width at rest, logical px; under the pointer or dragged
1377 /// it is 2 px wider. `None` is the stock 4.
1378 pub width: Option<f32>,
1379 /// The thumb at rest; `None` is `theme.scrollbar`.
1380 pub color: Option<Color>,
1381 /// The thumb under the pointer or dragged; `None` is
1382 /// `theme.scrollbar_active`.
1383 pub active_color: Option<Color>,
1384}
1385
1386impl Scrollbar {
1387 /// The stock bar: visible, 4 px, in the theme's colours.
1388 pub const DEFAULT: Self = Self {
1389 mode: ScrollbarMode::Visible,
1390 width: None,
1391 color: None,
1392 active_color: None,
1393 };
1394}
1395
1396/// When a scrolling node's bars are drawn. Spelled by the `scrollbar` row
1397/// (`crate::schema::SCROLLBARS`, in this order).
1398#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1399pub enum ScrollbarMode {
1400 /// The stock bar: drawn whenever the content overflows.
1401 #[default]
1402 Visible,
1403 /// No thumb is drawn and no track takes the press. The wheel, the
1404 /// keyboard, `reveal` and the caret still scroll the node — a list
1405 /// drawing its own indicator, or one whose bar would sit on a border.
1406 Hidden,
1407 /// The bar shows while the scroll state is changing — the offset or
1408 /// the content's extent moved since the last frame, the pointer is on
1409 /// its track, or a thumb is being dragged — and for a second after,
1410 /// then fades out over a quarter of one. A node first seen shows its
1411 /// bar the same second. What an overlay bar does on macOS. Needs the
1412 /// driver's clock (`Core::set_time`); without one it is `Visible`,
1413 /// since a fade with no clock could never end.
1414 Auto,
1415}
1416
1417impl ScrollbarMode {
1418 /// Every mode, in the `scrollbar` row's order: what a binding that
1419 /// spells modes as numbers indexes (C's `KUI_SCROLLBAR_*` are these
1420 /// plus one).
1421 pub const ALL: [ScrollbarMode; 3] = [
1422 ScrollbarMode::Visible,
1423 ScrollbarMode::Hidden,
1424 ScrollbarMode::Auto,
1425 ];
1426}
1427
1428/// What a scroll gesture that starts over a scroller already at its limit
1429/// does: CSS's `overscroll-behavior`, spelled by the `overscroll` row.
1430///
1431/// A gesture picks its target when it starts: the innermost scroller
1432/// under the pointer that can still move the way it goes. One at its
1433/// limit is passed by, to the scroller around it — *chaining* — and
1434/// `Contain` stops that: the gesture is this scroller's, and moves
1435/// nothing until it turns back. Only on the axes the node scrolls, so a
1436/// `scroll_y` list that contains still passes a sideways swipe to the
1437/// strip it sits in, where CSS would stop that too. Decided at
1438/// the start only: a gesture that reaches a limit midway stops there
1439/// whatever this says, as a browser's does.
1440#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1441pub enum Overscroll {
1442 /// The gesture goes on to the scroller around this one when this one
1443 /// is at its limit that way.
1444 #[default]
1445 Auto,
1446 /// A gesture that starts here stays here: a panel, a popup's list or
1447 /// a sheet whose scrolling must never move the page behind it.
1448 Contain,
1449}
1450
1451impl Overscroll {
1452 /// Every value, in the `overscroll` row's order (C's
1453 /// `KUI_OVERSCROLL_*` are these plus one).
1454 pub const ALL: [Overscroll; 2] = [Overscroll::Auto, Overscroll::Contain];
1455}
1456
1457/// Which axes an `on_scroll` node takes, spelled by the `scrollAxes` row.
1458#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1459pub enum ScrollAxes {
1460 /// Both: the node hears every scroll gesture that starts over it.
1461 #[default]
1462 Both,
1463 /// Only sideways; a vertical gesture passes it by.
1464 X,
1465 /// Only vertical; a sideways gesture passes it by — a terminal's
1466 /// history, a log.
1467 Y,
1468}
1469
1470impl ScrollAxes {
1471 /// Every value, in the `scrollAxes` row's order (C's
1472 /// `KUI_SCROLL_AXES_*` are these plus one).
1473 pub const ALL: [ScrollAxes; 3] = [ScrollAxes::Both, ScrollAxes::X, ScrollAxes::Y];
1474
1475 /// Whether the node takes `x` (true) or `y` (false).
1476 pub fn takes(self, x: bool) -> bool {
1477 match self {
1478 ScrollAxes::Both => true,
1479 ScrollAxes::X => x,
1480 ScrollAxes::Y => !x,
1481 }
1482 }
1483}
1484
1485impl InteractSpec {
1486 /// The group as a node that declares none of it — what
1487 /// `NodeSpec`'s accessor hands back when the box is `None`.
1488 pub const EMPTY: Self = Self {
1489 hover_bg: None,
1490 pressed_bg: None,
1491 hover_group: None,
1492 click_sound: None,
1493 hover_sound: None,
1494 focus_bg: None,
1495 drop_bg: None,
1496 selectable: false,
1497 focus_region: false,
1498 scrollbar: Scrollbar::DEFAULT,
1499 overscroll: Overscroll::Auto,
1500 rules: None,
1501 rule_w: 0.0,
1502 gradient: None,
1503 };
1504}
1505
1506impl NodeSpec {
1507 // -- Boxed groups ------------------------------------------------------
1508 // The four cold groups are behind a pointer each: a node that
1509 // declares none of a group pays 8 bytes for it rather than its full
1510 // width. Reads go through the `&` accessor, which hands back a shared
1511 // empty group instead of allocating, so a caller reads
1512 // `spec.events().on_click` exactly as it used to read `spec.on_click`.
1513 // Writes go through the `_mut` accessor, which allocates on first use.
1514
1515 /// Event payloads this node declares, empty if it declares none.
1516 #[inline]
1517 pub fn events(&self) -> &EventSpec {
1518 static EMPTY: EventSpec = EventSpec::EMPTY;
1519 self.events.as_deref().unwrap_or(&EMPTY)
1520 }
1521
1522 /// Allocates the group on first write.
1523 #[inline]
1524 pub fn events_mut(&mut self) -> &mut EventSpec {
1525 self.events.get_or_insert_with(Box::default)
1526 }
1527
1528 /// Animation declarations, empty if this node has none.
1529 #[inline]
1530 pub fn anim(&self) -> &AnimSpec {
1531 static EMPTY: AnimSpec = AnimSpec::EMPTY;
1532 self.anim.as_deref().unwrap_or(&EMPTY)
1533 }
1534
1535 /// Allocates the group on first write.
1536 #[inline]
1537 pub fn anim_mut(&mut self) -> &mut AnimSpec {
1538 self.anim.get_or_insert_with(Box::default)
1539 }
1540
1541 /// Declared accessibility properties, empty if this node declares none.
1542 #[inline]
1543 pub fn access(&self) -> &AccessSpec {
1544 static EMPTY: AccessSpec = AccessSpec::EMPTY;
1545 self.access.as_deref().unwrap_or(&EMPTY)
1546 }
1547
1548 /// Allocates the group on first write.
1549 #[inline]
1550 pub fn access_mut(&mut self) -> &mut AccessSpec {
1551 self.access.get_or_insert_with(Box::default)
1552 }
1553
1554 /// Hover / pressed / focus styling, empty if this node declares none.
1555 #[inline]
1556 pub fn interact(&self) -> &InteractSpec {
1557 static EMPTY: InteractSpec = InteractSpec::EMPTY;
1558 self.interact.as_deref().unwrap_or(&EMPTY)
1559 }
1560
1561 /// Allocates the group on first write.
1562 #[inline]
1563 pub fn interact_mut(&mut self) -> &mut InteractSpec {
1564 self.interact.get_or_insert_with(Box::default)
1565 }
1566
1567 /// Whether the core registers a hit region for this node (any of the
1568 /// interaction props, or an explicit `hoverable`).
1569 pub fn hover_tracked(&self) -> bool {
1570 // Asked of every node at emission; the inline flags first, then
1571 // each boxed group once — a node that declares neither group is
1572 // answered by two null checks rather than a read per field.
1573 self.hoverable
1574 || self.focusable
1575 || self.window.is_some()
1576 // A `cursor` override has to be found under the pointer to be
1577 // read, even on an otherwise inert box.
1578 || self.cursor.is_some()
1579 || self.events.as_deref().is_some_and(|e| {
1580 // A modal's own background is not "outside" it: a press
1581 // there must find a region.
1582 e.modal.is_some()
1583 || e.on_click.is_some()
1584 || e.on_drag.is_some()
1585 || e.on_key.is_some()
1586 || e.on_context_menu.is_some()
1587 || e.on_force_click.is_some()
1588 || e.on_button.is_some()
1589 || e.on_hover.is_some()
1590 || e.on_drop.is_some()
1591 || e.on_change.is_some()
1592 })
1593 || self.interact.as_deref().is_some_and(|i| {
1594 i.hover_bg.is_some()
1595 || i.pressed_bg.is_some()
1596 || i.drop_bg.is_some()
1597 || i.hover_group.is_some()
1598 || i.click_sound.is_some()
1599 || i.hover_sound.is_some()
1600 // A selection scope has to be found under the pointer:
1601 // the press that starts a drag-select lands on it.
1602 || i.selectable
1603 // So does a focus region: a press on its dead space
1604 // settles the ring there.
1605 || i.focus_region
1606 })
1607 }
1608
1609 /// The group id `hover_group(name)` assigns — reproducible from any
1610 /// binding (the same FNV mix as `Key`).
1611 pub fn hover_group_id(name: &str) -> u64 {
1612 crate::key::Key::ROOT.str(name).0
1613 }
1614
1615 /// A container that lays its children out left to right.
1616 pub fn row() -> Self {
1617 Self {
1618 layout: LayoutSpec {
1619 dir: Dir::Row,
1620 ..Default::default()
1621 },
1622 ..Default::default()
1623 }
1624 }
1625
1626 /// A container that lays its children out top to bottom (the default).
1627 pub fn column() -> Self {
1628 Self {
1629 layout: LayoutSpec {
1630 dir: Dir::Column,
1631 ..Default::default()
1632 },
1633 ..Default::default()
1634 }
1635 }
1636
1637 /// A table: a column whose rows' children line up in columns. Its
1638 /// in-flow `Row` children are the rows and each row's in-flow children
1639 /// its cells; the nth cell of every row is column n, and a column is
1640 /// as wide as its widest cell, so a label column sits at its longest
1641 /// label with no width picked by hand.
1642 ///
1643 /// A cell's `width` says how its column sizes: `Fit` (the default) and
1644 /// `Fixed` are content the column's fit width is the max of, `Grow`
1645 /// makes the whole column grow with the table, and a column's
1646 /// `min_width` / `max_width` are the strictest its cells declared.
1647 /// Give the rows `width: grow` for the columns to grow into; a `Fit`
1648 /// row sits at the columns' fit width. Rows keep their own `gap`,
1649 /// padding, background, click and hover, and never wrap. A bare text
1650 /// or image straight inside a row is a cell too. A text, a column or a
1651 /// table straight under the table is a child with its own width and no
1652 /// cells. Everything else is a column's: `gap` is the space between
1653 /// rows, `scroll_y` scrolls them.
1654 ///
1655 /// ```rust
1656 /// use kui_core::{NodeSpec, Sizing};
1657 /// let table = NodeSpec::table().gap(4.0).rules(kui_core::Color::hex(0x80808080));
1658 /// let row = NodeSpec::row().width(Sizing::GROW).gap(12.0);
1659 /// assert!(table.layout.is_table() && !row.layout.is_table());
1660 /// ```
1661 pub fn table() -> Self {
1662 Self {
1663 layout: LayoutSpec {
1664 dir: Dir::Column,
1665 table: true,
1666 ..Default::default()
1667 },
1668 ..Default::default()
1669 }
1670 }
1671
1672 /// A [`Sizing`], or a number of px (`.width(120.0)`).
1673 #[inline]
1674 pub fn width(mut self, s: impl Into<Sizing>) -> Self {
1675 self.layout.width = s.into();
1676 self
1677 }
1678
1679 /// A [`Sizing`], or a number of px (`.height(24.0)`).
1680 #[inline]
1681 pub fn height(mut self, s: impl Into<Sizing>) -> Self {
1682 self.layout.height = s.into();
1683 self
1684 }
1685
1686 /// Both axes at once: `.size(20.0, 20.0)` for a fixed box,
1687 /// `.size(Sizing::GROW, 24.0)` for a strip.
1688 #[inline]
1689 pub fn size(self, w: impl Into<Sizing>, h: impl Into<Sizing>) -> Self {
1690 self.width(w).height(h)
1691 }
1692
1693 /// An equal share of the leftover width: `.width(Sizing::GROW)`.
1694 #[inline]
1695 pub fn grow_width(self) -> Self {
1696 self.width(Sizing::GROW)
1697 }
1698
1699 /// An equal share of the leftover height: `.height(Sizing::GROW)`.
1700 #[inline]
1701 pub fn grow_height(self) -> Self {
1702 self.height(Sizing::GROW)
1703 }
1704
1705 /// Grow along both axes.
1706 #[inline]
1707 pub fn fill(self) -> Self {
1708 self.grow_width().grow_height()
1709 }
1710
1711 /// A number of px, [`Min::FIT`] for the node's own fit width, or a
1712 /// [`Bound::Calc`].
1713 pub fn min_width(mut self, v: impl Into<Bound>) -> Self {
1714 self.layout.min_w = match v.into() {
1715 Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1716 Bound::Px(px) => Min::px(px),
1717 Bound::Fit => Min::FIT,
1718 Bound::Calc(c) => Min::calc(c),
1719 };
1720 self
1721 }
1722
1723 /// A number of px, or a [`Bound::Calc`]; a max has no fit size, so
1724 /// [`Bound::Fit`] is no clamp. A px ceiling below zero, or `NaN`, is
1725 /// a ceiling of 0 ([`px_ceiling`]).
1726 pub fn max_width(mut self, v: impl Into<Bound>) -> Self {
1727 self.layout.max_w = match v.into() {
1728 Bound::Px(px) => px_ceiling(px),
1729 Bound::Fit => f32::INFINITY,
1730 Bound::Calc(c) => max_of_calc(c),
1731 };
1732 self
1733 }
1734
1735 /// A number of px, [`Min::FIT`] for the node's own fit height, or a
1736 /// [`Bound::Calc`].
1737 pub fn min_height(mut self, v: impl Into<Bound>) -> Self {
1738 self.layout.min_h = match v.into() {
1739 Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1740 Bound::Px(px) => Min::px(px),
1741 Bound::Fit => Min::FIT,
1742 Bound::Calc(c) => Min::calc(c),
1743 };
1744 self
1745 }
1746
1747 /// The four clamps where each is given, a transport's shape (C's
1748 /// `*_size` fields): `None` leaves that clamp as it is.
1749 pub fn with_bounds(
1750 self,
1751 min_w: Option<Bound>,
1752 max_w: Option<Bound>,
1753 min_h: Option<Bound>,
1754 max_h: Option<Bound>,
1755 ) -> Self {
1756 let mut s = self;
1757 if let Some(b) = min_w {
1758 s = s.min_width(b);
1759 }
1760 if let Some(b) = max_w {
1761 s = s.max_width(b);
1762 }
1763 if let Some(b) = min_h {
1764 s = s.min_height(b);
1765 }
1766 if let Some(b) = max_h {
1767 s = s.max_height(b);
1768 }
1769 s
1770 }
1771
1772 /// Clip children to this node's rect without scrolling. A `radius` on
1773 /// the same node rounds the clip, so children stay inside its corners
1774 /// (see `display::Clip`).
1775 pub fn clip(mut self) -> Self {
1776 self.layout.clip = true;
1777 self
1778 }
1779
1780 /// Vertical scrolling (and clipping) for overflowing content.
1781 pub fn scroll_y(mut self) -> Self {
1782 self.layout.scroll_y = true;
1783 self
1784 }
1785
1786 /// Horizontal scrolling (and clipping) for overflowing content.
1787 pub fn scroll_x(mut self) -> Self {
1788 self.layout.scroll_x = true;
1789 self
1790 }
1791
1792 /// Scroll anchoring on this container (see [`LayoutSpec::anchor`]):
1793 /// the first child in view stays where it is on screen when the
1794 /// content before it changes size. Needs `scroll_y` on a column or
1795 /// `scroll_x` on a row.
1796 pub fn anchor(mut self) -> Self {
1797 self.layout.anchor = true;
1798 self
1799 }
1800
1801 /// Take this node out of flex flow; see [`FloatConfig`].
1802 pub fn float(mut self, cfg: FloatConfig) -> Self {
1803 self.layout.float = Some(cfg);
1804 self
1805 }
1806
1807 /// Apply the overflow bits ([`OVERFLOW_CLIP`] and friends). What a bit
1808 /// means is decided here: a binding ORs together whatever its own
1809 /// surface spells (`clip`, `scrollX`, `overflow`) and hands the number
1810 /// over, rather than each one re-deciding that scrolling clips too.
1811 pub fn overflow_bits(mut self, bits: u32) -> Self {
1812 if bits & OVERFLOW_CLIP != 0 {
1813 self = self.clip();
1814 }
1815 if bits & OVERFLOW_SCROLL_X != 0 {
1816 self = self.scroll_x();
1817 }
1818 if bits & OVERFLOW_SCROLL_Y != 0 {
1819 self = self.scroll_y();
1820 }
1821 self
1822 }
1823
1824 /// A tooltip: the node tracks hover, `hint` is its accessible
1825 /// description, and the core floats the hint below it while it is
1826 /// hovered. The float is the node's last child, so it is drawn for a
1827 /// box or a fragment; on a leaf (an image, an editor, a cells grid) the
1828 /// hint is tracked and spoken, not drawn: put the tooltip on a box
1829 /// around the leaf.
1830 #[inline]
1831 pub fn tooltip(self, hint: &str) -> Self {
1832 let mut spec = self.apply_tooltip(hint);
1833 spec.access_mut().tooltip = true;
1834 spec
1835 }
1836
1837 /// The spec half of the `tooltip` prop: the hint is hover-gated, so the
1838 /// node tracks hover, and it is what assistive technology should say, so
1839 /// it is the accessible description too — and nothing floats. For a
1840 /// caller that floats the hint itself: [`crate::schema::PropsOut::apply_tooltip`]
1841 /// for the parsers, `kui_close` for C, a widget that draws its own. A
1842 /// Rust view wants [`Self::tooltip`], which is all three.
1843 pub fn apply_tooltip(self, hint: &str) -> Self {
1844 self.hoverable().description(hint)
1845 }
1846
1847 /// A number of px, or a [`Bound::Calc`]; [`Bound::Fit`] is no clamp.
1848 /// A px ceiling below zero, or `NaN`, is a ceiling of 0.
1849 pub fn max_height(mut self, v: impl Into<Bound>) -> Self {
1850 self.layout.max_h = match v.into() {
1851 Bound::Px(px) => px_ceiling(px),
1852 Bound::Fit => f32::INFINITY,
1853 Bound::Calc(c) => max_of_calc(c),
1854 };
1855 self
1856 }
1857
1858 /// The same padding on all four edges, logical px.
1859 pub fn pad(mut self, v: f32) -> Self {
1860 self.layout.padding = Edges::all(v);
1861 self
1862 }
1863
1864 /// Padding `x` on the left and right, `y` on the top and bottom.
1865 pub fn pad_xy(mut self, x: f32, y: f32) -> Self {
1866 self.layout.padding = Edges::xy(x, y);
1867 self
1868 }
1869
1870 /// Padding per edge.
1871 pub fn padding(mut self, e: Edges) -> Self {
1872 self.layout.padding = e;
1873 self
1874 }
1875
1876 /// Space between children along the main axis, logical px.
1877 pub fn gap(mut self, v: f32) -> Self {
1878 self.layout.gap = v;
1879 self
1880 }
1881
1882 /// Wrap overflowing children onto more lines; see [`LayoutSpec::wrap`].
1883 pub fn wrap(mut self) -> Self {
1884 self.layout.wrap = true;
1885 self
1886 }
1887
1888 /// Space between wrap lines (across the main axis).
1889 pub fn cross_gap(mut self, v: f32) -> Self {
1890 self.layout.cross_gap = v;
1891 self
1892 }
1893
1894 /// Where children sit along the main axis; the spreads are allowed.
1895 pub fn main_align(mut self, a: Align) -> Self {
1896 self.layout.main_align = a;
1897 self
1898 }
1899
1900 /// Where children sit across the main axis; `Baseline` on a row.
1901 pub fn cross_align(mut self, a: Align) -> Self {
1902 self.layout.cross_align = a;
1903 self
1904 }
1905
1906 /// Width over height (CSS's `aspect-ratio`): see
1907 /// [`LayoutSpec::aspect`]. `16.0 / 9.0` for a video, `1.0` for a
1908 /// square. A ratio that is not positive and finite clears it.
1909 pub fn aspect_ratio(mut self, ratio: f32) -> Self {
1910 self.layout.aspect = if ratio.is_finite() && ratio > 0.0 {
1911 ratio
1912 } else {
1913 0.0
1914 };
1915 self
1916 }
1917
1918 /// Center children on both axes.
1919 pub fn center(self) -> Self {
1920 self.main_align(Align::Center).cross_align(Align::Center)
1921 }
1922
1923 /// The background colour.
1924 pub fn bg(mut self, c: Color) -> Self {
1925 self.style.bg = c;
1926 self
1927 }
1928
1929 /// Rounds all four corners by `r`. On a node that also clips or
1930 /// scrolls it rounds the clip too, so its children are cut to the same
1931 /// corners rather than poking square out of them.
1932 pub fn radius(mut self, r: f32) -> Self {
1933 self.style.radius = [r; 4];
1934 self
1935 }
1936
1937 /// Per-corner radii, clockwise from the top-left.
1938 pub fn radii(mut self, tl: f32, tr: f32, br: f32, bl: f32) -> Self {
1939 self.style.radius = [tl, tr, br, bl];
1940 self
1941 }
1942
1943 pub fn radius_tl(mut self, r: f32) -> Self {
1944 self.style.radius[corner::TL] = r;
1945 self
1946 }
1947
1948 pub fn radius_tr(mut self, r: f32) -> Self {
1949 self.style.radius[corner::TR] = r;
1950 self
1951 }
1952
1953 pub fn radius_br(mut self, r: f32) -> Self {
1954 self.style.radius[corner::BR] = r;
1955 self
1956 }
1957
1958 pub fn radius_bl(mut self, r: f32) -> Self {
1959 self.style.radius[corner::BL] = r;
1960 self
1961 }
1962
1963 /// Rounds the two top corners (tabs, headers).
1964 pub fn radius_top(self, r: f32) -> Self {
1965 self.radius_tl(r).radius_tr(r)
1966 }
1967
1968 /// Rounds the two bottom corners.
1969 pub fn radius_bottom(self, r: f32) -> Self {
1970 self.radius_br(r).radius_bl(r)
1971 }
1972
1973 /// A border `w` px wide in `c`, inside the node's box.
1974 pub fn border(mut self, w: f32, c: Color) -> Self {
1975 self.style.border_w = w;
1976 self.style.border_color = c;
1977 self
1978 }
1979
1980 /// Paints this node's background, border, shadow and fragment on whole pixels
1981 /// (see `VisualStyle::pixel_snap`).
1982 pub fn pixel_snap(mut self) -> Self {
1983 self.style.pixel_snap = true;
1984 self
1985 }
1986
1987 /// Fades this node and everything under it (see `VisualStyle::opacity`);
1988 /// clamped to 0..=1.
1989 pub fn opacity(mut self, o: f32) -> Self {
1990 self.style.opacity = o.clamp(0.0, 1.0);
1991 self
1992 }
1993
1994 /// The whole drop shadow at once: color, offset, blur, spread.
1995 pub fn shadow(mut self, shadow: Shadow) -> Self {
1996 self.style.shadow = shadow;
1997 self
1998 }
1999
2000 /// The shadow's color — on its own, a hard shadow exactly behind the
2001 /// node. Nothing else about a shadow draws without it.
2002 pub fn shadow_color(mut self, c: Color) -> Self {
2003 self.style.shadow.color = c;
2004 self
2005 }
2006
2007 pub fn shadow_blur(mut self, blur: f32) -> Self {
2008 self.style.shadow.blur = blur;
2009 self
2010 }
2011
2012 pub fn shadow_offset(mut self, dx: f32, dy: f32) -> Self {
2013 self.style.shadow.dx = dx;
2014 self.style.shadow.dy = dy;
2015 self
2016 }
2017
2018 pub fn shadow_x(mut self, dx: f32) -> Self {
2019 self.style.shadow.dx = dx;
2020 self
2021 }
2022
2023 pub fn shadow_y(mut self, dy: f32) -> Self {
2024 self.style.shadow.dy = dy;
2025 self
2026 }
2027
2028 pub fn shadow_spread(mut self, spread: f32) -> Self {
2029 self.style.shadow.spread = spread;
2030 self
2031 }
2032
2033 /// Hover-track this node without making it clickable; see the
2034 /// `hoverable` field.
2035 pub fn hoverable(mut self) -> Self {
2036 self.hoverable = true;
2037 self
2038 }
2039
2040 /// Ask for another frame after this one, for as long as this node is
2041 /// declared. See the `animate` prop.
2042 pub fn animate(mut self) -> Self {
2043 self.animate = true;
2044 self
2045 }
2046
2047 /// Background from the OS accent colour where the host knows it; see
2048 /// the field.
2049 pub fn accent(mut self) -> Self {
2050 self.accent = true;
2051 self
2052 }
2053
2054 /// Makes this node clickable: a click emits `payload` as a
2055 /// [`UiEvent`](crate::input::UiEvent), and the node joins the Tab ring
2056 /// and reads as a button to assistive technology.
2057 pub fn on_click(mut self, payload: impl Into<Value>) -> Self {
2058 self.events_mut().on_click = Some(payload.into());
2059 self
2060 }
2061
2062 /// Background while hovered (see the `hover_bg` field).
2063 pub fn hover_bg(mut self, c: Color) -> Self {
2064 self.interact_mut().hover_bg = Some(c);
2065 self
2066 }
2067
2068 /// Background while dragged files are over this node (see the
2069 /// `drop_bg` field).
2070 pub fn drop_bg(mut self, c: Color) -> Self {
2071 self.interact_mut().drop_bg = Some(c);
2072 self
2073 }
2074
2075 /// Paints `gradient` over this node's `bg`, under its border and
2076 /// its children (see the `gradient` field).
2077 pub fn gradient(mut self, gradient: crate::gradient::Gradient) -> Self {
2078 self.interact_mut().gradient = Some(gradient);
2079 self
2080 }
2081
2082 /// A table's grid rules in `c` (see the `rules` field).
2083 pub fn rules(mut self, c: Color) -> Self {
2084 self.interact_mut().rules = Some(c);
2085 self
2086 }
2087
2088 /// The rules' width in logical px; 1 when unset (see `rules`).
2089 pub fn rule_width(mut self, w: f32) -> Self {
2090 self.interact_mut().rule_w = w;
2091 self
2092 }
2093
2094 /// Makes this node a selection scope (see the `selectable` field):
2095 /// the text inside it becomes one selectable run.
2096 pub fn selectable(mut self) -> Self {
2097 self.interact_mut().selectable = true;
2098 self
2099 }
2100
2101 /// Makes this node's subtree a focus region (see the `focus_region`
2102 /// field): a Tab ring of its own, entered on purpose.
2103 pub fn focus_region(mut self) -> Self {
2104 self.interact_mut().focus_region = true;
2105 self
2106 }
2107
2108 /// Whether a scroll gesture starting over this scroller at its limit
2109 /// goes on to the one around it (see [`Overscroll`]):
2110 /// `Overscroll::Contain` keeps it here.
2111 pub fn overscroll(mut self, o: Overscroll) -> Self {
2112 self.interact_mut().overscroll = o;
2113 self
2114 }
2115
2116 /// When this node's scrollbars are drawn (see [`ScrollbarMode`]).
2117 /// Scrolling itself is unchanged whatever the mode.
2118 pub fn scrollbar(mut self, mode: ScrollbarMode) -> Self {
2119 self.interact_mut().scrollbar.mode = mode;
2120 self
2121 }
2122
2123 /// The thumb's width at rest, logical px (see [`Scrollbar::width`]).
2124 pub fn scrollbar_width(mut self, w: f32) -> Self {
2125 self.interact_mut().scrollbar.width = Some(w);
2126 self
2127 }
2128
2129 /// The thumb's colour at rest (see [`Scrollbar::color`]).
2130 pub fn scrollbar_color(mut self, c: Color) -> Self {
2131 self.interact_mut().scrollbar.color = Some(c);
2132 self
2133 }
2134
2135 /// The thumb's colour under the pointer or dragged (see
2136 /// [`Scrollbar::active_color`]).
2137 pub fn scrollbar_active_color(mut self, c: Color) -> Self {
2138 self.interact_mut().scrollbar.active_color = Some(c);
2139 self
2140 }
2141
2142 /// Background while pressed (see the `pressed_bg` field).
2143 pub fn pressed_bg(mut self, c: Color) -> Self {
2144 self.interact_mut().pressed_bg = Some(c);
2145 self
2146 }
2147
2148 /// Background while keyboard-visibly focused (see the `focus_bg`
2149 /// field); replaces the default focus ring.
2150 pub fn focus_bg(mut self, c: Color) -> Self {
2151 self.interact_mut().focus_bg = Some(c);
2152 self
2153 }
2154
2155 /// Puts this node in the Tab ring (see the `focusable` field).
2156 pub fn focusable(mut self) -> Self {
2157 self.focusable = true;
2158 self
2159 }
2160
2161 /// Hears focus entering and leaving this subtree (see the `on_focus`
2162 /// field).
2163 pub fn on_focus(mut self, tag: impl Into<Value>) -> Self {
2164 self.events_mut().on_focus = Some(tag.into());
2165 self
2166 }
2167
2168 /// A press here leaves keyboard focus where it was (see the
2169 /// `keep_focus` field).
2170 pub fn keep_focus(mut self) -> Self {
2171 self.events_mut().keep_focus = true;
2172 self
2173 }
2174
2175 /// Makes this node the modal scope's entry focus (see the
2176 /// `initial_focus` field).
2177 pub fn initial_focus(mut self) -> Self {
2178 self.initial_focus = true;
2179 self
2180 }
2181
2182 /// Makes this node inert (see the `disabled` field).
2183 pub fn disabled(mut self, disabled: bool) -> Self {
2184 self.disabled = disabled;
2185 self
2186 }
2187
2188 /// Makes this node the frame's modal surface (see the `modal` field).
2189 #[inline]
2190 pub fn modal(mut self, tag: impl Into<Value>) -> Self {
2191 self.events_mut().modal = Some(tag.into());
2192 self
2193 }
2194
2195 /// Joins the hover group `name` (see the `hover_group` field).
2196 pub fn hover_group(mut self, name: &str) -> Self {
2197 self.interact_mut().hover_group = Some(Self::hover_group_id(name));
2198 self
2199 }
2200
2201 /// Emits enter/leave events for this node (see the `on_hover` field).
2202 /// Pass a tag the handler can match on; `Value::Null` if the node key
2203 /// is identification enough.
2204 pub fn on_hover(mut self, tag: impl Into<Value>) -> Self {
2205 self.events_mut().on_hover = Some(tag.into());
2206 self
2207 }
2208
2209 /// Makes this node a drop zone for files dragged in from the OS (see
2210 /// the `on_drop` field).
2211 pub fn on_drop(mut self, tag: impl Into<Value>) -> Self {
2212 self.events_mut().on_drop = Some(tag.into());
2213 self
2214 }
2215
2216 /// Plays a registered sound when this node is clicked (see the
2217 /// `click_sound` field).
2218 pub fn click_sound(mut self, sound: crate::resources::SoundId) -> Self {
2219 self.interact_mut().click_sound = Some(sound);
2220 self
2221 }
2222
2223 /// Plays a registered sound when the pointer enters this node (see the
2224 /// `hover_sound` field).
2225 pub fn hover_sound(mut self, sound: crate::resources::SoundId) -> Self {
2226 self.interact_mut().hover_sound = Some(sound);
2227 self
2228 }
2229
2230 /// Makes this node draggable (see the `on_drag` field). Pass a tag the
2231 /// handler can match on; `Value::Null` if the node key is enough.
2232 pub fn on_drag(mut self, tag: impl Into<Value>) -> Self {
2233 self.events_mut().on_drag = Some(tag.into());
2234 self
2235 }
2236
2237 /// Reports this node's laid-out rect as an event whenever it changes
2238 /// (see the `on_layout` field). Pass a tag the handler can match on;
2239 /// `Value::Null` if the node key is identification enough.
2240 pub fn on_layout(mut self, tag: impl Into<Value>) -> Self {
2241 self.events_mut().on_layout = Some(tag.into());
2242 self
2243 }
2244
2245 /// What this node is to assistive technology (see the `role` field).
2246 pub fn role(mut self, role: Role) -> Self {
2247 self.access_mut().role = Some(role);
2248 self
2249 }
2250
2251 /// The accessible name (see the `label` field). Takes an `Arc<str>`
2252 /// as well as a `&str`, so a view can keep one and hand it out every
2253 /// frame without allocating.
2254 pub fn label(mut self, label: impl Into<Label>) -> Self {
2255 self.access_mut().label = Some(label.into());
2256 self
2257 }
2258
2259 /// The accessible description (see the `description` field).
2260 pub fn description(mut self, description: impl Into<Label>) -> Self {
2261 self.access_mut().description = Some(description.into());
2262 self
2263 }
2264
2265 /// The on state for a checkbox / radio / switch role.
2266 pub fn checked(mut self, checked: bool) -> Self {
2267 self.access_mut().checked = checked;
2268 self
2269 }
2270
2271 /// A checkbox that is neither on nor off (see the `mixed` field).
2272 pub fn mixed(mut self, mixed: bool) -> Self {
2273 self.access_mut().mixed = mixed;
2274 self
2275 }
2276
2277 /// The current one of a set (see the `selected` field).
2278 pub fn selected(mut self, selected: bool) -> Self {
2279 self.access_mut().selected = selected;
2280 self
2281 }
2282
2283 /// A disclosure's state (see the `expanded` field).
2284 pub fn expanded(mut self, expanded: bool) -> Self {
2285 self.access_mut().expanded = Some(expanded);
2286 self
2287 }
2288
2289 /// Marks this node a live region (see the `live` field).
2290 pub fn live(mut self, live: Live) -> Self {
2291 self.access_mut().live = live;
2292 self
2293 }
2294
2295 /// A slider role's current value.
2296 pub fn value_now(mut self, v: f32) -> Self {
2297 self.access_mut().value_now = Some(v);
2298 self
2299 }
2300
2301 pub fn value_min(mut self, v: f32) -> Self {
2302 self.access_mut().value_min = Some(v);
2303 self
2304 }
2305
2306 pub fn value_max(mut self, v: f32) -> Self {
2307 self.access_mut().value_max = Some(v);
2308 self
2309 }
2310
2311 /// How far one arrow key moves a slider (see the `value_step` field).
2312 /// A step that is not positive and finite clears it.
2313 pub fn value_step(mut self, v: f32) -> Self {
2314 self.access_mut().value_step = (v.is_finite() && v > 0.0).then_some(v);
2315 self
2316 }
2317
2318 /// Asks the core for a slider's changes (see the `on_change` field).
2319 pub fn on_change(mut self, tag: impl Into<Value>) -> Self {
2320 self.events_mut().on_change = Some(tag.into());
2321 self
2322 }
2323
2324 /// What a slider's position reads as (see the `value_text` field).
2325 pub fn value_text(mut self, text: impl Into<Label>) -> Self {
2326 self.access_mut().value_text = Some(text.into());
2327 self
2328 }
2329
2330 /// On a `Role::Line` of a custom editor: the caret's byte offset into
2331 /// this line's text (see the `caret` field).
2332 pub fn caret(mut self, offset: u32) -> Self {
2333 self.access_mut().caret = Some(offset);
2334 self
2335 }
2336
2337 /// On a `Role::Line` of a custom editor: the byte offset where the
2338 /// selection's other end sits (see the `selection_anchor` field).
2339 pub fn selection_anchor(mut self, offset: u32) -> Self {
2340 self.access_mut().selection_anchor = Some(offset);
2341 self
2342 }
2343
2344 /// On a `Role::Line` declaring `caret`: the caret is solid, not a
2345 /// caret to blink (see the `caret_solid` field). A block caret in a
2346 /// modal editor's normal mode — the one thing that otherwise asks an
2347 /// idle app for a frame twice a second.
2348 pub fn caret_solid(mut self) -> Self {
2349 self.access_mut().caret_solid = true;
2350 self
2351 }
2352
2353 /// Makes this node a key sink (see `NodeSpec::on_key` field). Pass a
2354 /// tag the handler can match on; `Value::Null` if the node key is
2355 /// identification enough.
2356 pub fn on_key(mut self, tag: impl Into<Value>) -> Self {
2357 self.events_mut().on_key = Some(tag.into());
2358 self
2359 }
2360
2361 /// A key sink with no tag — `on_key(Value::Null)`, for a handler that
2362 /// knows the node by its key.
2363 #[inline]
2364 pub fn key_sink(self) -> Self {
2365 self.on_key(Value::Null)
2366 }
2367
2368 /// Delivers releases to this key sink as well as presses (see the
2369 /// `key_up` field). Meaningless without `on_key`.
2370 pub fn key_up(mut self) -> Self {
2371 self.events_mut().key_up = true;
2372 self
2373 }
2374
2375 /// Delivers the modifier and lock keys to this key sink as keys of
2376 /// their own (see the `modifier_keys` field). Meaningless without
2377 /// `on_key`.
2378 pub fn modifier_keys(mut self) -> Self {
2379 self.events_mut().modifier_keys = true;
2380 self
2381 }
2382
2383 /// Asks for force-click events on this node (see the
2384 /// `on_force_click` field).
2385 pub fn on_force_click(mut self, tag: impl Into<Value>) -> Self {
2386 self.events_mut().on_force_click = Some(tag.into());
2387 self
2388 }
2389
2390 /// Asks for the non-primary buttons pressed over this node as events,
2391 /// each captured by it until its release (see the `on_button` field):
2392 /// `{kind="button", phase, button, x, y, tag}`. Every such button
2393 /// unless [`NodeSpec::buttons`] narrows it.
2394 pub fn on_button(mut self, tag: impl Into<Value>) -> Self {
2395 self.events_mut().on_button = Some(tag.into());
2396 self
2397 }
2398
2399 /// Which non-primary buttons `on_button` claims (see the `buttons`
2400 /// field): `Buttons::MIDDLE`, `Buttons::SECONDARY | Buttons::MIDDLE`.
2401 /// Meaningless without `on_button`.
2402 pub fn buttons(mut self, buttons: Buttons) -> Self {
2403 self.events_mut().buttons = buttons;
2404 self
2405 }
2406
2407 /// Asks for the wheel over this node as events (see the `on_scroll`
2408 /// field): `{kind="scroll", x, y, dx, dy, lines, tag}`.
2409 pub fn on_scroll(mut self, tag: impl Into<Value>) -> Self {
2410 self.events_mut().on_scroll = Some(tag.into());
2411 self
2412 }
2413
2414 /// Which axes `on_scroll` takes (see the `scroll_axes` field):
2415 /// `ScrollAxes::Y` for a terminal's history, so a sideways gesture
2416 /// passes it by. Meaningless without `on_scroll`.
2417 pub fn scroll_axes(mut self, axes: ScrollAxes) -> Self {
2418 self.events_mut().scroll_axes = axes;
2419 self
2420 }
2421
2422 /// The modifiers `on_scroll` is for (see the `scroll_mods` field):
2423 /// `KeyMods::NONE.with_ctrl().with_super()` hears a wheel turned with
2424 /// Ctrl or ⌘ held, ahead of every scroller under the pointer, and no
2425 /// other wheel. Meaningless without `on_scroll`.
2426 pub fn scroll_mods(mut self, mods: crate::input::KeyMods) -> Self {
2427 self.events_mut().scroll_mods = mods;
2428 self
2429 }
2430
2431 /// Asks for a context menu on this node (see the `on_context_menu`
2432 /// field). Pass a tag the handler can match on; `Value::Null` if the
2433 /// node key is identification enough.
2434 pub fn on_context_menu(mut self, tag: impl Into<Value>) -> Self {
2435 self.events_mut().on_context_menu = Some(tag.into());
2436 self
2437 }
2438
2439 /// Animates changes to this node's sizing amounts, colors and radius
2440 /// over `duration_ms` (cubic ease-out); see [`crate::anim`]. Only the
2441 /// duration: an easing or repeat already declared survives, so the
2442 /// transition props compose in any order.
2443 ///
2444 /// On a scroll container it also eases the offset a `reveal` or a
2445 /// `set_scroll` moves it to; the wheel, the thumb and a drag past the
2446 /// edge still land whole.
2447 ///
2448 /// ```rust
2449 /// use kui_core::{Easing, NodeSpec, Sizing};
2450 /// // Eases toward whatever width the view declares next frame.
2451 /// let pane = NodeSpec::column().width(Sizing::Fixed(240.0)).transition(180.0).easing(Easing::Smooth);
2452 /// assert_eq!(pane.transition.unwrap().duration_ms, 180.0);
2453 /// ```
2454 pub fn transition(mut self, duration_ms: f32) -> Self {
2455 let t = self.transition.get_or_insert(Transition::ms(duration_ms));
2456 t.duration_ms = duration_ms;
2457 self
2458 }
2459
2460 /// The whole [`Transition`] at once, replacing any declared so far.
2461 pub fn transition_with(mut self, t: Transition) -> Self {
2462 self.transition = Some(t);
2463 self
2464 }
2465
2466 /// Also ease this node's position (see the `slide` field); sets a
2467 /// default 200ms transition if none was declared yet.
2468 pub fn slide(mut self) -> Self {
2469 self.transition.get_or_insert(Transition::ms(200.0));
2470 self.slide = true;
2471 self
2472 }
2473
2474 /// Easing for the node's transition (sets a default 200ms one if none
2475 /// was declared yet).
2476 pub fn easing(mut self, easing: Easing) -> Self {
2477 let t = self.transition.get_or_insert(Transition::ms(200.0));
2478 t.easing = easing;
2479 self
2480 }
2481
2482 /// How far the node's spring overshoots, 0 (glides in) to
2483 /// [`crate::anim::MAX_BOUNCE`] — in place of the spring easing's own
2484 /// bounce, and on a timed easing in place of the curve, making it a
2485 /// spring (see [`Transition::bounce`]). Sets a default 200ms
2486 /// transition if none was declared yet.
2487 pub fn bounce(mut self, bounce: f32) -> Self {
2488 let t = self.transition.get_or_insert(Transition::ms(200.0));
2489 *t = t.bounce(bounce);
2490 self
2491 }
2492
2493 /// How this node's `keyframes` cycle (CSS's `animation-direction`);
2494 /// sets a default 200ms transition if none was declared yet.
2495 pub fn repeat(mut self, repeat: Repeat) -> Self {
2496 let t = self.transition.get_or_insert(Transition::ms(200.0));
2497 t.repeat = repeat;
2498 self
2499 }
2500
2501 /// Holds this node's keyframe cycle back by `delay_ms` (CSS's
2502 /// `animation-delay`), so siblings given different delays run out of
2503 /// phase — a cascade, a chase light. Sets a default 200ms transition if
2504 /// none was declared yet.
2505 pub fn delay(mut self, delay_ms: f32) -> Self {
2506 let t = self.transition.get_or_insert(Transition::ms(200.0));
2507 t.delay_ms = delay_ms;
2508 self
2509 }
2510
2511 /// Cycles the slots these stops name (see the `keyframes` field); sets
2512 /// a default 200ms transition if none was declared yet.
2513 pub fn keyframes(mut self, stops: Vec<Keyframe>) -> Self {
2514 self.transition.get_or_insert(Transition::ms(200.0));
2515 self.anim_mut().keyframes = stops;
2516 self
2517 }
2518
2519 /// Eases this node in from `enter` on its first sight (see the `enter`
2520 /// field); sets a default 200ms transition if none was declared yet.
2521 pub fn enter(mut self, enter: Enter) -> Self {
2522 self.transition.get_or_insert(Transition::ms(200.0));
2523 self.anim_mut().enter = Some(enter);
2524 self
2525 }
2526
2527 /// Eases this node out to `exit` after the view stops declaring it
2528 /// (see the `exit` field); sets a default 200ms transition if none was
2529 /// declared yet.
2530 pub fn exit(mut self, exit: Enter) -> Self {
2531 self.transition.get_or_insert(Transition::ms(200.0));
2532 self.anim_mut().exit = Some(exit);
2533 self
2534 }
2535
2536 /// Pressing this node starts an OS window drag (drivers promote a quick
2537 /// second press to a maximize toggle).
2538 pub fn window_drag(mut self) -> Self {
2539 self.window = Some(WindowRole::Drag);
2540 self
2541 }
2542
2543 /// Clicking this node emits the button's `WindowCommand`.
2544 pub fn window_button(mut self, button: WindowButton) -> Self {
2545 self.window = Some(WindowRole::Button(button));
2546 self
2547 }
2548
2549 /// The pointer shape over this node (see the `cursor` field).
2550 pub fn cursor(mut self, shape: CursorShape) -> Self {
2551 self.cursor = Some(shape);
2552 self
2553 }
2554}
2555
2556/// Which face a text shapes with: one of the three stock families, or a
2557/// font registered with the core.
2558#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2559pub enum FontFamily {
2560 #[default]
2561 Sans,
2562 Serif,
2563 Mono,
2564 /// A font registered with the core (`Core::add_font_data` from file
2565 /// bytes, or `Core::add_system_font` by installed family name). A
2566 /// stale handle shapes as sans-serif. Not on the wire as a family:
2567 /// the `font` row carries the handle.
2568 Custom(crate::resources::FontId),
2569}
2570
2571impl FontFamily {
2572 /// The three stock families, in wire order: a binding sends the index.
2573 /// `Custom` is not a family on the wire; the `font` row is.
2574 pub const ALL: &'static [FontFamily] = &[FontFamily::Sans, FontFamily::Serif, FontFamily::Mono];
2575
2576 /// The spelling every binding uses; a registered font has none.
2577 pub fn name(self) -> Option<&'static str> {
2578 match self {
2579 FontFamily::Sans => Some("sans"),
2580 FontFamily::Serif => Some("serif"),
2581 FontFamily::Mono => Some("mono"),
2582 FontFamily::Custom(_) => None,
2583 }
2584 }
2585
2586 /// The variant `schema::FAMILIES` index `i` names; `Sans` for an
2587 /// index this build lacks.
2588 pub fn from_index(i: usize) -> FontFamily {
2589 Self::ALL.get(i).copied().unwrap_or_default()
2590 }
2591}
2592
2593/// How a text node breaks lines at its width.
2594#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2595pub enum TextWrap {
2596 /// Break between words; a word wider than the line breaks by glyph.
2597 #[default]
2598 Word,
2599 /// Break anywhere (URLs, hashes, code).
2600 Glyph,
2601 /// Never break at the width: one line per paragraph, clipped to the
2602 /// node's box (explicit newlines still break).
2603 None,
2604 /// `Word`, but whitespace takes its room like any glyph — CSS's
2605 /// `white-space: break-spaces`: a space that does not fit starts the
2606 /// next row instead of hanging past the edge or vanishing at the
2607 /// break, so every byte has a place inside the box. An editor's
2608 /// wrapped line, whose caret stands on each space. A text with line
2609 /// breaks of its own, a `max_lines` or an `ellipsis` wraps as `Word`.
2610 BreakSpaces,
2611}
2612
2613/// The OpenType features a style asks the shaper for: up to
2614/// [`FontFeatures::MAX`] four-letter tags with a value each. `liga` 0
2615/// keeps a coding font from joining `->`, `tnum` 1 gives tabular figures,
2616/// `ss01` 1 turns on a stylistic set. Plain data and `Copy`, since a
2617/// `TextStyle` is; the spelling every binding shares is
2618/// [`FontFeatures::parse`]'s.
2619///
2620/// ```rust
2621/// use kui_core::{FontFeatures, TextStyle};
2622/// let code = TextStyle::new(13.0).mono().features(FontFeatures::parse("-liga -calt tnum"));
2623/// assert_eq!(code.features.len(), 3);
2624/// assert_eq!(code.features.to_string_spelling(), "liga=0 calt=0 tnum=1");
2625/// ```
2626#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
2627pub struct FontFeatures {
2628 tags: [[u8; 4]; FontFeatures::MAX],
2629 values: [u32; FontFeatures::MAX],
2630 len: u8,
2631}
2632
2633impl FontFeatures {
2634 /// How many features a style can carry. Eight is more than any one
2635 /// text asks for and keeps the style small.
2636 pub const MAX: usize = 8;
2637
2638 /// No features: the font's own defaults.
2639 pub const fn new() -> Self {
2640 Self {
2641 tags: [[b' '; 4]; Self::MAX],
2642 values: [0; Self::MAX],
2643 len: 0,
2644 }
2645 }
2646
2647 /// Adds or replaces `tag` (four ASCII characters; shorter is padded
2648 /// with spaces, longer is cut) with `value`. Past `MAX` the feature is
2649 /// dropped rather than the style refused.
2650 pub fn set(mut self, tag: &str, value: u32) -> Self {
2651 let mut t = [b' '; 4];
2652 for (i, b) in tag.bytes().take(4).enumerate() {
2653 t[i] = b;
2654 }
2655 let n = self.len as usize;
2656 if let Some(i) = self.tags[..n].iter().position(|x| *x == t) {
2657 self.values[i] = value;
2658 } else if n < Self::MAX {
2659 self.tags[n] = t;
2660 self.values[n] = value;
2661 self.len += 1;
2662 }
2663 self
2664 }
2665
2666 /// The spelling every binding shares: tags separated by whitespace or
2667 /// commas, each `tag=value`, a bare `tag` meaning 1 and `-tag` meaning
2668 /// 0 — `"liga=0 calt=0 tnum"`, `"-liga,-calt"`. Anything else in the
2669 /// string is skipped.
2670 pub fn parse(s: &str) -> Self {
2671 let mut out = Self::new();
2672 for item in s.split(|c: char| c.is_whitespace() || c == ',') {
2673 if item.is_empty() {
2674 continue;
2675 }
2676 let (tag, value) = if let Some((t, v)) = item.split_once('=') {
2677 (t, v.trim().parse::<u32>().unwrap_or(0))
2678 } else if let Some(t) = item.strip_prefix('-') {
2679 (t, 0)
2680 } else if let Some(t) = item.strip_prefix('+') {
2681 (t, 1)
2682 } else {
2683 (item, 1)
2684 };
2685 let tag = tag.trim();
2686 if !tag.is_empty() {
2687 out = out.set(tag, value);
2688 }
2689 }
2690 out
2691 }
2692
2693 pub fn is_empty(&self) -> bool {
2694 self.len == 0
2695 }
2696
2697 pub fn len(&self) -> usize {
2698 self.len as usize
2699 }
2700
2701 /// Every feature, in the order set, as `(tag, value)`.
2702 pub fn iter(&self) -> impl Iterator<Item = (&[u8; 4], u32)> + '_ {
2703 let n = self.len as usize;
2704 self.tags[..n].iter().zip(self.values[..n].iter().copied())
2705 }
2706
2707 /// What `parse` reads: `tag=value` pairs joined by spaces.
2708 pub fn to_string_spelling(&self) -> String {
2709 self.iter()
2710 .map(|(t, v)| format!("{}={}", String::from_utf8_lossy(t).trim_end(), v))
2711 .collect::<Vec<_>>()
2712 .join(" ")
2713 }
2714}
2715
2716/// How a run of text is shaped and painted: size, line height, colour,
2717/// family, wrapping, line limits, OpenType features and decorations.
2718///
2719/// [`TextStyle::new`] takes the font size and derives a line height; the
2720/// rest are builders. A style with no colour paints in the theme's
2721/// foreground, so plain text is legible on both the light and dark base.
2722///
2723/// ```rust
2724/// use kui_core::{Color, FontFamily, TextStyle, TextWrap};
2725///
2726/// let body = TextStyle::new(15.0).line_height(22.0);
2727/// let caption = TextStyle::new(12.0).color(Color::hex(0x8a8fa3ff)).max_lines(2).ellipsis();
2728/// let code = TextStyle::new(13.0).family(FontFamily::Mono).wrap(TextWrap::None);
2729/// let link = TextStyle::new(15.0).underline().color(Color::hex(0x3b5bd4ff));
2730///
2731/// assert_eq!(body.color, None); // the theme's foreground
2732/// assert_eq!(caption.max_lines, 2);
2733/// assert!(code.wrap == TextWrap::None && link.underline);
2734/// ```
2735#[derive(Clone, Copy, Debug, PartialEq)]
2736pub struct TextStyle {
2737 pub size: f32,
2738 pub line_height: f32,
2739 /// `None` is the theme's foreground, filled in as the text enters the
2740 /// tree so nothing downstream of that ever sees a `None`.
2741 pub color: Option<Color>,
2742 pub family: FontFamily,
2743 pub wrap: TextWrap,
2744 /// At most this many lines are laid out; 0 = unlimited.
2745 pub max_lines: u32,
2746 /// End the last line with "…" when the text was cut off. Alone it
2747 /// means a single line (`max_lines` 1); with `max_lines` it clamps.
2748 pub ellipsis: bool,
2749 /// OpenType features for the shaper; none by default, which is the
2750 /// font's own defaults (ligatures on, where it has them).
2751 pub features: FontFeatures,
2752 /// A line under every glyph, where the face puts its underline. Paint
2753 /// only: not part of what the text is shaped as.
2754 pub underline: bool,
2755 /// The underline's own colour; `None` is the text's.
2756 pub underline_color: Option<Color>,
2757 /// The underline's shape: a line, a wave, dots.
2758 pub underline_style: UnderlineStyle,
2759 /// A line through every glyph, where the face puts its strikeout.
2760 pub strikethrough: bool,
2761}
2762
2763/// The shape of an underline: the face's line, a wave under a diagnostic,
2764/// dots. Where it goes and how thick it is are the face's
2765/// recommendation either way; a wave is three strokes tall around the
2766/// line's centre with a six-stroke period, dots two strokes across and
2767/// four apart (`crate::deco`).
2768#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2769pub enum UnderlineStyle {
2770 #[default]
2771 Solid,
2772 Wavy,
2773 Dotted,
2774}
2775
2776impl UnderlineStyle {
2777 /// The spellings, in discriminant order (`underlineStyle` /
2778 /// `underline_style`; C's `KUI_UNDERLINE_*`).
2779 pub const NAMES: &[&str] = &["solid", "wavy", "dotted"];
2780
2781 pub fn from_index(i: u32) -> Self {
2782 match i {
2783 1 => Self::Wavy,
2784 2 => Self::Dotted,
2785 _ => Self::Solid,
2786 }
2787 }
2788
2789 pub fn name(self) -> &'static str {
2790 Self::NAMES[self as usize]
2791 }
2792}
2793
2794impl Default for TextStyle {
2795 fn default() -> Self {
2796 Self::new(16.0)
2797 }
2798}
2799
2800impl TextStyle {
2801 /// A style at `size` logical px, sans, in the theme's foreground, with
2802 /// a line height of 1.35 times the size, rounded.
2803 pub fn new(size: f32) -> Self {
2804 Self {
2805 size,
2806 line_height: (size * 1.35).round(),
2807 color: None,
2808 family: FontFamily::Sans,
2809 wrap: TextWrap::Word,
2810 max_lines: 0,
2811 ellipsis: false,
2812 features: FontFeatures::new(),
2813 underline: false,
2814 underline_color: None,
2815 underline_style: UnderlineStyle::Solid,
2816 strikethrough: false,
2817 }
2818 }
2819
2820 /// Underlines the text in its own colour.
2821 pub fn underline(mut self) -> Self {
2822 self.underline = true;
2823 self
2824 }
2825
2826 /// An underline in its own colour rather than the text's (a
2827 /// diagnostic's red under keyword-coloured text). Turns the underline
2828 /// on.
2829 pub fn underline_color(mut self, c: Color) -> Self {
2830 self.underline = true;
2831 self.underline_color = Some(c);
2832 self
2833 }
2834
2835 /// An underline of this shape. Turns the underline on.
2836 pub fn underline_style(mut self, s: UnderlineStyle) -> Self {
2837 self.underline = true;
2838 self.underline_style = s;
2839 self
2840 }
2841
2842 /// A line through the text.
2843 pub fn strikethrough(mut self) -> Self {
2844 self.strikethrough = true;
2845 self
2846 }
2847
2848 /// OpenType features for the shaper; see [`FontFeatures`].
2849 pub fn features(mut self, f: FontFeatures) -> Self {
2850 self.features = f;
2851 self
2852 }
2853
2854 /// The face to shape with.
2855 pub fn family(mut self, f: FontFamily) -> Self {
2856 self.family = f;
2857 self
2858 }
2859
2860 /// The stock monospace family.
2861 pub fn mono(self) -> Self {
2862 self.family(FontFamily::Mono)
2863 }
2864
2865 /// Shape with a registered font (see `FontFamily::Custom`).
2866 pub fn font(self, id: crate::resources::FontId) -> Self {
2867 self.family(FontFamily::Custom(id))
2868 }
2869
2870 /// The line height in logical px, replacing the derived one.
2871 pub fn line_height(mut self, lh: f32) -> Self {
2872 self.line_height = lh;
2873 self
2874 }
2875
2876 /// How lines break at the node's width.
2877 pub fn wrap(mut self, wrap: TextWrap) -> Self {
2878 self.wrap = wrap;
2879 self
2880 }
2881
2882 /// One line per paragraph, clipped to the node (`TextWrap::None`).
2883 pub fn nowrap(self) -> Self {
2884 self.wrap(TextWrap::None)
2885 }
2886
2887 /// Lay out at most `n` lines (0 = unlimited).
2888 pub fn max_lines(mut self, n: u32) -> Self {
2889 self.max_lines = n;
2890 self
2891 }
2892
2893 /// Truncate with "…" instead of overflowing: a single line unless
2894 /// `max_lines` says otherwise.
2895 pub fn ellipsis(mut self) -> Self {
2896 self.ellipsis = true;
2897 self
2898 }
2899
2900 /// The text colour, instead of the theme's foreground.
2901 pub fn color(mut self, c: Color) -> Self {
2902 self.color = Some(c);
2903 self
2904 }
2905
2906 /// This style with `fg` where it named no colour of its own: what the
2907 /// core stamps on as the text enters the tree, so the shaping caches,
2908 /// the display list and every binding see a resolved colour.
2909 pub fn or_fg(mut self, fg: Color) -> Self {
2910 self.color = Some(self.color.unwrap_or(fg));
2911 self
2912 }
2913
2914 /// The colour this style paints in, falling back to what kui painted
2915 /// before there were themes. For the handful of places that hold a
2916 /// style the core never stamped.
2917 pub fn color_or_default(&self) -> Color {
2918 self.color.unwrap_or(crate::theme::Theme::DEFAULT_FG)
2919 }
2920}
2921
2922/// Hand-written so that a group whose box was allocated but left at its
2923/// defaults — `.checked(false)` on a fresh spec — equals one whose box was
2924/// never allocated at all. The derived version compared `None` against
2925/// `Some(EMPTY)` and called them different, which is a difference the boxing
2926/// introduced rather than one a caller declared.
2927impl PartialEq for NodeSpec {
2928 fn eq(&self, other: &Self) -> bool {
2929 self.layout == other.layout
2930 && self.style == other.style
2931 && self.hoverable == other.hoverable
2932 && self.animate == other.animate
2933 && self.accent == other.accent
2934 && self.window == other.window
2935 && self.transition == other.transition
2936 && self.slide == other.slide
2937 && self.focusable == other.focusable
2938 && self.initial_focus == other.initial_focus
2939 && self.disabled == other.disabled
2940 && self.cursor == other.cursor
2941 && self.events() == other.events()
2942 && self.anim() == other.anim()
2943 && self.access() == other.access()
2944 && self.interact() == other.interact()
2945 }
2946}
2947
2948#[cfg(test)]
2949mod size_tests {
2950 use super::*;
2951
2952 /// `NodeSpec` is moved by value for every node a frame builds — through
2953 /// the builder chain, `Core::open`, `open_with_key` and into
2954 /// `Vec<NodeSpec>` in `Tree::push` — so its size is a per-node cost that
2955 /// every app pays whether or not it declares the fields. It reached 728
2956 /// bytes one feature at a time and cost ~2.5x on the frame benches before
2957 /// anyone measured it.
2958 ///
2959 /// This is the number a review can fail. Adding a prop is fine; adding it
2960 /// *inline* past this bound is the thing to notice. Put cold fields in one
2961 /// of the boxed groups instead, and only raise this if the field is read
2962 /// on every node of every frame.
2963 #[test]
2964 fn node_spec_stays_small() {
2965 const BOUND: usize = 256;
2966 let size = std::mem::size_of::<NodeSpec>();
2967 assert!(
2968 size <= BOUND,
2969 "NodeSpec is {size} bytes, over the {BOUND}-byte bound. It is copied \
2970 per node per frame; put cold fields in EventSpec / AnimSpec / \
2971 AccessSpec / InteractSpec rather than inline. See C15."
2972 );
2973 }
2974
2975 /// The groups exist to be absent: a node declaring none of them carries
2976 /// four null pointers, not four structs.
2977 #[test]
2978 fn an_undeclared_group_costs_a_pointer() {
2979 let spec = NodeSpec::default();
2980 assert!(spec.events.is_none() && spec.anim.is_none());
2981 assert!(spec.access.is_none() && spec.interact.is_none());
2982 // and reads still work, without allocating
2983 assert!(spec.events().on_click.is_none());
2984 assert_eq!(spec.access().role, None);
2985 }
2986
2987 /// An allocated-but-default group is still equal to no group at all.
2988 #[test]
2989 fn an_empty_group_equals_no_group() {
2990 assert_eq!(NodeSpec::default().checked(false), NodeSpec::default());
2991 }
2992}