Spectre.Console Namespace
Class
- Align
- Represents a renderable used to align content.
- AlignableExtensions
-
Contains extension methods for
IAlignable
. - AnsiConsole
- A console capable of writing ANSI escape sequences.
- Ansi
Console Extensions -
Contains extension methods for
IAnsiConsole
. - AnsiConsoleFactory
- Factory for creating an ANSI console.
- AnsiConsoleOutput
- Represents console output.
- AnsiConsoleSettings
-
Settings used when building a
IAnsiConsole
. - BarChart
- A renderable (horizontal) bar chart.
- BarChartExtensions
-
Contains extension methods for
BarChart
. - BarChartItem
- An item that's shown in a bar chart.
- BoxBorder
- Represents a border.
- BreakdownChart
- A renderable breakdown chart.
- Breakdown
Chart Extensions -
Contains extension methods for
BreakdownChart
. - BreakdownChartItem
- An item that's shown in a breakdown chart.
- Calendar
- A renderable calendar.
- CalendarEvent
- Represents a calendar event.
- CalendarExtensions
-
Contains extension methods for
Calendar
. - Canvas
- Represents a renderable canvas.
- CanvasImage
- Represents a renderable image.
- Canvas
Image Extensions -
Contains extension methods for
CanvasImage
. - Capabilities
- Represents console capabilities.
- CharExtensions
-
Contains extension methods for
System.Char
. - Circular
Tree Exception - Indicates that the tree being rendered includes a cycle, and cannot be rendered.
- ColumnExtensions
-
Contains extension methods for
IColumn
. - Columns
- Renders things in columns.
- ConfirmationPrompt
- A prompt that is answered with a yes or no.
- Confirmation
Prompt Extensions -
Contains extension methods for
ConfirmationPrompt
. - ControlCode
- A control code.
- CursorExtensions
-
Contains extension methods for
IAnsiConsoleCursor
. - 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
System.Exception
. - ExceptionSettings
- Exception settings.
- ExceptionStyle
- Represent an exception style.
- ExpandableExtensions
-
Contains extension methods for
IExpandable
. - FigletFont
- Represents a FIGlet font.
- FigletText
- Represents text rendered with a FIGlet font.
- FigletTextExtensions
-
Contains extension methods for
FigletText
. - Grid
- A renderable grid.
- GridColumn
- Represents a grid column.
- GridExtensions
-
Contains extension methods for
Grid
. - GridRow
- Represents a grid row.
- HasBorderExtensions
-
Contains extension methods for
IHasBorder
. - Has
Box Border Extensions -
Contains extension methods for
IHasBoxBorder
. - HasCultureExtensions
-
Contains extension methods for
IHasCulture
. - Has
Justification Extensions -
Contains extension methods for
IHasJustification
. - Has
Table Border Extensions -
Contains extension methods for
IHasTableBorder
. - Has
Tree Node Extensions -
Contains extension methods for
IHasTreeNodes
. - Layout
- Represents a renderable to divide a fixed height into rows or columns.
- LayoutExtensions
-
Contains extension methods for
Layout
. - LiveDisplay
- Represents a live display.
- LiveDisplayContext
-
Represents a context that can be used to interact with a
LiveDisplay
. - Live
Display Extensions -
Contains extension methods for
LiveDisplay
. - Markup
- A renderable piece of markup text.
- MultiSelectionPrompt
<T> - Represents a multi selection list prompt.
- Multi
Selection Prompt Extensions -
Contains extension methods for
MultiSelectionPrompt<T>
. - Overflowable
Extensions -
Contains extension methods for
IOverflowable
. - PaddableExtensions
-
Contains extension methods for
IPaddable
. - Padder
-
Represents padding around a
IRenderable
object. - PaddingExtensions
-
Contains extension methods for
Padding
. - Panel
- A renderable panel.
- PanelExtensions
-
Contains extension methods for
Panel
. - 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.
- Percentage
Column Extensions -
Contains extension methods for
PercentageColumn
. - 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.
- Progress
Bar Column Extensions -
Contains extension methods for
ProgressBarColumn
. - ProgressColumn
- Represents a progress column.
- ProgressContext
-
Represents a context that can be used to interact with a
Progress
. - ProgressExtensions
-
Contains extension methods for
Progress
. - ProgressTask
- Represents a progress task.
- Progress
Task Extensions -
Contains extension methods for
ProgressTask
. - 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
Recorder
. - RemainingTimeColumn
- A column showing the remaining time of a task.
- Remaining
Time Column Extensions -
Contains extension methods for
RemainingTimeColumn
. - RenderableExtensions
-
Contains extension methods for
IRenderable
. - Rows
- Renders things in rows.
- Rule
- A renderable horizontal rule.
- RuleExtensions
-
Contains extension methods for
RuleExtensions
. - SelectionPrompt
<T> - Represents a single list prompt.
- Selection
Prompt Extensions -
Contains extension methods for
SelectionPrompt<T>
. - Spinner
-
Represents a spinner used in a
SpinnerColumn
. - SpinnerColumn
- A column showing a spinner.
- Spinner
Column Extensions -
Contains extension methods for
SpinnerColumn
. - Status
- Represents a status display.
- StatusContext
-
Represents a context that can be used to interact with a
Status
. - Status
Context Extensions -
Contains extension methods for
StatusContext
. - StatusExtensions
-
Contains extension methods for
Status
. - StringExtensions
-
Contains extension methods for
string
. - Style
- Represents color and text decoration.
- StyleExtensions
-
Contains extension methods for
Style
. - Table
- A renderable table.
- TableBorder
- Represents a border.
- TableColumn
- Represents a table column.
- Table
Column Extensions -
Contains extension methods for
TableColumn
. - TableExtensions
-
Contains extension methods for
Table
. - TableRow
- Represents a table row.
- TableRowCollection
- Represents a collection holding table rows.
- TableTitle
- Represents a table title such as a heading or footnote.
- Task
Description Column - A column showing the task description.
- Text
- A renderable piece of text.
- TextPath
- Representation of a file system path.
- TextPathExtensions
-
Contains extension methods for
TextPath
. - TextPrompt
<T> - Represents a prompt.
- TextPromptExtensions
-
Contains extension methods for
TextPrompt<T>
. - TransferSpeedColumn
- A column showing transfer speed.
- Tree
- Representation of non-circular tree data. Each node added to the tree may only be present in it a single time, in order to facilitate cycle detection.
- TreeExtensions
-
Contains extension methods for
Tree
. - TreeGuide
- Represents tree guide lines.
- TreeNode
- Represents a tree node.
- TreeNodeExtensions
-
Contains extension methods for
TreeNode
. - ValidationResult
- Represents a prompt validation result.
- VisibilityExtensions
-
Contains extension methods for
IHasVisibility
.
Enum
- AnsiSupport
- Determines ANSI escape sequence support.
- ColorSystem
- Represents a color system.
- ColorSystemSupport
- Determines what color system should be used.
- CursorDirection
- Represents cursor direction.
- Decoration
- Represents text decoration.
- ExceptionFormats
- Represents how an exception is formatted.
- FileSizeBase
- Determines possible file size base prefixes. (base 2/base 10).
- HorizontalAlignment
- Represents horizontal alignment.
- InteractionSupport
- Determines interactivity support.
- Justify
- Represents text justification.
- Overflow
- Represents text overflow.
- SelectionMode
- Represents how selections are made in a hierarchical prompt.
- VerticalAlignment
- Represents vertical alignment.
- VerticalOverflow
- Represents vertical overflow.
- Vertical
Overflow Cropping - Represent vertical overflow cropping.
Interface
- 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
<T> - Represent a multi selection prompt item.
- IOverflowable
- Represents something that can overflow.
- IPaddable
- Represents something that is paddable.
- IProfileEnricher
- Represents something that can enrich a profile.
- I
Read Only Capabilities - Represents (read-only) console capabilities.
- ISelectionItem
<T> - Represent a selection item.