Skip to content
D
Documentation

RenderSchedulerOptions

reference
1 min readUpdated

Import it from @grafloria/renderer.

RenderScheduler — framework-agnostic rAF coalescing + idle-skip.

Blocker #3 of the headless-instance contract (see ./diagram-instance.ts): the only render loop in the codebase was DiagramCanvasComponent.scheduleRender(), a private Angular method. This is that logic, lifted verbatim in behaviour and with no framework or DOM imports, so React / the web component / a plain <script> host all inherit the same frame discipline:

  • Coalescing. Any number of schedule() calls in one tick collapse into exactly ONE painted frame. A burst of engine events (node:changed ×N, a drag's mousemoves, several prop changes in one React commit) paints once.
    • Idle-skip. A queued frame is DROPPED when shouldSkip() says nothing visible can have changed — cheaper than a no-op render of a big diagram.
    • Synchronous escape. flush() paints right now and cancels the queued frame; used for the mount paint (so the first frame is not one rAF late) and by tests.

requestFrame/cancelFrame are injectable: pass fakes in tests, and note the default falls back to setTimeout where rAF is missing (Node), so a scheduler constructed during SSR never throws — it simply never gets a chance to fire because nothing calls schedule() on the server.

ts
interface RenderSchedulerOptions

Properties

NameTypeDefaultDescription
onFrame() => voidThe paint. Called at most once per frame.
shouldSkip?() => booleanIdle-skip predicate, evaluated INSIDE the frame (not at schedule time, so it sees the final state of the tick). Return true to drop the frame.
requestFrame?(cb: (time: number) => void) => numberInjectable rAF (defaults to the platform one, with a setTimeout fallback).
cancelFrame?(handle: number) => voidInjectable cancel, must pair with requestFrame.

Was this page helpful?