tuil
ReferencePackages@mwillbanks/tuil-cellAPI

CellFrame

interface exported by @mwillbanks/tuil-cell.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-cell.

export interface CellFrame {
  readonly width: number;
  readonly height: number;
  readonly cells: readonly Cell[];
  readonly cursor?: CursorState;
  readonly semantics?: RendererScene["semantics"];
}

Members

MemberTypeRequiredDescriptionRelated types
widthnumberYesThe width member uses the number contract.
heightnumberYesThe height member uses the number contract.
cellsreadonly Cell[]YesThe cells member uses the readonly Cell[] contract.Cell
cursorCursorState | undefinedNoThe cursor member uses the CursorState | undefined contract.CursorState
semanticsreadonly SemanticMetadata[] | undefinedNoThe semantics member uses the readonly SemanticMetadata[] | undefined contract.SemanticMetadata

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-cell

On this page