@meonode/canvas 1.0.0-beta.1

package/dist/esm/canvas/layout.canvas.util.d.ts

@@ -0,0 +1,123 @@
+import { type CanvasRenderingContext2D } from 'skia-canvas';
+import type { BaseProps, BoxProps } from '../canvas/canvas.type.js';
+import { Node } from '../constant/common.const.js';
+/**
+ * @class BoxNode
+ * @classdesc Base node class for rendering rectangular boxes with layout, styling, and children.
+ * It uses the Yoga layout engine for positioning and sizing.
+ */
+export declare class BoxNode {
+    /**
+     * @property {Partial<BoxProps>} initialProps - Original props passed to the constructor before any modifications.
+     */
+    initialProps: Partial<BoxProps>;
+    /**
+     * @property {Node} node - The Yoga layout engine node.
+     */
+    node: Node;
+    /**
+     * @property {BoxNode[]} children - Child nodes.
+     */
+    children: BoxNode[];
+    /**
+     * @property {BoxProps & BaseProps} props - Current props including defaults and inherited values.
+     */
+    props: BoxProps & BaseProps;
+    /**
+     * @property {string} name - Node type name.
+     */
+    readonly name?: string;
+    /**
+     * @property {string} key - Unique node identifier.
+     */
+    key?: string;
+    /**
+     * Creates a new BoxNode instance
+     * @param props - Initial box properties and styling
+     */
+    constructor(props?: BoxProps & BaseProps);
+    /**
+     * Processes and appends any children passed in the initial props.
+     */
+    processInitialChildren(): void;
+    /**
+     * Inherits styles from the parent node.
+     * @param {BoxProps & BaseProps} parentProps - Parent node properties to inherit from.
+     */
+    protected resolveInheritedStyles(parentProps: BoxProps & BaseProps): void;
+    /**
+     * Applies node type-specific default values after inheritance.
+     */
+    protected applyDefaults(): void;
+    /**
+     * Appends a child node at the specified index.
+     * @param {BoxNode} child - Child node to append.
+     * @param index - Index to insert child at
+     */
+    protected appendChild(child: BoxNode, index: number): void;
+    /**
+     * Performs final layout adjustments recursively after the main layout calculation.
+     * @returns {boolean} Whether any node was marked as dirty during finalization.
+     */
+    finalizeLayout(): boolean;
+    /**
+     * Hook for subclasses to update layout based on computed size.
+     */
+    protected updateLayoutBasedOnComputedSize(): void;
+    /**
+     * Applies layout properties to the Yoga node.
+     * @param props - Box properties containing layout values
+     */
+    protected setLayout(props: BoxProps): void;
+    /**
+     * Renders the node and its children to the canvas.
+     * @param {CanvasRenderingContext2D} ctx - Canvas rendering context (from skia-canvas).
+     * @param {number} offsetX - X offset for rendering.
+     * @param {number} offsetY - Y offset for rendering.
+     */
+    render(ctx: CanvasRenderingContext2D, offsetX?: number, offsetY?: number): void;
+    /**
+     * Renders the node's visual content including background fills, shadows, and borders.
+     * This is an internal method used by the render() pipeline.
+     *
+     * @param ctx - The skia-canvas 2D rendering context to draw into
+     * @param x - The absolute x-coordinate where drawing should begin
+     * @param y - The absolute y-coordinate where drawing should begin
+     * @param width - The width of the content area to render
+     * @param height - The height of the content area to render
+     */
+    protected _renderContent(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number): void;
+}
+/**
+ * Creates a new BoxNode instance.
+ * @param {BoxProps} props - Box properties and configuration.
+ * @returns {BoxNode} New BoxNode instance.
+ */
+export declare const Box: (props: BoxProps) => BoxNode;
+/**
+ * @class ColumnNode
+ * Node class for vertical column layout
+ */
+export declare class ColumnNode extends BoxNode {
+    constructor(props?: BoxProps & BaseProps);
+}
+/**
+ * Creates a new ColumnNode instance.
+ * @param {BoxProps} props - Column properties and configuration.
+ * @returns {ColumnNode} New ColumnNode instance.
+ */
+export declare const Column: (props: BoxProps) => ColumnNode;
+/**
+ * @class RowNode
+ * @classdesc Node class for horizontal row layout.
+ */
+export declare class RowNode extends BoxNode {
+    constructor(props?: BoxProps & BaseProps);
+}
+/**
+ * Creates a new RowNode instance.
+ * @param {BoxProps} props - Row properties and configuration.
+ * @returns {RowNode} New RowNode instance.
+ */
+export declare const Row: (props: BoxProps) => RowNode;
+//# sourceMappingURL=layout.canvas.util.d.ts.map

package/dist/esm/canvas/layout.canvas.util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout.canvas.util.d.ts","sourceRoot":"","sources":["../../../src/canvas/layout.canvas.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAEnE,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAkB,MAAM,yBAAyB,CAAA;AAGlF,OAAa,EAAS,IAAI,EAAE,MAAM,4BAA4B,CAAA;AAE9D;;;;GAIG;AACH,qBAAa,OAAO;IAClB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC/B;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;gBACS,KAAK,GAAE,QAAQ,GAAG,SAAc;IAqB5C;;OAEG;IACI,sBAAsB;IAW7B;;;OAGG;IACH,SAAS,CAAC,sBAAsB,CAAC,WAAW,EAAE,QAAQ,GAAG,SAAS;IAkClE;;OAEG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI;IAI/B;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM;IAanD;;;OAGG;IACI,cAAc;IAiBrB;;OAEG;IACH,SAAS,CAAC,+BAA+B;IAIzC;;;OAGG;IACH,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ;IAqInC;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,wBAAwB,EAAE,OAAO,SAAI,EAAE,OAAO,SAAI;IAqK9D;;;;;;;;;OASG;IACH,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,wBAAwB,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CA6R5G;AAED;;;;GAIG;AACH,eAAO,MAAM,GAAG,GAAI,OAAO,QAAQ,YAAuB,CAAA;AAE1D;;;GAGG;AACH,qBAAa,UAAW,SAAQ,OAAO;gBACzB,KAAK,GAAE,QAAQ,GAAG,SAAc;CAS7C;AAED;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,QAAQ,eAA0B,CAAA;AAEhE;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,OAAO;gBACtB,KAAK,GAAE,QAAQ,GAAG,SAAc;CAS7C;AAED;;;;GAIG;AACH,eAAO,MAAM,GAAG,GAAI,OAAO,QAAQ,YAAuB,CAAA"}