Spectre.Console API Reference

Auto-generated reference for every public, documented type in Spectre.Console.

Spectre.Console

• Align - Represents a renderable used to align content.
• AlignableExtensions - Contains extension methods for .
• AlignExtensions - Contains extension methods for .
• AnsiConsole - A console capable of writing ANSI escape sequences.
• AnsiConsoleExtensions - Contains extension methods for .
• AnsiConsoleOutput - Represents console output.
• AnsiConsoleSettings - Settings used when building a .
• BarChart - A renderable (horizontal) bar chart.
• BarChartExtensions - Contains extension methods for .
• BarChartItem - An item that's shown in a bar chart.
• BoxBorder - Represents a border.
• BoxExtensions - Contains extension methods for .
• BreakdownChart - A renderable breakdown chart.
• BreakdownChartExtensions - Contains extension methods for .
• BreakdownChartItem - An item that's shown in a breakdown chart.
• Calendar - A renderable calendar.
• CalendarEvent - Represents a calendar event.
• CalendarExtensions - Contains extension methods for .
• Canvas - Represents a renderable canvas.
• CanvasImage - Represents a renderable image.
• CanvasImageExtensions - Contains extension methods for .
• CharExtensions - Contains extension methods for .
• CircularTreeException - Indicates that the tree being rendered includes a cycle, and cannot be rendered.
• ColumnExtensions - Contains extension methods for .
• Columns - Renders things in columns.
• ConfirmationPrompt - A prompt that is answered with a yes or no.
• ConfirmationPromptExtensions - Contains extension methods for .
• ControlCode - A control code.
• CursorDirection - Represents cursor direction.
• CursorExtensions - Contains extension methods for .
• DownloadedColumn - A column showing download progress.
• ElapsedTimeColumn - A column showing the elapsed time of a task.
• Emoji - Utility for working with emojis.
• ExceptionExtensions - Contains extension methods for .
• ExceptionFormats - Represents how an exception is formatted.
• ExceptionInfoResolver - Used to resolve information from an .
• ExceptionSettings - Exception settings.
• ExceptionStyle - Represent an exception style.
• ExpandableExtensions - Contains extension methods for .
• FigletFont - Represents a Figlet font.
• FigletLayoutMode - Represents the different Figlet layout modes.
• FigletText - Represents text rendered with a Figlet font.
• FigletTextExtensions - Contains extension methods for .
• FileSizeBase - Determines possible file size base prefixes.
• Grid - A renderable grid.
• GridColumn - Represents a grid column.
• GridExtensions - Contains extension methods for .
• GridRow - Represents a grid row.
• HasBorderExtensions - Contains extension methods for .
• HasBoxBorderExtensions - Contains extension methods for .
• HasCultureExtensions - Contains extension methods for .
• HasJustificationExtensions - Contains extension methods for .
• HasTableBorderExtensions - Contains extension methods for .
• HasTreeNodeExtensions - Contains extension methods for .
• HorizontalAlignment - Represents horizontal alignment.
• IAlignable - Represents something that is alignable.
• IAnsiConsole - Represents a console.
• IAnsiConsoleCursor - Represents the console's cursor.
• IAnsiConsoleInput - Represents the console's input mechanism.
• IAnsiConsoleOutput - Represents console output.
• IBarChartItem - Represents a bar chart item.
• IBreakdownChartItem - Represents a breakdown chart item.
• IColumn - Represents a column.
• IExclusivityMode - Represents an exclusivity mode.
• IExpandable - Represents something that is expandable.
• IHasBorder - Represents something that has a border.
• IHasBoxBorder - Represents something that has a box border.
• IHasCulture - Represents something that has a culture.
• IHasJustification - Represents something that has justification.
• IHasTableBorder - Represents something that has a border.
• IHasTreeNodes - Represents something that has tree nodes.
• IHasVisibility - Represents something that can be hidden.
• IMultiSelectionItem<> - Represent a multi selection prompt item.
• InteractionSupport - Determines interactivity support.
• IOverflowable - Represents something that can overflow.
• IPaddable - Represents something that is paddable.
• IProfileEnricher - Represents something that can enrich a profile.
• IPrompt<> - Represents a prompt.
• IReadOnlyCapabilities - Represents (read-only) terminal capabilities.
• ISelectionItem<> - Represent a selection item.
• Justify - Represents text justification.
• Known - Contains well-known emojis.
• Known - Contains well-known spinners.
• Layout - Represents a renderable to divide a fixed height into rows or columns.
• LayoutExtensions - Contains extension methods for .
• LiveDisplay - Represents a live display.
• LiveDisplayContext - Represents a context that can be used to interact with a .
• LiveDisplayExtensions - Contains extension methods for .
• Markup - A renderable piece of markup text.
• MultiSelectionPrompt<> - Represents a multi selection list prompt.
• MultiSelectionPromptExtensions - Contains extension methods for .
• Overflow - Represents text overflow.
• OverflowableExtensions - Contains extension methods for .
• PaddableExtensions - Contains extension methods for .
• Padder - Represents padding around a object.
• Padding - Represents padding.
• PaddingExtensions - Contains extension methods for .
• Panel - A renderable panel.
• PanelExtensions - Contains extension methods for .
• PanelHeader - Represents a panel header.
• Paragraph - A paragraph of text where different parts of the paragraph can have individual styling.
• PercentageColumn - A column showing task progress in percentage.
• PercentageColumnExtensions - Contains extension methods for .
• Profile - Represents a console profile.
• ProfileEnrichment - Contains settings for profile enrichment.
• Progress - Represents a task list.
• ProgressBarColumn - A column showing task progress as a progress bar.
• ProgressBarColumnExtensions - Contains extension methods for .
• ProgressColumn - Represents a progress column.
• ProgressContext - Represents a context that can be used to interact with a .
• ProgressExtensions - Contains extension methods for .
• ProgressTask - Represents a progress task.
• ProgressTaskExtensions - Contains extension methods for .
• ProgressTaskSettings - Represents settings for a progress task.
• ProgressTaskState - Represents progress task state.
• Recorder - A console recorder used to record output from a console.
• RecorderExtensions - Contains extension methods for .
• Region - Represents a region.
• RemainingTimeColumn - A column showing the remaining time of a task.
• RemainingTimeColumnExtensions - Contains extension methods for .
• Rows - Renders things in rows.
• Rule - A renderable horizontal rule.
• RuleExtensions - Contains extension methods for .
• SelectionMode - Represents how selections are made in a hierarchical prompt.
• SelectionPrompt<> - Represents a single list prompt.
• SelectionPromptExtensions - Contains extension methods for .
• Size - Represents a size.
• Spinner - Represents a spinner used in a .
• SpinnerColumn - A column showing a spinner.
• SpinnerColumnExtensions - Contains extension methods for .
• SpinnerExtensions - Provides extension methods for running tasks with a spinner animation.
• Status - Represents a status display.
• StatusContext - Represents a context that can be used to interact with a .
• StatusContextExtensions - Contains extension methods for .
• StatusExtensions - Contains extension methods for .
• StringExtensions - Contains extension methods for .
• Table - A renderable table.
• TableBorder - Represents a border.
• TableBorderExtensions - Contains extension methods for .
• TableCell - Represents a table cell that can span multiple columns.
• TableColumn - Represents a table column.
• TableColumnExtensions - Contains extension methods for .
• TableExtensions - Contains extension methods for .
• TableRow - Represents a table row.
• TableRowCollection - Represents a collection holding table rows.
• TableTitle - Represents a table title such as a heading or footnote.
• TaskDescriptionColumn - A column showing the task description.
• Text - A renderable piece of text.
• TextPath - Representation of a file system path.
• TextPathExtensions - Contains extension methods for .
• TextPrompt<> - Represents a prompt.
• TextPromptExtensions - Contains extension methods for .
• TransferSpeedColumn - A column showing transfer speed.
• Tree - Representation of non-circular tree data.
• TreeExtensions - Contains extension methods for .
• TreeGuide - Represents tree guide lines.
• TreeGuideExtensions - Contains extension methods for .
• TreeNode - Represents a tree node.
• TreeNodeExtensions - Contains extension methods for .
• ValidationResult - Represents a validation result.
• VerticalAlignment - Represents vertical alignment.
• VerticalOverflow - Represents vertical overflow.
• VerticalOverflowCropping - Represent vertical overflow cropping.
• VisibilityExtensions - Contains extension methods for .

