Documentation

API Reference

Complete API reference for the Tälla UI framework.

Core

• app
  The current instance of the global application context.
• class AppContext
  A singleton class that represents the global application state.
• class AppQueue
  A simple task queue for scheduling and running asynchronous tasks.
• class AppException
  A class that represents an application error, including a localizable message.
• class LogWriter
  A class that handles log messages, part of the global application context.

Activities and navigation

• class Activity
  A class that represents a part of the application that can be activated when the user navigates to it.
• class ActivityRouter
  A class that manages activation and deactivation of activities, with support for path-based routing.
• class NavigationContext abstract
  An abstract class that encapsulates the current location within the application navigation stack, part of the global application context.
• interface Viewport
  Interface definition for an object that contains information about the user’s viewport, i.e. screen or window.

Views

• class View abstract
  An abstract class that represents a view.
• interface ViewBuilder
  An interface for objects that build pre-configured view instances.
• type ViewBuilderFunction
  A type of function that returns a view builder, often provided with the same type of view builder as an argument.
• type ViewBuilderEventHandler
  A type of event handler that can be added by a view builder.
• type ViewEvent
  Type definition for an event that’s emitted on a view object.
• class Widget
  A base class that represents a reusable UI component with encapsulated state.

UI elements

• namespace UI
  A namespace that contains functions for building a declarative UI using view builders.
• class UIElement abstract
  The base class for built-in UI view elements.
• class UIButton
  A view class that represents a button control.
• class UIText
  A view class that represents a text element.
• class UITextField
  A view class that represents a text field control.
• class UIToggle
  A view class that represents a checkbox or toggle input.
• class UIImage
  A view class that represents an image or icon control.
• class UIColumn
  A view class that represents a column container element.
• class UIRow
  A view class that represents a row container element.
• class UIContainer abstract
  A base view class that represents a container element with no specific layout or styling.
• class UIScrollView
  A view class that represents a container element that allows users to scroll, emitting asynchronous scroll events.
• class UIListView
  A view wrapper that manages nested views for each item in a list.
• type UIListViewEvent
  Type definition for an event that’s emitted by a view within a UIListView.
• class UIShowView
  A view object that renders and controls a referenced view.
• class UIDivider
  A view class that represents a horizontal or vertical divider line.
• class UISpacer
  A view class that represents an empty control without any content.
• class UIIconResource
  A class that represents icon source content.

Styling

• class UIColor
  A class that represents a single color value.
• type StyleOverrides
  A type that defines style properties for UI elements.

State and binding

• class ObservableObject
  The base class of all observable objects, which can be placed into a tree structure to enable event handling and data binding.
• class ObservableList
  A data structure that contains an ordered set of observable objects.
• class ObservableEvent
  An object that represents an event, to be emitted on an ObservableObject.
• class Binding
  A class that represents a property binding.
• type BindingOrValue
  A type that maps to the specified type or a Binding instance.

Forms

• class FormState
  An object that contains form field data, with validation rules.
• class Schema
  A class that represents a validation schema for input values, objects, and arrays.

Rendering

• class RenderContext abstract
  An abstract class that supports global view rendering, part of the global application context.
• interface RenderEffect
  An interface for render effects that can be applied to UI elements.
• interface ModalFactory
  An interface that contains methods for creating modal views, defined by the renderer.
• class MessageDialogOptions
  A representation of the contents of an alert or confirm dialog.
• class ModalMenuOptions
  A class that contains options for the display of a modal menu.

Internationalization

• class I18nContext
  An object that provides internationalization functionality for the current locale.
• class DeferredString
  An object that encapsulates a string, evaluated only when needed.
• type StringConvertible
  String type or object that has a toString method.
• function fmt()
  Returns a (lazily) formatted string incorporating the provided values.

Web handler

• function useWebContext()
  Initializes the web application context with renderer, viewport, and navigation.
• class WebContextOptions
  A class that contains configuration options for the web handler.
• class WebRenderer
  A renderer class that uses the DOM to render UI elements.
• class WebNavigationContext
  A class that manages the application navigation path using DOM methods.
• class WebTheme
  A class that represents a complete visual theme configuration.
• function setWebTheme()
  Applies a theme to the web application.
• interface WebModalViews
  Functions that are used by default modal views (dialog, message dialog, and modal menu).
• function useAnimationEffects()
  Registers animation effects for use with UIElement.ElementBuilder.effect().
• function useContainerEffects()
  Registers container effects for use in the application.
• function useDragEffects()
  Registers drag effects for use in the application.

Test handler

• function useTestContext()
  Clears the current global app context and initializes a test application context.
• class TestContextOptions
  A class that contains options for the test application context.
• type TestAppContext
  Type definition for the global app context with test-specific render and activity contexts, set by the useTestContext function.
• class TestRenderer
  A class that represents an in-memory application render context.
• class TestNavigationContext
  A class that encapsulates the current navigation location, simulating browser-like behavior.
• class TestOutputElement
  A class that represents a rendered output element.
• function renderTestView()
  Renders the specified view using the current test application context.
• function expectOutput()
  Returns an assertion for the elements matching the provided filters.
• function expectOutputAsync()
  Waits for output to be rendered (by the test renderer) that matches the provided filters.
• function expectNavAsync()
  Waits for the global navigation location to match the given page ID and detail.
• type ExpectNavOptions
  Options to be used with expectNavAsync().
• function expectMessageDialogAsync()
  Waits for an alert or confirm dialog to be rendered (by the test renderer).
• class RenderedTestMessageDialog
  A class that represents a rendered message dialog (for testing).
• class OutputAssertion
  A class that provides assertion methods to be applied to a selection of rendered output elements.
• interface OutputSelectFilter
  An object that provides filters to match a set of output elements, to be asserted using OutputAssertion.
• function clickOutputAsync()
  Waits for matching output to be rendered, and simulates a user click event.
• function enterTextOutputAsync()
  Waits for matching output to be rendered, and simulates user text input.