CursorState
interface exported by @mwillbanks/tuil-cell.
interface
Public interface exported by @mwillbanks/tuil-cell.
export interface CursorState {
readonly x: number;
readonly y: number;
readonly visible: boolean;
readonly shape?: "block" | "line" | "underline";
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
x | number | Yes | The x member uses the number contract. | — |
y | number | Yes | The y member uses the number contract. | — |
visible | boolean | Yes | The visible member uses the boolean contract. | — |
shape | "block" | "line" | "underline" | undefined | No | The shape member uses the "block" | "line" | "underline" | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
No package-local related types.
Source
View the secondary source reference