Spectre.Console.Json

• IJsonParser - Represents a JSON parser.
• JsonText - A renderable piece of JSON text.
• JsonTextExtensions - Contains extension methods for .

Spectre.Console.Json.Syntax

• JsonArray - Represents an array in the JSON abstract syntax tree.
• JsonBoolean - Represents a boolean literal in the JSON abstract syntax tree.
• JsonMember - Represents a member in the JSON abstract syntax tree.
• JsonNull - Represents a null literal in the JSON abstract syntax tree.
• JsonObject - Represents an object in the JSON abstract syntax tree.
• JsonString - Represents a string literal in the JSON abstract syntax tree.
• JsonSyntax - Represents a syntax node in the JSON abstract syntax tree.

Spectre.Console.Rendering

• Ascii2TableBorder - Represents another old school ASCII border.
• AsciiBoxBorder - Represents an old school ASCII border.
• AsciiDoubleHeadTableBorder - Represents an old school ASCII border with a double header border.
• AsciiTableBorder - Represents an old school ASCII border.
• AsciiTreeGuide - An ASCII tree guide.
• BeveledBoxBorder - Represents a beveled border using thin block edges and diagonal corners.
• BoldLineTreeGuide - A tree guide made up of bold lines.
• BoxBorderPart - Represents the different parts of a box border.
• DashedBoxBorder - Represents a dashed border with square corners.
• DashedWideBoxBorder - Represents a wide-dashed border with square corners.
• DottedBoxBorder - Represents a dotted border with square corners.
• DoubleBoxBorder - Represents a double border.
• DoubleEdgeTableBorder - Represents a border with a double edge.
• DoubleHorizontalBoxBorder - Represents a border with double horizontal edges and single vertical edges.
• DoubleLineTreeGuide - A tree guide made up of double lines.
• DoubleTableBorder - Represents a double border.
• DoubleVerticalBoxBorder - Represents a border with double vertical edges and single horizontal edges.
• HeavyBoxBorder - Represents a heavy border.
• HeavyDashedBoxBorder - Represents a heavy dashed border.
• HeavyDashedWideBoxBorder - Represents a heavy wide-dashed border.
• HeavyDottedBoxBorder - Represents a heavy dotted border.
• HeavyEdgeTableBorder - Represents a border with a heavy edge.
• HeavyHeadTableBorder - Represents a border with a heavy header.
• HeavyHorizontalBoxBorder - Represents a border with heavy horizontal edges and light vertical edges.
• HeavyTableBorder - Represents a heavy border.
• HeavyVerticalBoxBorder - Represents a border with heavy vertical edges and light horizontal edges.
• HorizontalTableBorder - Represents a horizontal border.
• IAnsiConsoleEncoder - Represents a console encoder that can encode recorded segments into a string.
• IHasDirtyState - Represents something that can be dirty.
• IRenderable - Represents something that can be rendered to the console.
• IRenderHook - Represents a render hook.
• JustInTimeRenderable - Represents something renderable that's reconstructed when its state change in any way.
• LineTreeGuide - A tree guide made up of lines.
• MarkdownTableBorder - Represents a Markdown border.
• McGuganHorizontalBoxBorder - Represents the horizontal variant of the McGugan border, which draws thin block edges inside the content's bounds.
• McGuganVerticalBoxBorder - Represents the vertical variant of the McGugan border, which draws thin block edges inside the content's bounds.
• Measurement - Represents a measurement.
• MinimalDoubleHeadTableBorder - Represents a minimal border with a double header border.
• MinimalHeavyHeadTableBorder - Represents a minimal border with a heavy header.
• MinimalistTableBorder - Represents a minimalist border.
• MinimalTableBorder - Represents a minimal border.
• NearBoxBorder - Represents a "near" border that hugs the content using thin block elements, drawn on the inside edges with empty corners.
• NoBoxBorder - Represents an invisible border.
• NoTableBorder - Represents an invisible border.
• Renderable - Base class for a renderable object implementing .
• RenderableExtensions - Contains extension methods for .
• RenderHookScope - Represents a render hook scope.
• RenderOptions - Represents render options.
• RenderPipeline - Represents the render pipeline.
• RoundedBoxBorder - Represents a rounded border.
• RoundedDashedBoxBorder - Represents a dashed border with rounded corners.
• RoundedDashedWideBoxBorder - Represents a wide-dashed border with rounded corners.
• RoundedDottedBoxBorder - Represents a dotted border with rounded corners.
• RoundedTableBorder - Represents a rounded border.
• Segment - Represents a renderable segment.
• SegmentLine - Represents a collection of segments.
• SegmentLineEnumerator - An enumerator for collections.
• SegmentLineIterator - An iterator for collections.
• SimpleHeavyTableBorder - Represents a simple border with heavy lines.
• SimpleTableBorder - Represents a simple border.
• SquareBoxBorder - Represents a square border.
• SquareTableBorder - Represents a square border.
• TableBorderPart - Represents the different parts of a table border.
• TablePart - Represents different parts of a table.
• TreeGuidePart - Defines the different rendering parts of a .