Add text overflow support

Closes #61
Add border for color representations
2025-10-25 15:19:23 +00:00 · 2020-09-03 14:57:57 +02:00 · 2020-09-02 09:55:44 +02:00 · 2020-09-02 09:02:59 +02:00 · 2020-09-01 22:05:46 +02:00 · 2020-09-01 22:00:44 +02:00
33 changed files with 565 additions and 110 deletions
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -6,6 +6,35 @@ env:
  DOTNET_CLI_TELEMETRY_OPTOUT: true

 jobs:
+
+  ###################################################
+  # DOCS
+  ###################################################
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Setup dotnet
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '3.1.301' # SDK Version to use.
+
+    - name: Build
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        cd docs
+        dotnet run --configuration Release
+
+  ###################################################
+  # BUILD
+  ###################################################
+
  build:
    name: Build
    if: "!contains(github.event.head_commit.message, 'skip-ci')"
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -4,14 +4,22 @@ on:
    push:
        paths:
        - 'docs/**'
+        - 'src/**'

 jobs:
+
+  ###################################################
+  # DOCS
+  ###################################################
+
  build:
    name: Deploy
    runs-on: windows-latest
    steps:
    - name: Checkout
-      uses: actions/checkout@master
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0

    - name: Setup dotnet
      uses: actions/setup-dotnet@v1
@@ -24,4 +32,4 @@ jobs:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        cd docs
-        dotnet run -- deploy
+        dotnet run --configuration Release -- deploy
--- a/.github/workflows/publish.yaml
+++ b/.github/workflows/publish.yaml
@@ -6,6 +6,8 @@ on:
      - '*'
    branches:
      - main
+    paths:
+      - 'src/**'

 env:
  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
@@ -13,12 +15,37 @@ env:

 jobs:

+  ###################################################
+  # DOCS
+  ###################################################
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Setup dotnet
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '3.1.301' # SDK Version to use.
+
+    - name: Build
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        cd docs
+        dotnet run --configuration Release
+
  ###################################################
  # BUILD
  ###################################################

  build:
    name: Build
+    needs: [docs]
    if: "!contains(github.event.head_commit.message, 'skip-ci') || startsWith(github.ref, 'refs/tags/')"
    strategy:
      matrix:
--- a/docs/Docs.csproj
+++ b/docs/Docs.csproj
@@ -1,10 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <RunWorkingDirectory>$(MSBuildProjectDirectory)</RunWorkingDirectory>
    <DefaultItemExcludes>$(DefaultItemExcludes);output\**;.gitignore</DefaultItemExcludes>
+    <MinVerSkip Condition="'$(Configuration)' == 'Debug'">true</MinVerSkip>
  </PropertyGroup>

  <ItemGroup>
@@ -22,8 +23,15 @@
  </ItemGroup>

  <ItemGroup>
-    <PackageReference Include="Statiq.Web" Version="1.0.0-alpha.9" />
-    <PackageReference Include="NJsonSchema" Version="10.1.12" />
+    <PackageReference Include="Statiq.Web" Version="1.0.0-beta.5" />
+    <PackageReference Include="MinVer" PrivateAssets="All" Version="2.3.0" />
  </ItemGroup>

+  <Target Name="Versioning" BeforeTargets="MinVer">
+    <PropertyGroup Label="Build">
+      <MinVerDefaultPreReleasePhase>preview</MinVerDefaultPreReleasePhase>
+      <MinVerVerbosity>normal</MinVerVerbosity>
+    </PropertyGroup>
+  </Target>
+
 </Project>
--- a/docs/Preview.ps1
+++ b/docs/Preview.ps1
@@ -0,0 +1 @@
+dotnet run -- preview --virtual-dir "spectre.console"
--- a/docs/input/_layout.cshtml
+++ b/docs/input/_layout.cshtml
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!DOCTYPE html>
 <html>
    <head>
        <meta charset="utf-8">
@@ -29,7 +29,7 @@

            <nav id="topnav" class="navbar navbar-expand-lg navbar-light">
                <div class="container py-3">
-                    <a class="navbar-brand" href="/spectre.console/docs"><img id="logo" src="/spectre.console/assets/logo.svg" alt="Spectre.Console"> Spectre.Console</a>
+                    <a class="navbar-brand" href="/spectre.console"><img id="logo" src="/spectre.console/assets/logo.svg" alt="Spectre.Console"> Spectre.Console</a>
                    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
                        <span class="navbar-toggler-icon"></span>
                    </button>
