Namespace SharpConsoleUI

Classes

ClosingEventArgs

Provides data for the window closing event, allowing cancellation of the close operation.

ConsoleWindowSystem

The main window system that manages console windows, input processing, and rendering. Provides window management, focus handling, theming, and event processing for console applications.

KeyPressedEventArgs

Provides data for the key pressed event within a window.

PtyShim

Entry-point helper that detects and runs the in-process PTY shim mode. Call RunIfShim(string[]) at the very start of Main before any UI initialisation.

Renderer

Handles rendering of windows and their content to the console display. Manages window borders, scrollbars, and content rendering with support for overlapping windows.

VisibleRegions

Calculates visible regions of windows by subtracting overlapping areas from higher z-order windows. Used by the rendering system to determine which portions of a window need to be drawn.

Window

Represents a window in the console UI system that can contain controls and handle user input. Implements IContainer for control management.

Window.WindowStateChangedEventArgs

Provides data for the window state changed event.

Structs

Color

Represents a 24-bit RGB color. Drop-in replacement for Spectre.Console.Color with identical constructor, property, and named-color API surface.

Enums

BorderStyle

Specifies the visual style of a window's border.

Direction

Specifies the direction of movement or navigation.

ResizeBorderDirections

Per-border movement permissions for window resizing. Each border has an Expand direction (border moves outward, window grows) and a Contract direction (border moves inward, window shrinks).

ResizeDirection

Specifies the direction from which a window is being resized.

TextDecoration

Text decoration flags for styled rendering. Multiple decorations can be combined using bitwise OR.

WindowState

Specifies the current state of a window.

WindowTopologyAction

Specifies the type of window topology operation.

Delegates

Window.WindowThreadDelegateAsync

Represents an asynchronous method that runs as the window's background task.