Skip to content
ConsoleMonster
Class

WidgetPager

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
WidgetPager.cs:25
Modifiers
static

Pages a reading view through the existing console input and prompt surface lifecycle.

Inheritance

  • object
  • WidgetPager

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Read Markdown Guide

    CommonMark, native tables, highlighted code, safe links and interactive paging.

Methods

public static bool TryShow(IWidget content, string? title = null, InteractiveOptions? options = null, CancellationToken cancellationToken = default, int? contentWidth = null) #
WidgetPager.cs:25

Shows a pager only when rich interaction is available and the content exceeds the screen height. Returns false without acquiring input or emitting output when the caller should print the complete view statically.

Parameters

content ConsoleMonster.Layout.IWidget required
The document or other reading widget.
title string? = null optional
The pager title, shown literally; null uses the default document label.
options ConsoleMonster.Interactive.InteractiveOptions? = null optional
Input, screen capture, profile and theme; null uses the shared defaults.
cancellationToken System.Threading.CancellationToken = default optional
Cancels the interaction.
contentWidth int? = null optional
An optional maximum document width, retained when the physical surface resizes.

Returns

bool True if a pager ran, including when the reader quit; false if static output is appropriate.