@@ -52,8 +52,8 @@
            {
                @RenderSection(Constants.Sections.Splash, false)
            }
-            @{ 
-                string section = Document.Destination.Segments.Length > 1 ? Document.Destination.Segments[0].ToString() : null;
+            @{
+                string section = "docs";
            }

            <div class="flex-grow-1 d-flex  bg-body flex-column @(section != null ? "section-" + section : null)">
@@ -62,7 +62,7 @@
                    <div id="titlebar" class="py-4">
                        <div class="container">
                            <div class="row">
-                                @{ 
+                                @{
                                    string titleBarClasses = Document.GetBool(Constants.NoSidebar) ? string.Empty : "offset-md-3 offset-lg-2";
                                }
                                <div class="@titleBarClasses px-3 px-md-0">
@@ -97,7 +97,7 @@
                        </div>
                    </div>
                }
-                
+
                <div class="flex-grow-1 d-flex flex-column bg-body">
                    @if (Document.GetBool(Constants.NoContainer))
                    {
@@ -126,21 +126,22 @@
                                        }
                                        else
                                        {
-                                            IDocument root = Outputs[nameof(Content)].First(x => x.Destination == section + "/index.html");
+                                            IDocument root = OutputPages["index.html"].First();
                                            <div class="sidebar-nav-item @(Document.IdEquals(root) ? "active" : null)">
                                                @Html.DocumentLink(root)
                                            </div>

-                                            @foreach (IDocument document in root.GetChildren().OnlyVisible())
+                                            @foreach (IDocument document in OutputPages.GetChildrenOf(root).OnlyVisible())
                                            {
-                                                <div class="sidebar-nav-item @(Document.IdEquals(document) ? "active" : null) @(document.HasChildren() ? "has-children" : null)">
+                                                DocumentList<IDocument> documentChildren = OutputPages.GetChildrenOf(document);
+                                                <div class="sidebar-nav-item @(Document.IdEquals(document) ? "active" : null) @(documentChildren.Any() ? "has-children" : null)">
                                                    @Html.DocumentLink(document)
                                                </div>

-                                                @if (document.HasVisibleChildren())
+                                                @if (documentChildren.OnlyVisible().Any())
                                                {
-                                                    <div class="sidebar-nav-children @(Document.IdEquals(document) || document.GetChildren().Any(x => Document.IdEquals(x)) ? "active" : null)">
-                                                        @foreach (IDocument child in document.GetChildren().OnlyVisible())
+                                                    <div class="sidebar-nav-children @(Document.IdEquals(document) || documentChildren.Any(x => Document.IdEquals(x)) ? "active" : null)">
+                                                        @foreach (IDocument child in documentChildren.OnlyVisible())
                                                        {
                                                            <div class="sidebar-nav-child @(Document.IdEquals(child) ? "active" : null)">
                                                                @Html.DocumentLink(child)
@@ -182,7 +183,10 @@
        </div>
        <div id="footer" class="p-3 text-white font-size-sm">
            <div class="container">
-                <div>© @DateTime.Today.Year Spectre Systems AB</div>
+                <div>
+                    <span>© @DateTime.Today.Year Spectre Systems AB</span>
+                    <span class="float-right" style="color: #888888;">@VersionUtilities.GetVersion()</span>
+                </div>
            </div>
        </div>
        <script>
@@ -195,7 +199,7 @@
                    },
 					startOnLoad: false,
 					cloneCssStyles: false
-                });     
+                });
                mermaid.init(undefined, ".mermaid");

                // Remove the max-width setting that Mermaid sets
@@ -214,13 +218,13 @@
 						center: true,
                        maxZoom: 20,
                        zoomScaleSensitivity: 0.6
-					});			                          
+					});

                    // Do the reset once right away to fit the diagram
                    panZoom.resize();
                    panZoom.fit();
                    panZoom.center();
