TigerCli API Map
Generated from DocFX metadata. Do not edit by hand.
This is a structured index of public TigerCli types for humans and AI tools. Type names link to the published DocFX reference; source paths link to the repository. Behavioral contracts live in XML documentation comments, the generated API reference, and the guides.
Coverage: 224 public types across 19 namespaces.
Regenerate with:
dotnet docfx docs/api-docfx/docfx.json
dotnet run --project internal/DocSamples -- api-map
ItTiger.Core
| Public type | Kind | Summary | Source |
|---|---|---|---|
| TigerTextAttribute | class |
Provides display text and optional localized resource keys for TigerCli-facing enum values, settings properties, and command metadata. | ItTiger.Core/TigerTextAttribute.cs |
ItTiger.Core.Resources
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ChainedResourceManager | class |
Resolves strings from a prioritized sequence of resource managers. | ItTiger.Core/Resources/ChainedResourceManager.cs |
ItTiger.TigerCli.Commands
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ITigerCliAppContribution | interface |
Contributes reusable, app-wide TigerCli configuration to a host application. | ItTiger.TigerCli/Commands/ITigerCliAppContribution.cs |
| TigerCliApp | class |
A configured TigerCli command application: the immutable result of Build. | ItTiger.TigerCli/Commands/TigerCliApp.cs |
| TigerCliAppBuilder | class |
Fluent builder for a TigerCliApp, obtained from CreateBuilder. | ItTiger.TigerCli/Commands/TigerCliAppBuilder.cs |
| TigerCliAppContributionBuilder | class |
Builds the app-wide configuration supplied by registered ITigerCliAppContribution instances. | ItTiger.TigerCli/Commands/TigerCliAppContributionBuilder.cs |
| TigerCliApplicationLink | class |
A help-footer link configured through the TigerCliAppBuilder link methods (AddLink, AddWebsite, AddRepository, AddDocumentation) or derived from assembly metadata. | ItTiger.TigerCli/Commands/TigerCliApplicationLink.cs |
| TigerCliApplicationMetadata | class |
The app's resolved display metadata — display name, versions, copyright, and help-footer links — assembled by Build from explicit builder calls and assembly-metadata defaults. | ItTiger.TigerCli/Commands/TigerCliApplicationMetadata.cs |
| TigerCliArgumentAttribute | class |
Binds a settings property to a positional command-line argument. | ItTiger.TigerCli/Commands/TigerCliArgumentAttribute.cs |
| TigerCliAsyncCommandHandler<TSettings, TExitCode> | class |
Base class for async command handlers returning a typed exit code. | ItTiger.TigerCli/Commands/TigerCliAsyncCommandHandler.cs |
| TigerCliAsyncCommandHandler<TSettings> | class |
Base class for async command handlers returning a raw integer exit code. | ItTiger.TigerCli/Commands/TigerCliAsyncCommandHandler.cs |
| TigerCliCommandAliasBuilder | class |
Configures a command alias registered via AddCommandAlias. | ItTiger.TigerCli/Commands/TigerCliCommandAliasBuilder.cs |
| TigerCliCommandBuilder | class |
Configures metadata, providers, and help-only environment-variable registrations for a single command registration. | ItTiger.TigerCli/Commands/TigerCliCommandBuilder.cs |
| TigerCliCommandGroupBuilder | class |
Configures a command group: a command-path prefix that owns a set of child commands. | ItTiger.TigerCli/Commands/TigerCliCommandGroupBuilder.cs |
| TigerCliEditLoad<TSettings> | class |
Result of an edit-command loader. | ItTiger.TigerCli/Commands/TigerCliEditLoad.cs |
| TigerCliExactlyOneOfAttribute | class |
Declares that exactly one of the listed option properties must be provided or resolved. | ItTiger.TigerCli/Commands/TigerCliExactlyOneOfAttribute.cs |
| TigerCliExitCategory | enum |
The middle layer of the layered exit model: a small, stable grouping of TigerCliExitKind values. | ItTiger.TigerCli/Commands/TigerCliExitCategory.cs |
| TigerCliExitKind | enum |
A portable semantic command outcome or specific framework reason a run ended. | ItTiger.TigerCli/Commands/TigerCliExitKind.cs |
| TigerCliExitOutcome | enum |
The coarsest layer of the layered exit model: whether a run ultimately succeeded or failed. | ItTiger.TigerCli/Commands/TigerCliExitOutcome.cs |
| TigerCliFileOpenAttribute | class |
Marks a string command option as an existing-file path that uses the inline file picker when TigerCli prompts for a missing value. | ItTiger.TigerCli/Commands/TigerCliFileOpenAttribute.cs |
| TigerCliFileOverwrite | enum |
Controls whether a TigerCliFileSaveAttribute option may resolve to an existing file. | ItTiger.TigerCli/Commands/TigerCliFileOverwrite.cs |
| TigerCliFileSaveAttribute | class |
Marks a string command option as an output-file path that uses the inline file picker when TigerCli prompts for a missing value. | ItTiger.TigerCli/Commands/TigerCliFileSaveAttribute.cs |
| TigerCliFolderSelectAttribute | class |
Marks a string / string? command option so that, when TigerCli needs to prompt for its missing value in semi-interactive mode, it uses the inline folder picker (InlineFolderSelect) instead of a plain text prompt. | ItTiger.TigerCli/Commands/TigerCliFolderSelectAttribute.cs |
| TigerCliGlobalOptionBuilder | class |
Registers simple app-wide global options supplied by app contributions. | ItTiger.TigerCli/Commands/TigerCliGlobalOptionBuilder.cs |
| TigerCliGlobalOptionContext | class |
Describes the active app run when a contributed global option is applied. | ItTiger.TigerCli/Commands/TigerCliGlobalOptionContext.cs |
| TigerCliMultiSelectAttribute | class |
Marks a collection command option as a multi-select. | ItTiger.TigerCli/Commands/TigerCliMultiSelectAttribute.cs |
| TigerCliOptionAttribute | class |
Binds a settings property to a named command-line option (e.g. -c / --connection). | ItTiger.TigerCli/Commands/TigerCliOptionAttribute.cs |
| TigerCliPromptConfiguration<TSettings> | class |
App-level compatibility surface for configuring property-scoped prompt providers for a settings type. | ItTiger.TigerCli/Commands/TigerCliPromptConfiguration.cs |
| TigerCliPromptContext | class |
Context passed to prompt and provider callbacks while TigerCli is resolving provider-backed values. | ItTiger.TigerCli/Commands/TigerCliPromptContext.cs |
| TigerCliPromptPropertyBuilder<TSettings, TValue> | class |
Registers a provider-backed prompt for one property selected from TigerCliPromptConfiguration. | ItTiger.TigerCli/Commands/TigerCliPromptConfiguration.cs |
| TigerCliPromptable | enum |
Per-option/per-argument prompting opinion, assigned through Promptable / Promptable. | ItTiger.TigerCli/Commands/TigerCliPromptable.cs |
| TigerCliProviderConfiguration | class |
Registers app-level named dynamic value providers, configured through TigerCliAppBuilder.ConfigureProviders(...). | ItTiger.TigerCli/Commands/TigerCliProviderConfiguration.cs |
| TigerCliProviderContext | class |
Run-time context passed to dynamic value-provider callbacks. | ItTiger.TigerCli/Commands/TigerCliProviderContext.cs |
| TigerCliProviderOptions | class |
Optional per-registration provider options, supplied through the trailing configure callback on the provider registration APIs (AddProvider, AddAsyncProvider, Add, AddAsync). | ItTiger.TigerCli/Commands/TigerCliProviderOptions.cs |
| TigerCliRawArgumentsAttribute | class |
Declares that a command accepts a raw trailing argument tail: every command-line token after the first -- separator, bound literally and in order. | ItTiger.TigerCli/Commands/TigerCliRawArgumentsAttribute.cs |
| TigerCliSettings | class |
Base class for command settings. | ItTiger.TigerCli/Commands/TigerCliSettings.cs |
| TigerCliValidationResult | class |
Result of Validate: either success or a failure carrying a user-facing error message. | ItTiger.TigerCli/Commands/TigerCliValidationResult.cs |
| TigerCliValueMatchPreset | enum |
Controls how a supplied command-line value is matched against a provider-backed option's / argument's choices during non-interactive validation and multi-select resolution. | ItTiger.TigerCli/Commands/TigerCliValueMatchPreset.cs |
ItTiger.TigerCli.Enums
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ActivityOutcome | enum |
The terminal outcome of a rich activity dialog run. | ItTiger.TigerCli/Enums/ActivityOutcome.cs |
| ActivityStopMode | enum |
The single stop action a rich activity dialog exposes. | ItTiger.TigerCli/Enums/ActivityStopMode.cs |
| CliAnsiSupport | enum |
The level of ANSI support detected for a console stream by TerminalCapabilities. | ItTiger.TigerCli/Enums/CliAnsiSupport.cs |
| CliCellPadding | enum |
Horizontal padding applied inside a rendered cell. | ItTiger.TigerCli/Enums/CliCellPadding.cs |
| CliColor | enum |
The full ANSI 256-color palette as a single enum. | ItTiger.TigerCli/Enums/CliColor.cs |
| CliColorMode | enum |
Controls how TigerCli's default console output paths emit colour. | ItTiger.TigerCli/Enums/CliColorMode.cs |
| CliColumnSizing | enum |
Controls how a column's width is determined after content-driven sizing. | ItTiger.TigerCli/Enums/CliColumnSizing.cs |
| CliControlDecoration | enum |
Decoration flags requested by inline controls, such as scroll indicators and scroll bars. | ItTiger.TigerCli/Enums/CliControlDecoration.cs |
| CliFormattingMode | enum |
Controls whether cell content is treated as raw data or preformatted markup-aware text. | ItTiger.TigerCli/Enums/CliFormattingMode.cs |
| CliFrameJoinStyle | enum |
Controls how crossing frame segments choose junction glyphs. | ItTiger.TigerCli/Enums/CliFrameJoinStyle.cs |
| CliFrameLineType | enum |
Identifies the logical side or direction of a frame line. | ItTiger.TigerCli/Enums/CliFrameLineType.cs |
| CliFrameSegmentStyle | enum |
Visual style for a table or grid frame segment. | ItTiger.TigerCli/Enums/CliFrameSegmentStyle.cs |
| CliGridAxis | enum |
Selects whether a grid axis operation targets a row or a column. | ItTiger.TigerCli/Enums/CliGridAxis.cs |
| CliHyperlinkMode | enum |
Controls whether TigerCli's ANSI output emits OSC 8 clickable hyperlinks for text that carries a resolved hyperlink target (e.g. [Link]…[/] markup, or CliDetails.AddLink / CliList.AddLinkColumn values). | ItTiger.TigerCli/Enums/CliHyperlinkMode.cs |
| CliOrientation | enum |
One-dimensional orientation used by overlays and layout strips. | ItTiger.TigerCli/Enums/CliOrientation.cs |
| CliScrollAxis | enum |
Indicates whether an axis is pinned or scrollable in internal scroll layout. | ItTiger.TigerCli/Enums/CliScrollAxis.cs |
| CliScrollMode | enum |
Selects which axes of a hosted subgrid cell are scrollable. | ItTiger.TigerCli/Enums/CliScrollMode.cs |
| CliScrollThumbMode | enum |
Determines whether the scrollbar thumb represents the physical scroll offset or the logical active point (cursor) position. | ItTiger.TigerCli/Enums/CliScrollThumbMode.cs |
| CliSinkTarget | enum |
What a text-writing render sink is writing to. | ItTiger.TigerCli/Enums/CliSinkTarget.cs |
| CliStylePrecedence | enum |
Determines whether a row style or a column style wins when both contribute the same cell style property. | ItTiger.TigerCli/Enums/CliStylePrecedence.cs |
| CliTableOrientation | enum |
Specifies the orientation of a CLI table. | ItTiger.TigerCli/Enums/CliTableOrientation.cs |
| CliTableStyleOrientationSupport | enum |
Which orientations a predefined city table style (see CliTableStyles) is intended for. | ItTiger.TigerCli/Enums/CliTableStyleOrientationSupport.cs |
| CliTableStylePreset | enum |
The single source of truth for built-in table style presets (see CliTableStyles). | ItTiger.TigerCli/Enums/CliTableStylePreset.cs |
| CliTextAlignment | enum |
Horizontal text alignment inside a measured cell. | ItTiger.TigerCli/Enums/CliTextAlignment.cs |
| CliTextDecoration | enum |
Text decoration attributes that can be combined on a styled span. | ItTiger.TigerCli/Enums/CliTextDecoration.cs |
| CliVerticalAlignment | enum |
Vertical content alignment inside a measured cell. | ItTiger.TigerCli/Enums/CliVerticalAlignment.cs |
| CliWrapMode | enum |
Line-breaking strategy used by CliWrapping. | ItTiger.TigerCli/Enums/CliWrapMode.cs |
| CommandMenuMode | enum |
Opt-in policy for whether a node (app, command group, or command) participates in the discoverable command menu. | ItTiger.TigerCli/Enums/CommandMenuMode.cs |
| CursorMode | enum |
Cursor visibility requested by a grid or inline widget. | ItTiger.TigerCli/Enums/CursorMode.cs |
| DialogConfirmationKinds | enum |
The confirmable dialog result kinds an InlineDialog can gate behind an "are you sure?" confirmation. | ItTiger.TigerCli/Enums/DialogConfirmationKinds.cs |
| DialogResultKind | enum |
Result kind returned by modal and inline dialog interactions. | ItTiger.TigerCli/Enums/DialogResultKind.cs |
| HtmlHyperlinkMode | enum |
Controls how HtmlSink renders a text run that carries a HyperlinkTarget. | ItTiger.TigerCli/Enums/HtmlHyperlinkMode.cs |
| InlineDialogArea | enum |
Fixed layout areas where an inline dialog can place title, frame, status, widgets, and activity overlays. | ItTiger.TigerCli/Enums/InlineDialogArea.cs |
| MessageBoxButtons | enum |
The button set shown by a message-box style inline dialog. | ItTiger.TigerCli/Enums/MessageBoxButtons.cs |
| MessageBoxKind | enum |
The semantic severity of a message-box style inline dialog. | ItTiger.TigerCli/Enums/MessageBoxKind.cs |
| ProgressBarCaps | enum |
Optional end-cap decoration for an activity progress bar. | ItTiger.TigerCli/Enums/ProgressBarCaps.cs |
| ProgressBarColorMode | enum |
How an activity progress bar is coloured. | ItTiger.TigerCli/Enums/ProgressBarColorMode.cs |
| ProgressBarStyle | enum |
A predefined progress-bar glyph appearance for an activity dialog's progress-bar element. | ItTiger.TigerCli/Enums/ProgressBarStyle.cs |
| SelectOrder | enum |
Ordering mode for selectable option collections. | ItTiger.TigerCli/Enums/SelectOrder.cs |
| SpinnerFrameSet | enum |
A predefined spinner frame sequence owned by SpinnerTicker. | ItTiger.TigerCli/Enums/SpinnerFrameSet.cs |
| SurfaceRole | enum |
A reusable UI surface family resolved by an ITheme into concrete colours (see SurfaceColors). | ItTiger.TigerCli/Enums/SurfaceRole.cs |
| TableAccent | enum |
A semantic accent role a table style recipe (see CliTableStyleRecipe) references for foreground-only elements such as the title or frame. | ItTiger.TigerCli/Enums/TableAccent.cs |
| ThemeStyle | enum |
Semantic style roles resolved by an ITheme into concrete cell styles. | ItTiger.TigerCli/Enums/ThemeStyle.cs |
| TigerCliInteractionMode | enum |
Controls whether a command run may use interactive TigerCli UI while resolving command input. | ItTiger.TigerCli/Enums/TigerCliInteractionMode.cs |
| TigerCliPromptMode | enum |
Controls which missing values TigerCli may prompt for when the effective interaction mode allows semi-interactive prompting. | ItTiger.TigerCli/Enums/TigerCliPromptMode.cs |
| TigerCliRenderStage | enum |
Rendering pipeline stage associated with a TigerCliException. | ItTiger.TigerCli/Enums/TigerCliRenderStage.cs |
| TigerCliTheme | enum |
Selects a TigerCli UI theme. | ItTiger.TigerCli/Enums/TigerCliTheme.cs |
| TigerThemeFamily | enum |
The contrast family a theme belongs to. | ItTiger.TigerCli/Enums/TigerThemeFamily.cs |
ItTiger.TigerCli.Exceptions
| Public type | Kind | Summary | Source |
|---|---|---|---|
| TigerCliCommandException | class |
Classified command failure for handlers — especially reusable command libraries — that want to express what kind of failure occurred using TigerCli concepts without owning the application's numeric exit-code scheme. | ItTiger.TigerCli/Exceptions/TigerCliCommandException.cs |
| TigerCliException | class |
Exception raised for TigerCli framework failures that should identify the render or execution stage where the failure occurred. | ItTiger.TigerCli/Exceptions/TigerCliException.cs |
| TigerCliProviderException | class |
Deliberate failure signal for dynamic value providers. | ItTiger.TigerCli/Exceptions/TigerCliProviderException.cs |
| TigerCliSystemCancellationException | class |
Thrown by the simple (collapsing) TigerTui prompt helpers when the underlying modal completed with SystemCancel — a process/system cancellation request such as Ctrl-C / SIGINT / SIGTERM / SIGQUIT. | ItTiger.TigerCli/Exceptions/TigerCliSystemCancellationException.cs |
ItTiger.TigerCli.Markup
| Public type | Kind | Summary | Source |
|---|---|---|---|
| CliMarkupParser | class |
Parses TigerCli bracket markup into styled text segments. | ItTiger.TigerCli/Markup/CliMarkupParser.cs |
| IColorAliasResolver | interface |
Resolves an application-defined raw colour alias (e.g. BrandOrange) to a concrete CliColor. | ItTiger.TigerCli/Markup/IColorAliasResolver.cs |
| IMarkupStyleResolver | interface |
Resolves a curated semantic markup token (e.g. Accent, Alert) to concrete foreground/background colours. | ItTiger.TigerCli/Markup/IMarkupStyleResolver.cs |
| ThemeMarkupStyleResolver | class |
Theme-backed IMarkupStyleResolver exposing the curated framework semantic markup tokens plus, optionally, an app's registered custom semantic styles. | ItTiger.TigerCli/Markup/ThemeMarkupStyleResolver.cs |
ItTiger.TigerCli.PngSink
| Public type | Kind | Summary | Source |
|---|---|---|---|
| PngFontSource | class |
Describes the font files used by the PNG renderer for terminal text or title text. | ItTiger.TigerCli.PngSink/PngFontSource.cs |
| PngOverflowMode | enum |
Controls how PngSink handles text written beyond the configured grid dimensions. | ItTiger.TigerCli.PngSink/PngOverflowMode.cs |
| PngRenderer | class |
Convenience methods for rendering TigerCli grids and renderable components to PNG output. | ItTiger.TigerCli.PngSink/PngRenderer.cs |
| PngSink | class |
An ICliRenderSink that captures TigerCli text segments into a fixed-size terminal grid and materializes the result as a PNG image. | ItTiger.TigerCli.PngSink/PngSink.cs |
| PngSinkOptions | class |
Immutable options used by PngSink and PngRenderer to size and style a rendered PNG image. | ItTiger.TigerCli.PngSink/PngSinkOptions.cs |
| PngTitleBarIcon | class |
Describes the icon rendered in the PNG title bar when window chrome is enabled. | ItTiger.TigerCli.PngSink/PngTitleBarIcon.cs |
| PngTitleBarSymbols | class |
Describes the window-control symbol strip rendered in the PNG title bar when window chrome is enabled. | ItTiger.TigerCli.PngSink/PngTitleBarSymbols.cs |
| PngWindowChrome | enum |
Controls whether PNG output is just the terminal content area or includes TigerCli's terminal frame and title bar. | ItTiger.TigerCli.PngSink/PngWindowChrome.cs |
ItTiger.TigerCli.Primitives
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ActivePoint | class |
'A logical position within a grid: column, row, and character offset inside the cell content.' | ItTiger.TigerCli/Primitives/ActivePoint.cs |
| CliCellStyle | class |
Style information applied to grid cells, rows, columns, and table bands. | ItTiger.TigerCli/Primitives/CliCellStyle.cs |
| CliCharStyle | struct |
Character-level style for foreground/background colours, text decorations, and hyperlink target. | ItTiger.TigerCli/Primitives/CliCharStyle.cs |
| CliColorMapper | class |
Converts between TigerCli's CliColor palette and the legacy ConsoleColor API, and parses raw color names used by markup. | ItTiger.TigerCli/Primitives/CliColorMapper.cs |
| CliColorPalette | class |
RGB source of truth for CliColor across the full ANSI 0–255 palette, plus the down-conversion used to degrade a 256-color value to the nearest standard 0–15 color until a 256-color (ANSI) sink exists. | ItTiger.TigerCli/Primitives/CliColorPalette.cs |
| CliFormatter | class |
Formats arbitrary cell values before they are escaped or interpreted as markup by the rendering pipeline. | ItTiger.TigerCli/Primitives/CliFormatter.cs |
| CliFrameLine | class |
A frame line scheduled inside a frame area. | ItTiger.TigerCli/Primitives/CliFrameLine.cs |
| CliFrameSegment | class |
Describes the visual style of one frame segment, with optional custom content. | ItTiger.TigerCli/Primitives/CliFrameSegment.cs |
| CliGridAxisDefinition | class |
Base definition for a grid row or column axis. | ItTiger.TigerCli/Primitives/CliGridAxisDefinition.cs |
| CliGridCell | class |
A single grid cell definition, holding either scalar content or a hosted subgrid plus optional style and span information. | ItTiger.TigerCli/Primitives/CliGridCell.cs |
| CliGridColumnDefinition | class |
Column definition for a CliGrid, including style and sizing mode. | ItTiger.TigerCli/Primitives/CliGridColumnDefinition.cs |
| CliGridRowDefinition | class |
Row definition for a CliGrid, including row style. | ItTiger.TigerCli/Primitives/CliGridRowDefinition.cs |
| CliLayoutComponent | class |
Base layout constraints shared by renderable components and grids. | ItTiger.TigerCli/Primitives/CliLayoutComponent.cs |
| CliOverlay | class |
A post-layout, one-dimensional strip that can overwrite measured cells in a CliGrid after the standard measurement pass. | ItTiger.TigerCli/Primitives/CliOverlay.cs |
| CliOverlayGlyph | struct |
A single character emitted by a CliStyledOverlayRenderer, optionally carrying its own per-character style. | ItTiger.TigerCli/Primitives/CliOverlay.cs |
| CliOverlayRenderer | delegate |
A delegate that produces the renderable content for a CliOverlay. | ItTiger.TigerCli/Primitives/CliOverlay.cs |
| CliPoint | struct |
A zero-based (column, row) position within a CliGrid. | ItTiger.TigerCli/Primitives/CliPoint.cs |
| CliRenderCell | struct |
Character and console colours stored in a render buffer cell. | ItTiger.TigerCli/Primitives/CliRenderCell.cs |
| CliScrollableCell | class |
Scroll state for a grid cell that hosts a scrollable subgrid. | ItTiger.TigerCli/Primitives/CliScrollableCell.cs |
| CliStyledOverlayRenderer | delegate |
A delegate that produces styled per-character content for a CliOverlay. | ItTiger.TigerCli/Primitives/CliOverlay.cs |
| CliTableFrameConfig | class |
Frame and separator configuration used by CliTable when building its grid. | ItTiger.TigerCli/Primitives/CliTableFrameConfig.cs |
| CliTableStyle | class |
Resolved, renderable table defaults — the output of resolving a CliTableStyleRecipe against an ITheme. | ItTiger.TigerCli/Primitives/CliTableStyle.cs |
| CliTextSegment | class |
A contiguous run of text with a single character style. | ItTiger.TigerCli/Primitives/CliTextSegment.cs |
| CliWrapping | class |
Text wrapping and truncation policy for rendered cell content. | ItTiger.TigerCli/Primitives/CliWrapping.cs |
| ConsoleSymbol | class |
Shared Unicode symbols used by frames, overlays, indicators, and inline controls. | ItTiger.TigerCli/Primitives/ConsoleSymbol.cs |
| KeyEvent | struct |
Keyboard event captured by a terminal or test terminal. | ItTiger.TigerCli/Primitives/KeyEvent.cs |
| MeasuredActivePoint | class |
The result of mapping an ActivePoint through the measurement pipeline. | ItTiger.TigerCli/Primitives/MeasuredActivePoint.cs |
| MeasuredCell | class |
Measured representation of a grid cell after formatting, markup parsing, and layout. | ItTiger.TigerCli/Primitives/MeasuredCell.cs |
| OptionItem<TKey> | struct |
A provider choice with a canonical key and a user-facing label. | ItTiger.TigerCli/Primitives/OptionItem.cs |
| Size | struct |
Width and height pair. | ItTiger.TigerCli/Primitives/Size.cs |
| SurfaceColors | struct |
The concrete colours a theme resolves for a SurfaceRole: the surface Background plus the optional alternate-record (zebra) colours used for data cells. | ItTiger.TigerCli/Primitives/SurfaceColors.cs |
ItTiger.TigerCli.Rendering
| Public type | Kind | Summary | Source |
|---|---|---|---|
| CliDetails | class |
App-facing convenience builder for one-record key/value detail views ("Name: value" panels). | ItTiger.TigerCli/Rendering/CliDetails.cs |
| CliFrameArea | class |
Describes a rectangular frame region owned by a CliGrid. | ItTiger.TigerCli/Rendering/CliFrameArea.cs |
| CliGrid | class |
Lower-level grid layout and rendering building block used by tables, detail/list builders, and TUI widgets. | ItTiger.TigerCli/Rendering/CliGrid.Wrapping.cs |
| CliList<T> | class |
App-facing convenience builder for list command output: a column-per-field, record-per-item table. | ItTiger.TigerCli/Rendering/CliList.cs |
| CliOverlayEdge | enum |
Which edge a horizontal scroll indicator sits on. | ItTiger.TigerCli/Rendering/CliOverlayRenderers.cs |
| CliOverlayRenderers | class |
Reusable CliOverlayRenderer factories for the common one-dimensional overlays (vertical scrollbar, horizontal scroll indicators, time-/state-driven text such as a spinner or clock). | ItTiger.TigerCli/Rendering/CliOverlayRenderers.cs |
| CliRenderBuffer | class |
Low-level dirty-cell console render buffer used by interactive rendering paths. | ItTiger.TigerCli/Rendering/CliRenderBuffer.cs |
| CliRenderableComponent | class |
Base class for renderable components that share layout constraints and convert to a CliGrid for output. | ItTiger.TigerCli/Rendering/CliRenderableComponent.cs |
| CliTable | class |
App-facing convenience API for CliTable: theme-driven defaults plus terse header and record construction. | ItTiger.TigerCli/Rendering/CliTable.cs |
| CliTableElement | class |
Describes a single table element (column in Vertical, row in Horizontal). | ItTiger.TigerCli/Rendering/CliTableElement.cs |
| CliTableHeader | class |
Represents the header of a CLI table, including visibility and structural elements. | ItTiger.TigerCli/Rendering/CliTableHeader.cs |
| CliTableStyleRecipe | class |
A colour-free table style "recipe": the structural and role-based definition of a table preset (frame configuration, padding, surface role, and title/frame accent roles). | ItTiger.TigerCli/Rendering/CliTableStyleRecipe.cs |
| CliTableStyles | class |
Convenience facade over the predefined table style presets. | ItTiger.TigerCli/Rendering/CliTableStyles.cs |
| CliTableTitle | class |
Title content and style used by CliTable when materializing a table. | ItTiger.TigerCli/Primitives/CliTableTitle.cs |
| ICliRenderable | interface |
Represents a component that can materialize itself as a CliGrid for measurement and rendering. | ItTiger.TigerCli/Rendering/ICliRenderable.cs |
ItTiger.TigerCli.Terminal
| Public type | Kind | Summary | Source |
|---|---|---|---|
| AnsiSink | class |
An ICliRenderSink that writes styled output as ANSI SGR escape sequences to a TextWriter. | ItTiger.TigerCli/Terminal/AnsiSink.cs |
| ConsoleTerminal | class |
Real console-backed terminal implementation. | ItTiger.TigerCli/Terminal/ConsoleTerminal.cs |
| ConsoleTerminalState | class |
Snapshot of real console state captured by ConsoleTerminal so the terminal can restore colors after an interactive render. | ItTiger.TigerCli/Terminal/ConsoleTerminalState.cs |
| HtmlSink | class |
An ICliRenderSink that renders TigerCli text segments to deterministic HTML — for snapshot tests (internal and external) and for generating documentation examples from real rendering. | ItTiger.TigerCli/Terminal/HtmlSink.cs |
| HtmlSinkOptions | class |
Options for HtmlSink. | ItTiger.TigerCli/Terminal/HtmlSinkOptions.cs |
| ICliRenderSink | interface |
Sink abstraction used by the render pipeline to write styled text segments. | ItTiger.TigerCli/Terminal/ICliRenderSink.cs |
| ICliTerminal | interface |
Terminal abstraction used by interactive rendering and test hosts. | ItTiger.TigerCli/Terminal/ICliTerminal.cs |
| ITerminalState | interface |
Snapshot marker interface for terminal state captured before an interactive render. | ItTiger.TigerCli/Terminal/ITerminalState.cs |
| TerminalCapabilities | class |
Detects the ANSI capability of a console stream for Auto. | ItTiger.TigerCli/Terminal/TerminalCapabilities.cs |
| TigerConsole | class |
Static entry point for TigerCli console output, markup rendering, structured rendering, themes, colour mode, and test/documentation capture helpers. | ItTiger.TigerCli/Terminal/TigerConsole.Themes.cs |
ItTiger.TigerCli.Testing
| Public type | Kind | Summary | Source |
|---|---|---|---|
| TigerCliAppRunResult | class |
Result of a TigerCliAppTestHost run: the process exit code the app would have returned, plus the text captured from Out and Error during the run. | ItTiger.TigerCli/Testing/TigerCliAppRunResult.cs |
| TigerCliAppTestHost | class |
App-level test host for running a TigerCliApp without the real console input path. | ItTiger.TigerCli/Testing/TigerCliAppTestHost.cs |
ItTiger.TigerCli.Tui
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ActivityResult<T> | struct |
The rich outcome of a TigerTui activity run: the ActivityOutcome, the exact modal DialogResultKind it was derived from, the produced Value (meaningful only when Completed), and the Exception (set only when Failed). | ItTiger.TigerCli/Tui/ActivityResult.cs |
| TigerTui | class |
Facade for TigerCli's semi-interactive prompts, message boxes, folder picker, custom dialog hosting, and activity/progress dialogs. | ItTiger.TigerCli/Tui/TigerTui.Shell.cs |
| TigerTuiResult<T> | struct |
The rich outcome of a TigerCli modal prompt: the exact DialogResultKind the modal loop reported, plus the produced Value (meaningful only when the prompt completed with Ok). | ItTiger.TigerCli/Tui/TigerTuiResult.cs |
ItTiger.TigerCli.Tui.Abstractions
| Public type | Kind | Summary | Source |
|---|---|---|---|
| DialogBase | class |
Base class for renderable modal dialogs that expose a result and optional payload. | ItTiger.TigerCli/Tui/Abstractions/DialogBase.cs |
| DialogResult | struct |
Result returned by a modal dialog, preserving the exact result kind and any optional payload. | ItTiger.TigerCli/Tui/Abstractions/DialogResult.cs |
| FolderEntry | struct |
A single selectable folder row in IFolderBrowser: either a child directory or, at the Windows top level, a drive root. | ItTiger.TigerCli/Tui/Abstractions/IFolderBrowser.cs |
| ICliAppShell | interface |
Host abstraction for running TigerCli modal dialogs against a terminal, theme, viewport, and interaction policy. | ItTiger.TigerCli/Tui/Abstractions/ICliAppShell.cs |
| ICliDialog | interface |
Renderable modal dialog contract for controls that can be hosted by an ICliAppShell. | ItTiger.TigerCli/Tui/Abstractions/ICliDialog.cs |
| IControl | interface |
Basic modal-control contract used by dialog hosts that dispatch keyboard input to renderable UI. | ItTiger.TigerCli/Tui/Abstractions/IControl.cs |
| IFolderBrowser | interface |
Filesystem navigation policy used by InlineFolderSelect. | ItTiger.TigerCli/Tui/Abstractions/IFolderBrowser.cs |
| IModalLifecycle | interface |
Implemented by a dialog that needs to know the bounds of its modal session — when the semi-interactive modal loop begins and ends hosting it. | ItTiger.TigerCli/Tui/Abstractions/IModalLifecycle.cs |
| IModalRefreshSource | interface |
Implemented by a dialog that has time-driven content (periodic overlays). | ItTiger.TigerCli/Tui/Abstractions/IModalRefreshSource.cs |
| ITheme | interface |
Resolves semantic TigerCli style and surface roles to concrete render styles for TUI controls, markup, and structured rendering. | ItTiger.TigerCli/Tui/Abstractions/ITheme.cs |
| InlineActivityOverlay | class |
Describes a time-varying overlay an inline control exposes to its hosting InlineDialog. | ItTiger.TigerCli/Tui/Abstractions/InlineActivityOverlay.cs |
| InlineControlBase | class |
Base class for dialog-hostable inline controls. | ItTiger.TigerCli/Tui/Abstractions/InlineControlBase.cs |
| InlineDialogWidget | class |
Describes one top-level widget/area an inline control exposes to its hosting InlineDialog. | ItTiger.TigerCli/Tui/Abstractions/InlineDialogWidget.cs |
| InlineKeyResult | struct |
The outcome of an inline control/widget handling a key. | ItTiger.TigerCli/Tui/Abstractions/InlineKeyResult.cs |
| InlineWidget | class |
A reusable interactive building block used inside composite inline controls. | ItTiger.TigerCli/Tui/Abstractions/InlineWidget.cs |
| TuiTicker | class |
A time-driven source of overlay content for semi-interactive dialogs. | ItTiger.TigerCli/Tui/Abstractions/TuiTicker.cs |
ItTiger.TigerCli.Tui.Activity
| Public type | Kind | Summary | Source |
|---|---|---|---|
| ActivityCellBuilder | class |
Fluent builder for a single cell. | ItTiger.TigerCli/Tui/Activity/ActivityBuilders.cs |
| ActivityCellSpec | class |
Immutable placement of one ActivityElement within a row: the anchor Column and how many columns it Spans. | ItTiger.TigerCli/Tui/Activity/ActivityCellSpec.cs |
| ActivityColumnSpec | class |
Immutable column definition for an ActivityDialogSpec: an optional fixed Width (mutually exclusive with Star), default cell Alignment, and an optional default Style. | ItTiger.TigerCli/Tui/Activity/ActivityColumnSpec.cs |
| ActivityContext | class |
The safe, thread-safe surface a background activity operation uses to report progress. | ItTiger.TigerCli/Tui/Activity/ActivityContext.cs |
| ActivityDialogSpec | class |
Immutable description of a rich activity dialog's live layout: variable columns and rows of cells, with named dynamic rows carrying fixed-length value arrays. | ItTiger.TigerCli/Tui/Activity/ActivityDialogSpec.cs |
| ActivityElement | class |
Base type for the renderable element hosted by an ActivityCellSpec. | ItTiger.TigerCli/Tui/Activity/ActivityElement.cs |
| ActivityProgressBarElement | class |
A progress-bar element bound to row-local values. | ItTiger.TigerCli/Tui/Activity/ActivityElement.cs |
| ActivityRowBuilder | class |
Fluent builder for a single ActivityRowSpec. | ItTiger.TigerCli/Tui/Activity/ActivityBuilders.cs |
| ActivityRowSpec | class |
Immutable row definition. | ItTiger.TigerCli/Tui/Activity/ActivityRowSpec.cs |
| ActivitySpecBuilder | class |
Fluent builder for an ActivityDialogSpec. | ItTiger.TigerCli/Tui/Activity/ActivityDialogSpec.cs |
| ActivitySpinnerSpec | class |
Configures the spinner an activity dialog shows on its top frame. | ItTiger.TigerCli/Tui/Activity/ActivitySpinnerSpec.cs |
| ActivityTextCellBuilder | class |
Continues the fluent chain after Text. | ItTiger.TigerCli/Tui/Activity/ActivityBuilders.cs |
| ActivityTextElement | class |
A single-line text element. | ItTiger.TigerCli/Tui/Activity/ActivityElement.cs |
ItTiger.TigerCli.Tui.Controls
| Public type | Kind | Summary | Source |
|---|---|---|---|
| FileSystemFolderBrowser | class |
Default IFolderBrowser backed by IO. | ItTiger.TigerCli/Tui/Controls/FileSystemFolderBrowser.cs |
| InlineActivityControl<T> | class |
Rich activity dialog control: a live CliGrid-backed layout (columns, rows, text and progress-bar elements) driven by named dynamic row values, plus a background operation and a single stop button (Cancel or Abort — never both). | ItTiger.TigerCli/Tui/Controls/InlineActivityControl.cs |
| InlineDialog | class |
Modal inline dialog that hosts one InlineControlBase and renders it through the shared CliGrid layout pipeline. | ItTiger.TigerCli/Tui/Controls/InlineDialog.cs |
| InlineDialogConfirmationPolicy | class |
Optional, reusable confirmation policy for an InlineDialog. | ItTiger.TigerCli/Tui/Controls/InlineDialogConfirmationPolicy.cs |
| InlineFolderSelect | class |
'Composite folder picker: editable path input, folder list, and OK/Cancel buttons.' | ItTiger.TigerCli/Tui/Controls/InlineFolderSelect.cs |
| InlineMessageBoxControl | class |
A message-box style inline control: a block of message text plus a row of buttons. | ItTiger.TigerCli/Tui/Controls/InlineMessageBoxControl.cs |
| InlineMultiColumnSelect | class |
Dialog-hostable single-selection control over structured, multi-column rows. | ItTiger.TigerCli/Tui/Controls/InlineMultiColumnSelect.cs |
| InlineMultiControl | class |
Base class for dialog-hostable inline controls composed from several top-level widgets. | ItTiger.TigerCli/Tui/Controls/InlineMultiControl.cs |
| InlineMultiControl.InlineMultiControlWidget | class |
Metadata for one widget slot owned by an InlineMultiControl. | ItTiger.TigerCli/Tui/Controls/InlineMultiControl.cs |
| InlineMultiSelect | class |
Dialog-hostable multi-selection checklist control. | ItTiger.TigerCli/Tui/Controls/InlineMultiSelect.cs |
| InlineSelect | class |
Dialog-hostable single-selection list control backed by InlineSelectWidget. | ItTiger.TigerCli/Tui/Controls/InlineSelect.cs |
| InlineTextInput | class |
Dialog-hostable single-line text input control backed by InlineTextInputWidget. | ItTiger.TigerCli/Tui/Controls/InlineTextInput.cs |
| SpinnerTicker | class |
A TuiTicker that cycles through a fixed sequence of string frames, wrapping back to the first frame after the last. | ItTiger.TigerCli/Tui/Controls/SpinnerTicker.cs |
ItTiger.TigerCli.Tui.Selection
| Public type | Kind | Summary | Source |
|---|---|---|---|
| SelectCell | class |
Immutable content of one cell in a SelectRow: its Text plus optional per-cell overrides for semantic Style, Alignment, and FormattingMode. | ItTiger.TigerCli/Tui/Selection/SelectCell.cs |
| SelectColumn | class |
Immutable column definition for a multi-column select (see InlineMultiColumnSelect and TigerTui.MultiColumnSelectIndexAsync). | ItTiger.TigerCli/Tui/Selection/SelectColumn.cs |
| SelectRow | class |
Immutable row for a multi-column select: an ordered set of Cells (one per column, though a row may supply fewer — missing trailing cells render blank) and an optional IsDisabled flag. | ItTiger.TigerCli/Tui/Selection/SelectRow.cs |
ItTiger.TigerCli.Tui.Testing
| Public type | Kind | Summary | Source |
|---|---|---|---|
| TestShell | class |
Test shell that runs the real semi-interactive modal loop against a TestTerminal. | ItTiger.TigerCli/Tui/Testing/TestShell.cs |
| TestTerminal | class |
In-memory terminal implementation intended for tests of semi-interactive TUI flows. | ItTiger.TigerCli/Tui/Testing/TestTerminal.cs |
ItTiger.TigerCli.Tui.Themes
| Public type | Kind | Summary | Source |
|---|---|---|---|
| CliCustomStyle | class |
An app-defined custom semantic style: a named markup token (e.g. ConnectionName, EnvironmentProd) that resolves through the active theme like the framework semantic tokens. | ItTiger.TigerCli/Tui/Themes/CliCustomStyle.cs |
| DarkTheme | class |
Default dark framework theme: neutral dark background, gray text, cyan accent, and green active selection. | ItTiger.TigerCli/Tui/Themes/DarkTheme.cs |
| LightTheme | class |
Light framework theme: dark text on a light background, dark-blue accent and table headers. | ItTiger.TigerCli/Tui/Themes/LightTheme.cs |
| ThemeBase | class |
Base class for TigerCli themes. | ItTiger.TigerCli/Tui/Themes/ThemeBase.cs |
| TigerBlueTheme | class |
Blue-accented framework theme: cyan accent, dark-blue dialog background, white table headers. | ItTiger.TigerCli/Tui/Themes/TigerBlueTheme.cs |
| TigerColorAliasRegistry | class |
App-scoped registry of raw colour aliases: application-defined names for concrete CliColor values (e.g. BrandOrange → Orange). | ItTiger.TigerCli/Tui/Themes/TigerColorAliasRegistry.cs |
| TigerCustomStyleRegistry | class |
App-scoped registry of custom semantic styles (see CliCustomStyle). | ItTiger.TigerCli/Tui/Themes/TigerCustomStyleRegistry.cs |
| TigerThemeConfiguration | class |
App-scoped theme, style, and colour-alias policy configured through the app builder's ConfigureThemes block. | ItTiger.TigerCli/Tui/Themes/TigerThemeConfiguration.cs |
ItTiger.TigerCli.Tui.Widgets
| Public type | Kind | Summary | Source |
|---|---|---|---|
| InlineButtonGroupWidget | class |
A reusable horizontal row of buttons — the main reusable unit for message-box style button rows ([OK], [Yes] [No], [OK] [Cancel], [Abort] [Retry] [Ignore]). | ItTiger.TigerCli/Tui/Widgets/InlineButtonGroupWidget.cs |
| InlineButtonWidget | class |
A reusable button widget. | ItTiger.TigerCli/Tui/Widgets/InlineButtonWidget.cs |
| InlineMultiColumnSelectWidget | class |
A reusable single-selection list widget whose rows are structured multi-column data rather than one preformatted string. | ItTiger.TigerCli/Tui/Widgets/InlineMultiColumnSelectWidget.cs |
| InlineSelectWidget | class |
A reusable single-selection list widget. | ItTiger.TigerCli/Tui/Widgets/InlineSelectWidget.cs |
| InlineTextInputWidget | class |
A reusable editable single-line text input widget. | ItTiger.TigerCli/Tui/Widgets/InlineTextInputWidget.cs |
| InlineTextWidget | class |
A reusable read-only text widget. | ItTiger.TigerCli/Tui/Widgets/InlineTextWidget.cs |