Skip to content
ConsoleMonster
Class

ObjectExplorer

ConsoleMonster.Interactive

Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Modifiers
sealed

Browses object members lazily with the grid's keyboard and screen infrastructure.

Inheritance

  • object
  • ObjectExplorer

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public ObjectExplorer(object? value, InspectorOptions? options = null, string rootPath = "$x") #

Creates an explorer without reading nested values.

Parameters

value object? required
The object, dictionary, JSON value or collection to explore.
options ConsoleMonster.Data.InspectorOptions? = null optional
Member adapters and expansion limits.
rootPath string = "$x" optional
The root PowerShell expression used in returned paths.

Methods

public ExplorerNode? Show(InteractiveOptions? interactive = null, CancellationToken cancellationToken = default) #

Runs the keyboard explorer, returning the selected node on Ctrl+Enter or F10.

Parameters

interactive ConsoleMonster.Interactive.InteractiveOptions? = null optional
Input, output and theme options.
cancellationToken System.Threading.CancellationToken = default optional
Stops an active session.

Returns

ExplorerNode? The selected node, or null after cancellation or static fallback.
public IWidget Snapshot() #

Creates a deterministic, non-interactive initial view for previews and capture.

Returns

IWidget The initial explorer screen as a widget.
public ObjectExplorer WithTitle(string title) #

Sets the header title and returns this explorer for fluent composition.

Parameters

title string required
The plain header text.

Returns

ObjectExplorer This explorer.

Properties

public ExplorerNode Root { get; } #

The lazily inspected root.

public InspectorOptions Options { get; } #

The adapters and limits shared by each expansion.

public string Title { get; set; } #

The title in the screen header.