Skip to main content
Module

x/cliffy/table/row.ts

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
Extremely Popular
Go to Latest
File
import { Cell, Direction, ICell } from "./cell.ts";
/** Row type */export type IRow<T extends ICell = ICell> = T[] | Row<T>;/** Json row. */export type IDataRow = Record<string, string | number>;
/** Row options. */export interface IRowOptions { indent?: number; border?: boolean; align?: Direction;}
/** * Row representation. */export class Row<T extends ICell = ICell> extends Array<T> { protected options: IRowOptions = {};
/** * Create a new row. If cells is a row, all cells and options of the row will * be copied to the new row. * @param cells Cells or row. */ public static from<T extends ICell = ICell>(cells: IRow<T>): Row<T> { const row = new this(...cells); if (cells instanceof Row) { row.options = { ...cells.options }; } return row; }
/** Clone row recursively with all options. */ public clone(): Row { const row = new Row( ...this.map((cell: T) => cell instanceof Cell ? cell.clone() : cell), ); row.options = { ...this.options }; return row; }
/** * Setter: */
/** * Enable/disable cell border. * @param enable Enable/disable cell border. * @param override Override existing value. */ public border(enable: boolean, override = true): this { if (override || typeof this.options.border === "undefined") { this.options.border = enable; } return this; }
/** * Align row content. * @param direction Align direction. * @param override Override existing value. */ public align(direction: Direction, override = true): this { if (override || typeof this.options.align === "undefined") { this.options.align = direction; } return this; }
/** * Getter: */
/** Check if row has border. */ public getBorder(): boolean { return this.options.border === true; }
/** Check if row or any child cell has border. */ public hasBorder(): boolean { return this.getBorder() || this.some((cell) => cell instanceof Cell && cell.getBorder()); }
/** Get row alignment. */ public getAlign(): Direction { return this.options.align ?? "left"; }}