TerminalScrollAreaOptions
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface TerminalScrollAreaOptions {
readonly id: string;
readonly viewport: ScrollViewport;
readonly extent: ScrollExtent;
readonly parentId?: string;
readonly sticky?: Partial<
Record<"top" | "bottom" | "left" | "right", boolean>
>;
readonly followFocus?: boolean;
readonly enabled?: boolean;
readonly initialPosition?: {
readonly x?: number;
readonly y?: number;
};
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
viewport | ScrollViewport | Yes | The viewport member uses the ScrollViewport contract. | ScrollViewport |
extent | ScrollExtent | Yes | The extent member uses the ScrollExtent contract. | ScrollExtent |
parentId | string | undefined | No | The parentId member uses the string | undefined contract. | — |
sticky | Partial<Record<"top" | "right" | "bottom" | "left", boolean>> | undefined | No | The sticky member uses the Partial<Record<"top" | "right" | "bottom" | "left", boolean>> | undefined contract. | — |
followFocus | boolean | undefined | No | The followFocus member uses the boolean | undefined contract. | — |
enabled | boolean | undefined | No | The enabled member uses the boolean | undefined contract. | — |
initialPosition | { readonly x?: number; readonly y?: number; } | undefined | No | The initialPosition member uses the { readonly x?: number; readonly y?: number; } | 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