blecsd 0.1.0

package/dist/border-D_Jb4ZJV.d.ts

@@ -0,0 +1,257 @@
+import { W as World, E as Entity } from './types-BcsvoKzf.js';
+
+/**
+ * Border component for element borders.
+ * @module components/border
+ */
+
+/**
+ * Border type enumeration.
+ */
+declare enum BorderType {
+    /** No border */
+    None = 0,
+    /** Line border using box-drawing characters */
+    Line = 1,
+    /** Background color border */
+    Background = 2,
+    /** Custom characters border */
+    Custom = 3
+}
+/**
+ * Preset border character sets.
+ */
+interface BorderCharset {
+    readonly topLeft: number;
+    readonly topRight: number;
+    readonly bottomLeft: number;
+    readonly bottomRight: number;
+    readonly horizontal: number;
+    readonly vertical: number;
+}
+/**
+ * Single line border characters (─ │ ┌ ┐ └ ┘).
+ */
+declare const BORDER_SINGLE: BorderCharset;
+/**
+ * Double line border characters (═ ║ ╔ ╗ ╚ ╝).
+ */
+declare const BORDER_DOUBLE: BorderCharset;
+/**
+ * Rounded border characters (─ │ ╭ ╮ ╰ ╯).
+ */
+declare const BORDER_ROUNDED: BorderCharset;
+/**
+ * Bold/thick border characters (━ ┃ ┏ ┓ ┗ ┛).
+ */
+declare const BORDER_BOLD: BorderCharset;
+/**
+ * ASCII border characters (- | + + + +).
+ */
+declare const BORDER_ASCII: BorderCharset;
+/**
+ * Default foreground color for borders (white).
+ */
+declare const DEFAULT_BORDER_FG = 4294967295;
+/**
+ * Default background color for borders (transparent).
+ */
+declare const DEFAULT_BORDER_BG = 0;
+/**
+ * Border component store using SoA (Structure of Arrays) for performance.
+ *
+ * - `type`: Border type (0=none, 1=line, 2=bg, 3=custom)
+ * - `left`, `top`, `right`, `bottom`: Which sides have borders (0=no, 1=yes)
+ * - `fg`, `bg`: Border colors (packed RGBA)
+ * - `charTopLeft`, etc.: Unicode codepoints for border characters
+ *
+ * @example
+ * ```typescript
+ * import { Border, setBorder, getBorder, BorderType, BORDER_DOUBLE } from 'blecsd';
+ *
+ * setBorder(world, entity, { type: BorderType.Line });
+ * setBorderChars(world, entity, BORDER_DOUBLE);
+ *
+ * const border = getBorder(world, entity);
+ * console.log(border.type); // BorderType.Line
+ * ```
+ */
+declare const Border: {
+    /** Border type (0=none, 1=line, 2=bg, 3=custom) */
+    type: Uint8Array<ArrayBuffer>;
+    /** Left side enabled (0=no, 1=yes) */
+    left: Uint8Array<ArrayBuffer>;
+    /** Top side enabled (0=no, 1=yes) */
+    top: Uint8Array<ArrayBuffer>;
+    /** Right side enabled (0=no, 1=yes) */
+    right: Uint8Array<ArrayBuffer>;
+    /** Bottom side enabled (0=no, 1=yes) */
+    bottom: Uint8Array<ArrayBuffer>;
+    /** Foreground color (packed RGBA) */
+    fg: Uint32Array<ArrayBuffer>;
+    /** Background color (packed RGBA) */
+    bg: Uint32Array<ArrayBuffer>;
+    /** Top-left corner character (Unicode codepoint) */
+    charTopLeft: Uint32Array<ArrayBuffer>;
+    /** Top-right corner character (Unicode codepoint) */
+    charTopRight: Uint32Array<ArrayBuffer>;
+    /** Bottom-left corner character (Unicode codepoint) */
+    charBottomLeft: Uint32Array<ArrayBuffer>;
+    /** Bottom-right corner character (Unicode codepoint) */
+    charBottomRight: Uint32Array<ArrayBuffer>;
+    /** Horizontal edge character (Unicode codepoint) */
+    charHorizontal: Uint32Array<ArrayBuffer>;
+    /** Vertical edge character (Unicode codepoint) */
+    charVertical: Uint32Array<ArrayBuffer>;
+};
+/**
+ * Border configuration options.
+ */
+interface BorderOptions {
+    /** Border type */
+    type?: BorderType;
+    /** Enable left side */
+    left?: boolean;
+    /** Enable top side */
+    top?: boolean;
+    /** Enable right side */
+    right?: boolean;
+    /** Enable bottom side */
+    bottom?: boolean;
+    /** Foreground color (hex string or packed number) */
+    fg?: string | number;
+    /** Background color (hex string or packed number) */
+    bg?: string | number;
+    /** Preset border charset or custom characters */
+    chars?: BorderCharset;
+}
+/**
+ * Border data returned by getBorder.
+ */
+interface BorderData {
+    readonly type: BorderType;
+    readonly left: boolean;
+    readonly top: boolean;
+    readonly right: boolean;
+    readonly bottom: boolean;
+    readonly fg: number;
+    readonly bg: number;
+    readonly charTopLeft: number;
+    readonly charTopRight: number;
+    readonly charBottomLeft: number;
+    readonly charBottomRight: number;
+    readonly charHorizontal: number;
+    readonly charVertical: number;
+}
+/**
+ * Sets the border configuration of an entity.
+ * Adds the Border component if not already present.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @param options - Border configuration options
+ * @returns The entity ID for chaining
+ *
+ * @example
+ * ```typescript
+ * import { createWorld, addEntity } from '../core/ecs';
+ * import { setBorder, BorderType, BORDER_DOUBLE } from 'blecsd';
+ *
+ * const world = createWorld();
+ * const entity = addEntity(world);
+ *
+ * // Set a line border with double characters
+ * setBorder(world, entity, {
+ *   type: BorderType.Line,
+ *   chars: BORDER_DOUBLE,
+ *   fg: '#ff0000',
+ * });
+ *
+ * // Enable only top and bottom borders
+ * setBorder(world, entity, {
+ *   type: BorderType.Line,
+ *   left: false,
+ *   right: false,
+ * });
+ * ```
+ */
+declare function setBorder(world: World, eid: Entity, options: BorderOptions): Entity;
+/**
+ * Sets the border characters of an entity.
+ * Adds the Border component if not already present.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @param chars - Border character set
+ * @returns The entity ID for chaining
+ *
+ * @example
+ * ```typescript
+ * import { setBorderChars, BORDER_ROUNDED } from 'blecsd';
+ *
+ * setBorderChars(world, entity, BORDER_ROUNDED);
+ * ```
+ */
+declare function setBorderChars(world: World, eid: Entity, chars: BorderCharset): Entity;
+/**
+ * Gets the border data of an entity.
+ * Returns undefined if the entity doesn't have a Border component.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @returns Border data or undefined
+ *
+ * @example
+ * ```typescript
+ * import { getBorder } from 'blecsd';
+ *
+ * const border = getBorder(world, entity);
+ * if (border) {
+ *   console.log(`Type: ${border.type}, Left: ${border.left}`);
+ * }
+ * ```
+ */
+declare function getBorder(world: World, eid: Entity): BorderData | undefined;
+/**
+ * Checks if an entity has a Border component.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @returns true if entity has Border component
+ */
+declare function hasBorder(world: World, eid: Entity): boolean;
+/**
+ * Checks if an entity has any visible border (type !== None and at least one side enabled).
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @returns true if border is visible
+ */
+declare function hasBorderVisible(world: World, eid: Entity): boolean;
+/**
+ * Enables all border sides.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @returns The entity ID for chaining
+ */
+declare function enableAllBorders(world: World, eid: Entity): Entity;
+/**
+ * Disables all border sides.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @returns The entity ID for chaining
+ */
+declare function disableAllBorders(world: World, eid: Entity): Entity;
+/**
+ * Gets the border character for a specific position.
+ *
+ * @param world - The ECS world
+ * @param eid - The entity ID
+ * @param position - Position name
+ * @returns Unicode codepoint or undefined
+ */
+declare function getBorderChar(world: World, eid: Entity, position: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'horizontal' | 'vertical'): number | undefined;
+
+export { BORDER_ASCII as B, DEFAULT_BORDER_BG as D, BORDER_BOLD as a, BORDER_DOUBLE as b, BORDER_ROUNDED as c, BORDER_SINGLE as d, Border as e, type BorderCharset as f, type BorderData as g, type BorderOptions as h, BorderType as i, DEFAULT_BORDER_FG as j, disableAllBorders as k, enableAllBorders as l, getBorder as m, getBorderChar as n, hasBorder as o, hasBorderVisible as p, setBorderChars as q, setBorder as s };