Home

API Reference

• Flux: Reactive UI library for Roblox and Luau, including fine-grained signals, declarative instances, layout, motion, Flux.Clock, and Flux.Sync.
  • Async: Async resources: a fetcher runs off the graph, and its progress is exposed as nodes (data, error, loading, state).
  • Bind
  • Clock: Shared clock for timers, frame callbacks, and deterministic stepping in tests.
  • Compat
  • Conditional: Control flow, list mapping, and keyed selection helpers (show, showKeyed, switch, presence, pick, fallback, forValue, forIndex, selector).
  • Edit
  • Graph: The reactive graph: signals hold values, computeds derive them lazily, effects react to them, and scopes own the reactions and cleanups created inside them.
  • Interact: Interaction state as read-only boolean nodes (hover, press, selected, focused) and the hit tests pointIn, sunk and covered.
  • Layout: Layout instances with friendly, reactive arguments: padding, corner, stroke, list, grid, flex, gradient, aspectRatio, sizeConstraint, textSizeConstraint.
  • Motion: Spring and tween animations (spring, tween) stepped once per frame, plus perceptual Color utilities.
  • Responsive: The screen and the player as shared nodes: viewport, UI scale, breakpoint, input device and accessibility settings.
  • Store: Deep reactive stores: Flux.store(table) returns a proxy whose fields are tracked per key, with Flux.Store helpers for arrays, snapshots and teardown.
  • Sync: Network-synchronized signals shared between the server and clients.