flexium/dist/renderer-CWYPPHmO.d.ts

A lightweight, signals-based UI framework with cross-platform renderers

/**
 * Core Renderer Interface
 *
 * This interface defines the contract that all platform-specific renderers must implement.
 * It provides a unified API for creating, updating, and managing nodes across different
 * rendering targets (DOM, Canvas, React Native, WebGL, etc.).
 */
/**
 * Base node type - platform-specific implementations will extend this
 */
type RenderNode = any;
/**
 * Event handler function type
 */
type EventHandler = (event: any) => void;
/**
 * Core renderer interface that all platform renderers must implement
 */
interface Renderer {
    /**
     * Create a new platform-specific node
     * @param type - The type of node to create (e.g., 'div', 'Row', 'Text')
     * @param props - Properties to apply to the node
     * @returns The created node
     */
    createNode(type: string, props: Record<string, any>): RenderNode;
    /**
     * Update the properties of an existing node
     * @param node - The node to update
     * @param oldProps - Previous properties (for diffing)
     * @param newProps - New properties to apply
     */
    updateNode(node: RenderNode, oldProps: Record<string, any>, newProps: Record<string, any>): void;
    /**
     * Append a child node to a parent node
     * @param parent - The parent node
     * @param child - The child node to append
     */
    appendChild(parent: RenderNode, child: RenderNode): void;
    /**
     * Insert a child node before a reference node
     * @param parent - The parent node
     * @param child - The child node to insert
     * @param beforeChild - The reference node to insert before
     */
    insertBefore(parent: RenderNode, child: RenderNode, beforeChild: RenderNode | null): void;
    /**
     * Remove a child node from a parent node
     * @param parent - The parent node
     * @param child - The child node to remove
     */
    removeChild(parent: RenderNode, child: RenderNode): void;
    /**
     * Create a text node
     * @param text - The text content
     * @returns The created text node
     */
    createTextNode(text: string): RenderNode;
    /**
     * Update the text content of a text node
     * @param node - The text node to update
     * @param text - The new text content
     */
    updateTextNode(node: RenderNode, text: string): void;
    /**
     * Add an event listener to a node
     * @param node - The node to attach the listener to
     * @param event - The event name (e.g., 'click', 'press')
     * @param handler - The event handler function
     */
    addEventListener(node: RenderNode, event: string, handler: EventHandler): void;
    /**
     * Remove an event listener from a node
     * @param node - The node to remove the listener from
     * @param event - The event name
     * @param handler - The event handler function
     */
    removeEventListener(node: RenderNode, event: string, handler: EventHandler): void;
}
/**
 * Platform-agnostic props that should be supported across all renderers
 */
interface CommonProps {
    width?: number | string;
    height?: number | string;
    padding?: number;
    paddingTop?: number;
    paddingRight?: number;
    paddingBottom?: number;
    paddingLeft?: number;
    margin?: number;
    marginTop?: number;
    marginRight?: number;
    marginBottom?: number;
    marginLeft?: number;
    flexDirection?: 'row' | 'column';
    justifyContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'space-evenly';
    alignItems?: 'flex-start' | 'flex-end' | 'center' | 'stretch' | 'baseline';
    gap?: number;
    flex?: number;
    flexWrap?: 'nowrap' | 'wrap' | 'wrap-reverse';
    bg?: string;
    color?: string;
    borderRadius?: number;
    borderWidth?: number;
    borderColor?: string;
    opacity?: number;
    fontSize?: number;
    fontWeight?: number | string;
    fontFamily?: string;
    lineHeight?: number;
    textAlign?: 'left' | 'center' | 'right';
    onPress?: EventHandler;
    onHover?: EventHandler;
    onChange?: EventHandler;
    onFocus?: EventHandler;
    onBlur?: EventHandler;
}
/**
 * Virtual node structure used for JSX/h function
 */
interface VNode {
    type: string | Function;
    props: Record<string, any>;
    children: (VNode | string | number | null | undefined | Function)[];
    key?: string | number;
    _node?: RenderNode;
}

export type { CommonProps as C, EventHandler as E, Renderer as R, VNode as V };