mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-04-19 10:12:50 +08:00
223642b797
* Adding social card infrastructure * Upgrades doc project to .NET 6 * Adds Playwright * Changes the console to a web project for Playwright * Adds social card template * Added blog content * Parallelized social image processing * Updating CI to use .NET 6 for docs build
78 lines
1.8 KiB
Markdown
78 lines
1.8 KiB
Markdown
Title: Rule
|
|
Order: 30
|
|
RedirectFrom: rule
|
|
Description: "The **Rule** class is used to render a horizontal rule (line) to the terminal."
|
|
Highlights:
|
|
- Custom colors for line and title.
|
|
- Specify left, center or right aligned title.
|
|
|
|
---
|
|
|
|
The `Rule` class is used to render a horizontal rule (line) to the terminal.
|
|
|
|
<?# AsciiCast cast="rule" /?>
|
|
|
|
## Usage
|
|
|
|
To render a rule without a title:
|
|
|
|
```csharp
|
|
var rule = new Rule();
|
|
AnsiConsole.Render(rule);
|
|
```
|
|
|
|
## Title
|
|
|
|
You can set the rule title markup text.
|
|
|
|
```csharp
|
|
var rule = new Rule("[red]Hello[/]");
|
|
AnsiConsole.Render(rule);
|
|
```
|
|
|
|
```text
|
|
───────────────────────────────── Hello ─────────────────────────────────
|
|
```
|
|
|
|
## Title alignment
|
|
|
|
You can set the rule's title alignment.
|
|
|
|
```csharp
|
|
var rule = new Rule("[red]Hello[/]");
|
|
rule.Alignment = Justify.Left;
|
|
AnsiConsole.Render(rule);
|
|
```
|
|
|
|
```text
|
|
── Hello ────────────────────────────────────────────────────────────────
|
|
```
|
|
|
|
You can also specify it via an extension method:
|
|
|
|
```csharp
|
|
var rule = new Rule("[red]Hello[/]");
|
|
rule.LeftAligned();
|
|
AnsiConsole.Render(rule);
|
|
```
|
|
|
|
```text
|
|
── Hello ────────────────────────────────────────────────────────────────
|
|
```
|
|
|
|
|
|
## Styling
|
|
|
|
```csharp
|
|
var rule = new Rule("[red]Hello[/]");
|
|
rule.Style = Style.Parse("red dim");
|
|
AnsiConsole.Render(rule);
|
|
```
|
|
You can also specify it via an extension method
|
|
|
|
```csharp
|
|
var rule = new Rule("[red]Hello[/]");
|
|
rule.RuleStyle("red dim");
|
|
AnsiConsole.Render(rule);
|
|
```
|