-                    
+
                    $(window).resize(function(){
                        panZoom.resize();
                        panZoom.fit();
--- a/docs/input/_viewimports.cshtml
+++ b/docs/input/_viewimports.cshtml
@@ -3,5 +3,6 @@
@using Statiq.Web
@using Statiq.Web.Pipelines
@using Docs
+@using Docs.Utilities;

@inherits StatiqRazorPage<IDocument>
--- a/docs/input/assets/css/styles.scss
+++ b/docs/input/assets/css/styles.scss
@@ -18,6 +18,7 @@ $thebackground: $gray-200;
    display: inline-block;
    width: 60px;
    height: 15px;
+    border: 2px solid #000000;
 }

 #topnav {
--- a/docs/input/assets/images/helloworld.png
+++ b/docs/input/assets/images/helloworld.png
--- a/docs/input/docs/colors.md
+++ b/docs/input/docs/colors.md
@@ -1,5 +1,5 @@
 Title: Colors
-Order: 2
+Order: 4
 ---

 The following is a list of the standard 8-bit colors supported in terminals.
--- a/docs/input/docs/console.md
+++ b/docs/input/docs/console.md
@@ -1,6 +0,0 @@
-Title: Console API
-Order: 2
-Hidden: True
---
-
-__To be written__
--- a/docs/input/docs/grids.md
+++ b/docs/input/docs/grids.md
@@ -1,6 +0,0 @@
-Title: Grids
-Order: 4
-Hidden: True
---
-
-__To be written__
--- a/docs/input/docs/panels.md
+++ b/docs/input/docs/panels.md
@@ -1,6 +0,0 @@
-Title: Panels
-Order: 5
-Hidden: True
---
-
-__To be written__
--- a/docs/input/docs/tables.md
+++ b/docs/input/docs/tables.md
@@ -1,6 +0,0 @@
-Title: Tables
-Order: 3
-Hidden: True
---
-
-__To be written__
--- a/docs/input/index.cshtml
+++ b/docs/input/index.cshtml
@@ -1,15 +0,0 @@
-Title: Start
-NoContainer: true
---
-@section Splash {
-    <div id="hero" class="jumbotron jumbotron-fluid mb-0">
-        <div class="container">
-            <div class="display-4 text-white">Spectre.Console</div> 
-            <p class="lead text-white">
-                A .NET Standard library that makes it easier to create beautiful console applications.
-                <br /><br />
-                <a class="btn btn-primary" href="/spectre.console/docs" role="button">Take me to the documentation</a>
-            </p>
-        </div>
-    </div>
-}
--- a/docs/input/docs/index.md
+++ b/docs/input/docs/index.md
@@ -13,7 +13,7 @@ for Python written by Will McGugan.
 * Supports tables, grids, panels, and a [Rich](https://github.com/willmcgugan/rich) 
  inspired markup language.
 * Supports the most common 
-  [SRG parameters](https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters) 
+  [SGR parameters](https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters) 
  when it comes to text styling such as bold, dim, italic, underline, strikethrough, 
  and blinking text.
 * Supports `3`/`4`/`8`/`24`-bit colors in the terminal.  
--- a/docs/input/markup.md
+++ b/docs/input/markup.md
@@ -0,0 +1,104 @@
+Title: Markup
+Order: 3
+Hidden: False
+---
+
+In `Spectre.Console` there's a class called `Markup` that
+allows you to output rich text to the console.
+
+```csharp
+AnsiConsole.Render(new Markup("[bold yellow]Hello[/] [red]World![/]"));
+```
+
+Which should output something similar to the image below. Note that the
+actual appearance might vary depending on your terminal.
+
+![](/spectre.console/assets/images/helloworld.png)
+
+
+The `Markup` class implements `IRenderable` which means that you 
+can use this in tables, grids, and panels. Most classes that support
+rendering of `IRenderable` also have overloads for rendering rich text.
+
+```csharp
+var table = new Table();
+table.AddColumn(new TableColumn(new Markup("[yellow]Foo[/]")));
+table.AddColumn(new TableColumn("[blue]Bar[/]"));
+```
+
+# Convenience methods
+
+There is also convenience methods on `AnsiConsole` that can be used
+to write markup text to the console without instantiating a new `Markup`
+instance.
+
+```csharp
+AnsiConsole.Markup("[underline green]Hello[/] ");
+AnsiConsole.MarkupLine("[bold]World[/]");
+```
+
+# Escaping format characters
+
+To output a `[` you use `[[`, and to output a `]` you use `]]`.
+
+```csharp
+AnsiConsole.Markup("[[Hello]] "); // [Hello]
+AnsiConsole.Markup("[red][[World]][/]"); // [World]
+```
+
+# Setting background color
+
+You can set the background color in markup by prefixing the color with
+`on`.
+
+```
+[bold yellow on blue]Hello[/]
+[default on blue]World[/]
+```
+
+# Colors
+
+For a list of colors, see the [Colors](xref:colors) section.
+
+# Styles
+
+Note that what styles that can be used is defined by the system or your terminal software, and may not appear as they should.
+
+<table class="table">
+    <tr>
+        <td><code>bold</code></td>
+        <td>Bold text</td>
+    </tr>
+    <tr>
+        <td><code>dim</code></td>
+        <td>Dim or faint text</td>
+    </tr>
+    <tr>
+        <td><code>italic</code></td>
+        <td>Italic text</td>
+    </tr>
+    <tr>
+        <td><code>underline</code></td>
+        <td>Underlined text</td>
+    </tr>
+    <tr>
+        <td><code>invert</code></td>
+        <td>Swaps the foreground and background colors</td>
+    </tr>
+    <tr>
+        <td><code>conceal</code></td>
+        <td>Hides the text</td>
+    </tr>
+    <tr>
+        <td><code>slowblink</code></td>
+        <td>Makes text blink slowly</td>
+    </tr>
+    <tr>
+        <td><code>rapidblink</code></td>
+        <td>Makes text blink</td>
+    </tr>
+    <tr>
+        <td><code>strikethrough</code></td>
+        <td>Shows text with a horizontal line through the center</td>
+    </tr>
+</table>
--- a/docs/input/docs/quick-start.md
+++ b/docs/input/docs/quick-start.md
--- a/docs/src/Extensions/DocumentExtensions.cs
+++ b/docs/src/Extensions/DocumentExtensions.cs
@@ -11,15 +11,6 @@ namespace Docs
            return document?.GetString(Constants.Description, string.Empty) ?? string.Empty;
        }

-        public static bool HasVisibleChildren(this IDocument document)
-        {
-            if (document != null)
-            {
-                return document.HasChildren() && document.GetChildren().Any(x => x.IsVisible());
-            }
-            return false;
-        }
-
        public static bool IsVisible(this IDocument document)
        {
            return !document.GetBool(Constants.Hidden, false);
--- a/docs/src/Pipelines/ColorsPipeline.cs
+++ b/docs/src/Pipelines/ColorsPipeline.cs
@@ -1,8 +1,7 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using Docs.Models;
-using NJsonSchema;
 using Statiq.Common;
 using Statiq.Core;

--- a/docs/src/Shortcodes/ColorTableShortcode.cs
+++ b/docs/src/Shortcodes/ColorTableShortcode.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using NJsonSchema;
 using Statiq.Common;
 using System.Xml.Linq;
 using Docs.Pipelines;
--- a/docs/src/Utilities/VersionUtilities.cs
+++ b/docs/src/Utilities/VersionUtilities.cs
@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Reflection;
+using System.Text;
+
+namespace Docs.Utilities
+{
+    public static class VersionUtilities
+    {
+        public static string GetVersion()
+        {
+            return GetVersion(typeof(VersionUtilities).Assembly);
+        }
+
+        private static string GetVersion(Assembly assembly)
+        {
+            if (assembly == null)
+            {
+                return "?";
+            }
+
+            try
+            {
+                var info = FileVersionInfo.GetVersionInfo(assembly.Location);
+                return info.ProductVersion ?? "?";
+            }
+            catch
+            {
+                return "?";
+            }
+        }
+    }
+}
--- a/src/Spectre.Console.Tests/Unit/AnsiConsoleTests.Markup.cs
+++ b/src/Spectre.Console.Tests/Unit/AnsiConsoleTests.Markup.cs
@@ -12,7 +12,7 @@ namespace Spectre.Console.Tests.Unit
        {
            [Theory]
            [InlineData("[yellow]Hello[/]", "[93mHello[0m")]
-            [InlineData("[yellow]Hello [italic]World[/]![/]", "[93mHello[0m[93m [0m[3;93mWorld[0m[93m![0m")]
+            [InlineData("[yellow]Hello [italic]World[/]![/]", "[93mHello [0m[3;93mWorld[0m[93m![0m")]
            public void Should_Output_Expected_Ansi_For_Markup(string markup, string expected)
            {
                // Given
@@ -26,7 +26,7 @@ namespace Spectre.Console.Tests.Unit
            }

            [Theory]
-            [InlineData("[yellow]Hello [[ World[/]", "[93mHello[0m[93m [0m[93m[[0m[93m [0m[93mWorld[0m")]
+            [InlineData("[yellow]Hello [[ World[/]", "[93mHello [ World[0m")]
            public void Should_Be_Able_To_Escape_Tags(string markup, string expected)
            {
                // Given
--- a/src/Spectre.Console.Tests/Unit/TextTests.cs
+++ b/src/Spectre.Console.Tests/Unit/TextTests.cs
@@ -83,5 +83,25 @@ namespace Spectre.Console.Tests.Unit
                .NormalizeLineEndings()
                .ShouldBe(expected);
        }
+
+        [Theory]
+        [InlineData(Overflow.Fold, "foo \npneumonoultram\nicroscopicsili\ncovolcanoconio\nsis bar qux")]
+        [InlineData(Overflow.Crop, "foo \npneumonoultram\nbar qux")]
+        [InlineData(Overflow.Ellipsis, "foo \npneumonoultra…\nbar qux")]
+        public void Should_Overflow_Text_Correctly(Overflow overflow, string expected)
+        {
+            // Given
+            var fixture = new PlainConsole(14);
+            var text = new Text("foo pneumonoultramicroscopicsilicovolcanoconiosis bar qux")
+                .SetOverflow(overflow);
+
+            // When
+            fixture.Render(text);
+
+            // Then
+            fixture.Output
+                .NormalizeLineEndings()
+                .ShouldBe(expected);
+        }
    }
 }
--- a/src/Spectre.Console/ConsoleExtensions.Rendering.cs
+++ b/src/Spectre.Console/ConsoleExtensions.Rendering.cs
@@ -30,8 +30,11 @@ namespace Spectre.Console

            using (console.PushStyle(Style.Plain))
            {
+                var segments = renderable.Render(options, console.Width);
+                segments = Segment.Merge(segments);
+
                var current = Style.Plain;
-                foreach (var segment in renderable.Render(options, console.Width))
+                foreach (var segment in segments)
                {
                    if (string.IsNullOrEmpty(segment.Text))
                    {
--- a/src/Spectre.Console/Internal/Utilities/ConsoleHelper.cs
+++ b/src/Spectre.Console/Internal/Utilities/ConsoleHelper.cs
@@ -1,5 +1,4 @@
 using System.IO;
-using System.Runtime.InteropServices;

 namespace Spectre.Console.Internal
 {
--- a/src/Spectre.Console/Rendering/Markup.cs
+++ b/src/Spectre.Console/Rendering/Markup.cs
@@ -7,7 +7,7 @@ namespace Spectre.Console
    /// <summary>
    /// A renderable piece of markup text.
    /// </summary>
-    public sealed class Markup : Renderable, IAlignable
+    public sealed class Markup : Renderable, IAlignable, IOverflowable
    {
        private readonly Paragraph _paragraph;

@@ -18,6 +18,13 @@ namespace Spectre.Console
            set => _paragraph.Alignment = value;
        }

+        /// <inheritdoc/>
+        public Overflow? Overflow
+        {
+            get => _paragraph.Overflow;
+            set => _paragraph.Overflow = value;
+        }
+
        /// <summary>
        /// Initializes a new instance of the <see cref="Markup"/> class.
        /// </summary>
--- a/src/Spectre.Console/Rendering/Overflow.cs
+++ b/src/Spectre.Console/Rendering/Overflow.cs
@@ -0,0 +1,24 @@
+namespace Spectre.Console
+{
+    /// <summary>
+    /// Represents text overflow.
+    /// </summary>
+    public enum Overflow
+    {
+        /// <summary>
+        /// Put any excess characters on the next line.
+        /// </summary>
+        Fold = 0,
+
+        /// <summary>
+        /// Truncates the text at the end of the line.
+        /// </summary>
+        Crop = 1,
+
+        /// <summary>
+        /// Truncates the text at the end of the line and
+        /// also inserts an ellipsis character.
+        /// </summary>
+        Ellipsis = 2,
+    }
+}
--- a/src/Spectre.Console/Rendering/Paragraph.cs
+++ b/src/Spectre.Console/Rendering/Paragraph.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
@@ -12,7 +12,7 @@ namespace Spectre.Console
    /// of the paragraph can have individual styling.
    /// </summary>
    [DebuggerDisplay("{_text,nq}")]
-    public sealed class Paragraph : Renderable, IAlignable
+    public sealed class Paragraph : Renderable, IAlignable, IOverflowable
    {
        private readonly List<SegmentLine> _lines;

@@ -21,6 +21,11 @@ namespace Spectre.Console
        /// </summary>
        public Justify? Alignment { get; set; }

+        /// <summary>
+        /// Gets or sets the text overflow strategy.
+        /// </summary>
+        public Overflow? Overflow { get; set; }
+
        /// <summary>
        /// Initializes a new instance of the <see cref="Paragraph"/> class.
        /// </summary>
@@ -197,34 +202,76 @@ namespace Spectre.Console
            var line = new SegmentLine();

            var newLine = true;
-            using (var iterator = new SegmentLineIterator(_lines))
+
+            using var iterator = new SegmentLineIterator(_lines);
+            var queue = new Queue<Segment>();
+            while (true)
            {
-                while (iterator.MoveNext())
+                var current = (Segment?)null;
+                if (queue.Count == 0)
                {
-                    var current = iterator.Current;
-                    if (current == null)
+                    if (!iterator.MoveNext())
                    {
-                        throw new InvalidOperationException("Iterator returned empty segment.");
+                        break;
                    }

-                    if (newLine && current.IsWhiteSpace && !current.IsLineBreak)
-                    {
-                        newLine = false;
-                        continue;
-                    }
+                    current = iterator.Current;
+                }
+                else
+                {
+                    current = queue.Dequeue();
+                }

+                if (current == null)
+                {
+                    throw new InvalidOperationException("Iterator returned empty segment.");
+                }
+
+                if (newLine && current.IsWhiteSpace && !current.IsLineBreak)
+                {
                    newLine = false;
+                    continue;
+                }

-                    if (current.IsLineBreak)
+                newLine = false;
+
+                if (current.IsLineBreak)
+                {
+                    line.Add(current);
+                    lines.Add(line);
+                    line = new SegmentLine();
+                    newLine = true;
+                    continue;
+                }
+
+                var length = current.CellLength(context.Encoding);
+                if (length > maxWidth)
+                {
+                    // The current segment is longer than the width of the console,
+                    // so we will need to crop it up, into new segments.
+                    var segments = Segment.SplitOverflow(current, Overflow, context.Encoding, maxWidth);
+                    if (segments.Count > 0)
                    {
-                        line.Add(current);
-                        lines.Add(line);
-                        line = new SegmentLine();
-                        newLine = true;
-                        continue;
-                    }
+                        if (line.CellWidth(context.Encoding) + segments[0].CellLength(context.Encoding) > maxWidth)
+                        {
+                            lines.Add(line);
+                            line = new SegmentLine();
+                            newLine = true;

-                    var length = current.CellLength(context.Encoding);
+                            segments.ForEach(s => queue.Enqueue(s));
+                            continue;
+                        }
+                        else
+                        {
+                            // Add the segment and push the rest of them to the queue.
+                            line.Add(segments[0]);
+                            segments.Skip(1).ForEach(s => queue.Enqueue(s));
+                            continue;
+                        }
+                    }
+                }
+                else
+                {
                    if (line.CellWidth(context.Encoding) + length > maxWidth)
                    {
                        line.Add(Segment.Empty);
@@ -232,16 +279,16 @@ namespace Spectre.Console
                        line = new SegmentLine();
                        newLine = true;
                    }
-
-                    if (newLine && current.IsWhiteSpace)
-                    {
-                        continue;
-                    }
-
-                    newLine = false;
-
-                    line.Add(current);
                }
+
+                if (newLine && current.IsWhiteSpace)
+                {
+                    continue;
+                }
+
+                newLine = false;
+
+                line.Add(current);
            }

            // Flush remaining.
--- a/src/Spectre.Console/Rendering/Segment.cs
+++ b/src/Spectre.Console/Rendering/Segment.cs
@@ -16,7 +16,7 @@ namespace Spectre.Console.Rendering
        /// <summary>
        /// Gets the segment text.
        /// </summary>
-        public string Text { get; }
+        public string Text { get; internal set; }

        /// <summary>
        /// Gets a value indicating whether or not this is an expicit line break
@@ -226,6 +226,92 @@ namespace Spectre.Console.Rendering
            return lines;
        }

+        internal static IEnumerable<Segment> Merge(IEnumerable<Segment> segments)
+        {
+            var result = new List<Segment>();
+
+            var previous = (Segment?)null;
+            foreach (var segment in segments)
+            {
+                if (previous == null)
+                {
+                    previous = segment;
+                    continue;
+                }
+
+                // Same style?
+                if (previous.Style.Equals(segment.Style))
+                {
+                    // Modify the content of the previous segment
+                    previous.Text += segment.Text;
+                }
+                else
+                {
+                    // Push the current one to the results.
+                    result.Add(previous);
+                    previous = segment;
+                }
+            }
+
+            if (previous != null)
+            {
+                result.Add(previous);
+            }
+
+            return result;
+        }
+
+        /// <summary>
+        /// Splits an overflowing segment into several new segments.
+        /// </summary>
+        /// <param name="segment">The segment to split.</param>
+        /// <param name="overflow">The overflow strategy to use.</param>
+        /// <param name="encoding">The encodign to use.</param>
+        /// <param name="width">The maxiumum width.</param>
+        /// <returns>A list of segments that has been split.</returns>
+        public static List<Segment> SplitOverflow(Segment segment, Overflow? overflow, Encoding encoding, int width)
+        {
+            if (segment is null)
+            {
+                throw new ArgumentNullException(nameof(segment));
+            }
+
+            if (segment.CellLength(encoding) <= width)
+            {
+                return new List<Segment>(1) { segment };
+            }
+
+            // Default to folding
+            overflow ??= Overflow.Fold;
+
+            var result = new List<Segment>();
+
+            if (overflow == Overflow.Fold)
+            {
+                var totalLength = segment.Text.CellLength(encoding);
+                var lengthLeft = totalLength;
+                while (lengthLeft > 0)
+                {
+                    var index = totalLength - lengthLeft;
+                    var take = Math.Min(width, totalLength - index);
+
+                    result.Add(new Segment(segment.Text.Substring(index, take), segment.Style));
+                    lengthLeft -= take;
+                }
+            }
+            else if (overflow == Overflow.Crop)
+            {
+                result.Add(new Segment(segment.Text.Substring(0, width), segment.Style));
+            }
+            else if (overflow == Overflow.Ellipsis)
+            {
+                result.Add(new Segment(segment.Text.Substring(0, width - 1), segment.Style));
+                result.Add(new Segment("…", segment.Style));
+            }
+
+            return result;
+        }
+
        internal static List<List<SegmentLine>> MakeSameHeight(int cellHeight, List<List<SegmentLine>> cells)
        {
            foreach (var cell in cells)
--- a/src/Spectre.Console/Rendering/Text.cs
+++ b/src/Spectre.Console/Rendering/Text.cs
@@ -10,7 +10,7 @@ namespace Spectre.Console
    /// </summary>
    [DebuggerDisplay("{_text,nq}")]
    [SuppressMessage("Naming", "CA1724:Type names should not match namespaces")]
-    public sealed class Text : Renderable, IAlignable
+    public sealed class Text : Renderable, IAlignable, IOverflowable
    {
        private readonly Paragraph _paragraph;

@@ -38,6 +38,15 @@ namespace Spectre.Console
            set => _paragraph.Alignment = value;
        }

+        /// <summary>
+        /// Gets or sets the text overflow strategy.
+        /// </summary>
+        public Overflow? Overflow
+        {
+            get => _paragraph.Overflow;
+            set => _paragraph.Overflow = value;
+        }
+
        /// <inheritdoc/>
        protected override Measurement Measure(RenderContext context, int maxWidth)
        {
--- a/src/Spectre.Console/Rendering/Traits/Extensions/OverflowableExtensions.cs
+++ b/src/Spectre.Console/Rendering/Traits/Extensions/OverflowableExtensions.cs
@@ -0,0 +1,80 @@
+using System;
+
+namespace Spectre.Console
+{
+    /// <summary>
+    /// Contains extension methods for <see cref="IOverflowable"/>.
+    /// </summary>
+    public static class OverflowableExtensions
+    {
+        /// <summary>
+        /// Folds any overflowing text.
+        /// </summary>
+        /// <typeparam name="T">An object implementing <see cref="IOverflowable"/>.</typeparam>
+        /// <param name="obj">The overflowable object instance.</param>
+        /// <returns>The same instance so that multiple calls can be chained.</returns>
+        public static T Fold<T>(this T obj)
+            where T : class, IOverflowable
+        {
+            if (obj is null)
+            {
+                throw new ArgumentNullException(nameof(obj));
+            }
+
+            return SetOverflow(obj, Overflow.Fold);
+        }
+
+        /// <summary>
+        /// Crops any overflowing text.
+        /// </summary>
+        /// <typeparam name="T">An object implementing <see cref="IOverflowable"/>.</typeparam>
+        /// <param name="obj">The overflowable object instance.</param>
+        /// <returns>The same instance so that multiple calls can be chained.</returns>
+        public static T Crop<T>(this T obj)
+            where T : class, IOverflowable
+        {
+            if (obj is null)
+            {
+                throw new ArgumentNullException(nameof(obj));
+            }
+
+            return SetOverflow(obj, Overflow.Crop);
+        }
+
+        /// <summary>
+        /// Crops any overflowing text and adds an ellipsis to the end.
+        /// </summary>
+        /// <typeparam name="T">An object implementing <see cref="IOverflowable"/>.</typeparam>
+        /// <param name="obj">The overflowable object instance.</param>
+        /// <returns>The same instance so that multiple calls can be chained.</returns>
+        public static T Ellipsis<T>(this T obj)
+            where T : class, IOverflowable
+        {
+            if (obj is null)
+            {
+                throw new ArgumentNullException(nameof(obj));
+            }
+
+            return SetOverflow(obj, Overflow.Ellipsis);
+        }
+
+        /// <summary>
+        /// Sets the overflow strategy.
+        /// </summary>
+        /// <typeparam name="T">An object implementing <see cref="IOverflowable"/>.</typeparam>
+        /// <param name="obj">The overflowable object instance.</param>
+        /// <param name="overflow">The overflow strategy to use.</param>
+        /// <returns>The same instance so that multiple calls can be chained.</returns>
+        public static T SetOverflow<T>(this T obj, Overflow overflow)
+            where T : class, IOverflowable
+        {
+            if (obj is null)
+            {
+                throw new ArgumentNullException(nameof(obj));
+            }
+
+            obj.Overflow = overflow;
+            return obj;
+        }
+    }
+}
--- a/src/Spectre.Console/Rendering/Traits/IOverflowable.cs
+++ b/src/Spectre.Console/Rendering/Traits/IOverflowable.cs
@@ -0,0 +1,13 @@
+namespace Spectre.Console
+{
+    /// <summary>
+    /// Represents something that can overflow.
+    /// </summary>
+    public interface IOverflowable
+    {
+        /// <summary>
+        /// Gets or sets the text overflow strategy.
+        /// </summary>
+        Overflow? Overflow { get; set; }
+    }
+}
Author	SHA1	Message	Date
Patrik Svensson	9f8ca6d648	Add text overflow support Closes #61	2020-09-03 14:57:57 +02:00
Patrik Svensson	88edfe68ec	Add border for color representations	2020-09-02 09:55:44 +02:00
Patrik Svensson	5d32764a64	Fix typo: SRG -> SGR	2020-09-02 09:02:59 +02:00
Patrik Svensson	4f6c9c62c7	Set fetch depth to 0	2020-09-01 22:05:46 +02:00
Patrik Svensson	f2677213a4	Separate build and run when publishing docs	2020-09-01 22:00:44 +02:00
Patrik Svensson	bdaf00a556	Remove empty documentation pages	2020-09-01 21:51:25 +02:00
Patrik Svensson	7de4b6c7b9	Build docs as part of CI	2020-09-01 21:50:36 +02:00
Patrik Svensson	0bc801e3eb	Build docs when source change	2020-09-01 21:40:49 +02:00
Patrik Svensson	88a82cdad0	Build docs in release mode	2020-09-01 21:39:40 +02:00
Patrik Svensson	0cecb555d5	Show documentation version in footer	2020-09-01 21:33:15 +02:00
Patrik Svensson	52e3ee17b0	Fix logo link	2020-09-01 21:28:52 +02:00
Dave Glick	caf7661e66	Moves all the pages up a level and hardcodes the section name	2020-09-01 21:23:01 +02:00
Dave Glick	65f0a085cc	Updated to the latest Statiq Web with breakage fixes	2020-09-01 21:03:47 +02:00
Patrik Svensson	a123806cd8	Add docs for escaping [ and ] in markup	2020-09-01 16:52:40 +02:00
Patrik Svensson	173645cdd2	Added documentation for markup text	2020-08-31 14:05:28 +02:00
Patrik Svensson	7fd2efaeb5	Merge segments before rendering This will reduce the number of segments to render and produce cleaner ANSI escape code sequences. Closes #46	2020-08-30 12:40:34 +02:00
				`@@ -0,0 +1 @@`
				`dotnet run -- preview --virtual-dir "spectre.console"`