flit

A Flutter-inspired UI toolkit for Nim. API reference.

Three quick entry points: flit (the umbrella import), alphabetical symbol index, or jump to a module below.

Foundation

Core types and the runtime that drives the build/layout/paint cycle.

• foundation/widget — Widget, Element, State, BuildContext, setState
• foundation/render_object — RenderObject, Canvas, PaintingContext, hit-testing
• foundation/geometry — Offset, Size, Rect, Constraints, EdgeInsets, Alignment, lerp
• foundation/color — Color, rgba/rgb/fromHex, withAlpha/withOpacity, lerp, named constants
• foundation/key — Key, ValueKey, UniqueKey, GlobalKey
• foundation/binding — Binding, PointerEvent, KeyEvent, frame callbacks
• foundation/runtime — mountElement, rebuildElement, runLayout, runPaint, processPointerEvents
• foundation/listenable — ValueNotifier[T], ListenableBuilder — shared mutable state with auto-rebuild of watchers
• foundation/diagnostics — DiagnosticsNode, prettyPrint, logf

State management quick reference: see ValueNotifier[T] for a subscribable cell, and dependOnInheritedOfType[T] for ancestor-data subscriptions via InheritedWidget. Worked example in examples/state_demo/main.nim.

Widgets

• widgets/basic — Container, Row, Column, Stack, Text, Padding, Align, SizedBox, AspectRatio, ClipRect, Opacity, ScrollView, …

Design libraries

Animation & gestures

• animation/animation — AnimationController, Ticker, Tween, curves
• gestures/detector — GestureDetector, HitTestBehavior, callback types

Rendering (internal)

Render objects that back the widgets above. Most users don't import these directly.

• rendering/proxy_box — RenderProxyBox + single-child render objects (Padding, Align, SizedBox, …)
• rendering/flex — RenderFlex, FlexParentData, FlexFit
• rendering/stack — RenderStack, StackParentData, StackFit
• rendering/decoration — BoxDecoration, Border, BoxShadow, RenderDecoratedBox
• rendering/text — TextStyle, RenderParagraph, measureText
• rendering/viewport — RenderViewport, scrollOffset, scrollbar
• rendering/canvas_sdl — SdlCanvas (SDL2 + Pixie backend)

Platform runners

• app — runApp(widget) dispatch by build target
• platform/desktop/runner — macOS / Linux / Windows via SDL2
• platform/embedded/runner — framebuffer / kiosk
• platform/mobile/runner — iOS / Android via SDL2
• platform/web/runner — HTMLCanvas (nim js)

Generated by nim doc --project. Regenerate with nimble docs.