tuiuiu.js 0.1.1

package/dist/components/grid.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Grid Layout System
+ *
+ * CSS Grid-inspired layout for terminal UIs.
+ * Supports:
+ * - Template-based grid definition (rows/columns)
+ * - Named areas
+ * - Gap control
+ * - Auto-placement
+ * - Span across cells
+ * - Alignment (justify/align items)
+ *
+ * @example
+ * ```typescript
+ * Grid({
+ *   columns: '1fr 2fr 1fr',
+ *   rows: 'auto 1fr auto',
+ *   gap: 1,
+ *   areas: `
+ *     "header header header"
+ *     "nav    main   aside"
+ *     "footer footer footer"
+ *   `,
+ * },
+ *   GridItem({ area: 'header' }, Text({}, 'Header')),
+ *   GridItem({ area: 'nav' }, Text({}, 'Nav')),
+ *   GridItem({ area: 'main' }, Text({}, 'Main')),
+ *   GridItem({ area: 'aside' }, Text({}, 'Aside')),
+ *   GridItem({ area: 'footer' }, Text({}, 'Footer'))
+ * )
+ * ```
+ */
+import type { VNode, BoxStyle } from '../utils/types.js';
+/** Track size specification */
+export type TrackSize = number | `${number}fr` | 'auto' | `minmax(${string},${string})` | 'min-content' | 'max-content';
+/** Parsed track definition */
+export interface ParsedTrack {
+    type: 'fixed' | 'fr' | 'auto' | 'minmax' | 'min-content' | 'max-content';
+    value: number;
+    min?: number;
+    max?: number;
+}
+/** Grid template areas */
+export interface GridArea {
+    name: string;
+    rowStart: number;
+    rowEnd: number;
+    colStart: number;
+    colEnd: number;
+}
+/** Alignment options */
+export type JustifyItems = 'start' | 'end' | 'center' | 'stretch';
+export type AlignItems = 'start' | 'end' | 'center' | 'stretch';
+export type JustifyContent = 'start' | 'end' | 'center' | 'stretch' | 'space-between' | 'space-around' | 'space-evenly';
+export type AlignContent = 'start' | 'end' | 'center' | 'stretch' | 'space-between' | 'space-around' | 'space-evenly';
+/** Grid container options */
+export interface GridOptions {
+    /** Column track definition (e.g., '1fr 2fr 1fr' or [10, '1fr', 'auto']) */
+    columns?: string | TrackSize[];
+    /** Row track definition */
+    rows?: string | TrackSize[];
+    /** Gap between cells (or [rowGap, columnGap]) */
+    gap?: number | [number, number];
+    /** Row gap specifically */
+    rowGap?: number;
+    /** Column gap specifically */
+    columnGap?: number;
+    /** Named areas template */
+    areas?: string;
+    /** Auto-placement direction */
+    autoFlow?: 'row' | 'column' | 'row dense' | 'column dense';
+    /** Size for auto-generated rows */
+    autoRows?: TrackSize;
+    /** Size for auto-generated columns */
+    autoColumns?: TrackSize;
+    /** Justify items within cells */
+    justifyItems?: JustifyItems;
+    /** Align items within cells */
+    alignItems?: AlignItems;
+    /** Justify grid within container */
+    justifyContent?: JustifyContent;
+    /** Align grid within container */
+    alignContent?: AlignContent;
+    /** Container width (defaults to terminal width) */
+    width?: number;
+    /** Container height (defaults to auto) */
+    height?: number;
+    /** Border around grid */
+    border?: boolean;
+    /** Border style */
+    borderStyle?: BoxStyle['borderStyle'];
+    /** Border color */
+    borderColor?: string;
+    /** Padding inside container */
+    padding?: number;
+}
+/** Grid item options */
+export interface GridItemOptions {
+    /** Named area to place in */
+    area?: string;
+    /** Starting column (1-based) */
+    column?: number | `${number} / ${number}` | `span ${number}`;
+    /** Starting row (1-based) */
+    row?: number | `${number} / ${number}` | `span ${number}`;
+    /** Column span */
+    columnSpan?: number;
+    /** Row span */
+    rowSpan?: number;
+    /** Column start (1-based) */
+    columnStart?: number;
+    /** Column end (1-based, exclusive) */
+    columnEnd?: number;
+    /** Row start (1-based) */
+    rowStart?: number;
+    /** Row end (1-based, exclusive) */
+    rowEnd?: number;
+    /** Override container's justifyItems for this item */
+    justifySelf?: JustifyItems;
+    /** Override container's alignItems for this item */
+    alignSelf?: AlignItems;
+    /** Order for auto-placement */
+    order?: number;
+}
+/** Resolved cell position */
+export interface CellPosition {
+    row: number;
+    column: number;
+    rowSpan: number;
+    columnSpan: number;
+}
+/** Grid layout result */
+export interface GridLayout {
+    columnSizes: number[];
+    rowSizes: number[];
+    cells: Map<VNode, CellPosition>;
+    areas: Map<string, GridArea>;
+}
+/**
+ * Parse a track size string into structured format
+ */
+export declare function parseTrackSize(size: TrackSize): ParsedTrack;
+/**
+ * Parse track definition string into array
+ * e.g., '1fr 2fr 1fr' -> [{ type: 'fr', value: 1 }, ...]
+ */
+export declare function parseTrackDefinition(definition: string | TrackSize[]): ParsedTrack[];
+/**
+ * Parse grid-template-areas string
+ */
+export declare function parseGridAreas(areasTemplate: string): Map<string, GridArea>;
+/**
+ * Calculate track sizes given available space
+ */
+export declare function calculateTrackSizes(tracks: ParsedTrack[], availableSpace: number, gap: number, contentSizes: number[]): number[];
+/**
+ * Calculate cell position for a grid item
+ */
+export declare function calculateCellPosition(options: GridItemOptions, areas: Map<string, GridArea>, columnCount: number, rowCount: number, autoPlacement: {
+    row: number;
+    column: number;
+}): CellPosition;
+/**
+ * Calculate complete grid layout
+ */
+export declare function calculateGridLayout(options: GridOptions, items: {
+    node: VNode;
+    options: GridItemOptions;
+}[], containerWidth: number, containerHeight?: number): GridLayout;
+/**
+ * Grid container component
+ */
+export declare function Grid(options: GridOptions, ...children: (VNode | null)[]): VNode;
+/**
+ * Grid item wrapper
+ */
+export declare function GridItem(options: GridItemOptions, ...children: (VNode | null)[]): VNode;
+/**
+ * Simple row grid (equal columns)
+ */
+export declare function GridRow(options: Omit<GridOptions, 'columns' | 'rows'> & {
+    columnCount?: number;
+}, ...children: (VNode | null)[]): VNode;
+/**
+ * Simple column grid (equal rows)
+ */
+export declare function GridColumn(options: Omit<GridOptions, 'columns' | 'rows'> & {
+    rowCount?: number;
+}, ...children: (VNode | null)[]): VNode;
+/**
+ * Auto-fitting grid (responsive columns)
+ */
+export declare function AutoGrid(options: Omit<GridOptions, 'columns'> & {
+    minColumnWidth: number;
+}, ...children: (VNode | null)[]): VNode;
+/**
+ * Dashboard-style grid with named areas
+ */
+export declare function DashboardGrid(options: {
+    width?: number;
+    height?: number;
+    gap?: number;
+    headerHeight?: number;
+    footerHeight?: number;
+    sidebarWidth?: number;
+    border?: boolean;
+    borderStyle?: BoxStyle['borderStyle'];
+    borderColor?: string;
+}, areas: {
+    header?: VNode;
+    sidebar?: VNode;
+    main: VNode;
+    footer?: VNode;
+}): VNode;
+/**
+ * Masonry-style grid (variable height items)
+ */
+export declare function MasonryGrid(options: {
+    columns: number;
+    gap?: number;
+    width?: number;
+}, ...children: (VNode | null)[]): VNode;
+/**
+ * Create a repeat track definition
+ */
+export declare function repeat(count: number, track: TrackSize): string;
+/**
+ * Create a minmax track
+ */
+export declare function minmax(min: TrackSize, max: TrackSize): `minmax(${string},${string})`;
+/**
+ * Calculate grid template from areas
+ */
+export declare function gridAreasToTemplate(areas: string[][]): string;
+//# sourceMappingURL=grid.d.ts.map

package/dist/components/grid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grid.d.ts","sourceRoot":"","sources":["../../src/components/grid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAOzD,+BAA+B;AAC/B,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,GAAG,MAAM,IAAI,GACb,MAAM,GACN,UAAU,MAAM,IAAI,MAAM,GAAG,GAC7B,aAAa,GACb,aAAa,CAAC;AAElB,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,aAAa,CAAC;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,0BAA0B;AAC1B,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wBAAwB;AACxB,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAClE,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAChE,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,KAAK,GACL,QAAQ,GACR,SAAS,GACT,eAAe,GACf,cAAc,GACd,cAAc,CAAC;AACnB,MAAM,MAAM,YAAY,GACpB,OAAO,GACP,KAAK,GACL,QAAQ,GACR,SAAS,GACT,eAAe,GACf,cAAc,GACd,cAAc,CAAC;AAEnB,6BAA6B;AAC7B,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,CAAC;IAC/B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,CAAC;IAC5B,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,cAAc,CAAC;IAC3D,mCAAmC;IACnC,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,sCAAsC;IACtC,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,iCAAiC;IACjC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,+BAA+B;IAC/B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,oCAAoC;IACpC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,kCAAkC;IAClC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mBAAmB;IACnB,WAAW,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wBAAwB;AACxB,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,GAAG,MAAM,MAAM,MAAM,EAAE,GAAG,QAAQ,MAAM,EAAE,CAAC;IAC7D,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,MAAM,MAAM,MAAM,EAAE,GAAG,QAAQ,MAAM,EAAE,CAAC;IAC1D,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,oDAAoD;IACpD,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAyB;AACzB,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAChC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CAC9B;AAMD;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CA4C3D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,WAAW,EAAE,CAuBpF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAmD3E;AAMD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,WAAW,EAAE,EACrB,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,MAAM,EAAE,GACrB,MAAM,EAAE,CAuDV;AA+CD;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,EAC5B,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC7C,YAAY,CA0Cd;AAMD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,eAAe,CAAA;CAAE,EAAE,EAClD,cAAc,EAAE,MAAM,EACtB,eAAe,CAAC,EAAE,MAAM,GACvB,UAAU,CAsJZ;AASD;;GAEG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,KAAK,CAyK/E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,KAAK,CAIvF;AAMD;;GAEG;AACH,wBAAgB,OAAO,CACrB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,MAAM,CAAC,GAAG;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,EACzE,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAC5B,KAAK,CAMP;AAED;;GAEG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,MAAM,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EACtE,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAC5B,KAAK,CAMP;AAED;;GAEG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,EAClE,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAC5B,KAAK,CAOP;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE;IACP,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,EACD,KAAK,EAAE;IACL,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,GACA,KAAK,CAiEP;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE;IACP,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,EACD,GAAG,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAC5B,KAAK,CAoDP;AAMD;;GAEG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAK9D;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,GAAG,UAAU,MAAM,IAAI,MAAM,GAAG,CAIpF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,CAE7D"}