📖 update element options tutorial | rename SingleRounded to SingleRound

docs/introduction/elements_options.md

@@ -5,7 +5,7 @@ In this section, you will learn:
 - How to deactivate/ remove elements
 - How to use the `ElementsDashboard` inspector element
 - How to use the `HeightSpacer` element
-- Discover `Placement` and `TextAlignment` enumerations
+- Discover `Placement`, `TextAlignment` and `BordersType` enumerations
 - How to use the full potential of the element options
 
 ## Setup
@@ -146,7 +146,7 @@ Window.Close();
 
 In all the tutorials and the [example project](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/example/) the elements definitions are simplified and do not declare all the arguments available. To see all the arguments available for each element, you can consult the [references documentation](https://morgankryze.github.io/ConsoleAppVisuals/references/index.html).
 
-Most of them are specific with generic type (`string`, `int`, `bool`...) and are used to customize the element. But some of them are common to all elements and are used to place the element on the window. These are the `Placement` and `TextAlignment` enumerations.
+Most of them are specific with generic type (`string`, `int`, `bool`, `List`, ...) and are used to customize the element. But some of them are common to all elements and are used to place the element on the window. These are the `Placement` and `TextAlignment` enumerations.
 
 ### `Placement`
 
@@ -158,7 +158,7 @@ The available values are:
 
 ![TopLeft](../assets/img/jpg/elements_options/topleft.jpg)
 
-- `TopCenter`: x(line) = 0, y(char) = windowWidth / 2
+- `TopCenter`: (Default) x(line) = 0, y(char) = windowWidth / 2
 
 ![TopCenter](../assets/img/jpg/elements_options/topcenter.jpg)
 
@@ -178,7 +178,7 @@ The available values are:
 > To choose the placement of an element, you can either set it from the constructor or use the `UpdatePlacement()` method after creating the element.
 >
 > ```csharp
-> Prompt prompt = new Prompt("Enter your name", "Name", Placement.TopCenter);
+> Prompt prompt = new Prompt("Enter your name:", "John", Placement.TopCenter);
 > // or
 > prompt.UpdatePlacement(Placement.TopCenter);
 > ```
@@ -191,7 +191,7 @@ The `TextAlignment` enumeration is used to align the text in a string. It is use
 
 ![Left](../assets/img/jpg/elements_options/left.jpg)
 
-- `Center`: Align the text to the center
+- `Center`: (Default) Align the text to the center
 
 ![Center](../assets/img/jpg/elements_options/center.jpg)
 
@@ -208,6 +208,45 @@ The `TextAlignment` enumeration is used to align the text in a string. It is use
 > embedText.UpdateTextAlignment(TextAlignment.Center);
 > ```
 
+### `BordersType`
+
+The `BordersType` enumeration is used to set the borders of an element. It is used by the table and embed elements from the library. Here are the available values:
+
+- `SingleStraight`: (Default) Single lines with straight corners
+
+![SingleStraight](../assets/img/jpg/elements_options/straight.jpg)
+
+- `SingleRound`: Single lines with round corners
+
+![SingleRound](../assets/img/jpg/elements_options/round.jpg)
+
+- `SingleBold`: Single bold lines with straight corners
+
+![SingleBold](../assets/img/jpg/elements_options/bold.jpg)
+
+- `DoubleStraight`: Double lines with straight corners
+
+![DoubleStraight](../assets/img/jpg/elements_options/double.jpg)
+
+- `ASCII`: ASCII basic characters for the borders (`+`, `-`, `|` only)
+
+![ASCII](../assets/img/jpg/elements_options/ascii.jpg)
+
+> [!WARNING]
+> The following types are not available for Visual Studio or Windows Command Prompt:
+>
+> - `SingleRound`
+> - `SingleBold`
+
+> [!NOTE]
+> To choose the border type of an element, you can either set it from the constructor or use the `UpdateBordersType()` method after creating the element (some elements may not have this method if the border type is not used in it so refer to the references documentation to get that specific information).
+>
+> ```csharp
+> ElementsDashboard dashboard = new ElementsDashboard(Placement.TopCenter, BordersType.SingleStraight);
+> // or
+> dashboard.UpdateBordersType(BordersType.SingleStraight);
+> ```
+
 ## Conclusion
 
 In this section, you learned how to deactivate and remove elements from the window. You also discovered the `Placement` and `TextAlignment` enumerations and how to use the full potential of the element options by knowing all the arguments available. You may now be able to use more complex elements and place them at your desired location.

src/ConsoleAppVisuals/enums/BordersType.cs

@@ -30,7 +30,7 @@ public enum BordersType
     /// <remarks>
     /// Not supported on PowerShell (Windows).
     /// </remarks>
-    SingleRounded,
+    SingleRound,
 
     /// <summary>
     /// Single line borders with bold lines (┏┓┗┛━┃┳┻┣┫╋)

src/ConsoleAppVisuals/models/Borders.cs

@@ -112,7 +112,7 @@ private static BordersType CheckType(BordersType type)
         if (
             type
             is BordersType.SingleStraight
-                or BordersType.SingleRounded
+                or BordersType.SingleRound
                 or BordersType.SingleBold
                 or BordersType.DoubleStraight
                 or BordersType.ASCII
@@ -150,7 +150,7 @@ public char GetBorderChar(int index)
         string border = _type switch
         {
             BordersType.SingleStraight => SINGLE_STRAIGHT,
-            BordersType.SingleRounded => SINGLE_ROUNDED,
+            BordersType.SingleRound => SINGLE_ROUNDED,
             BordersType.SingleBold => SINGLE_BOLD,
             BordersType.DoubleStraight => DOUBLE_STRAIGHT,
             BordersType.ASCII => ASCII,

testing/elements/interactive/Prompt.Tests.cs

@@ -311,9 +311,9 @@ public void UpdateBorderType()
         var prompt = new Prompt("What is your name?", "John Doe");
 
         // Act
-        prompt.UpdateBordersType(BordersType.SingleRounded);
+        prompt.UpdateBordersType(BordersType.SingleRound);
         var actual = prompt.BordersType;
-        var expected = BordersType.SingleRounded;
+        var expected = BordersType.SingleRound;
 
         // Assert
         Assert.AreEqual(expected, actual);

testing/elements/passive/TableView.Tests.cs

@@ -478,10 +478,10 @@ public void UpdateBorderType_UpdatesBorderTypeCorrectly()
             );
 
         // Act
-        table.UpdateBordersType(BordersType.SingleRounded);
+        table.UpdateBordersType(BordersType.SingleRound);
 
         // Assert
-        Assert.AreEqual(BordersType.SingleRounded, table.BordersType);
+        Assert.AreEqual(BordersType.SingleRound, table.BordersType);
     }
 
     [TestMethod]

testing/models/Borders.Tests.cs

@@ -51,7 +51,7 @@ public void Borders_Constructor_InvalidType()
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┌')]
-    [DataRow(BordersType.SingleRounded, '╭')]
+    [DataRow(BordersType.SingleRound, '╭')]
     [DataRow(BordersType.SingleBold, '┏')]
     [DataRow(BordersType.DoubleStraight, '╔')]
     [DataRow(BordersType.ASCII, '+')]
@@ -70,7 +70,7 @@ public void Borders_TopLeft(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┐')]
-    [DataRow(BordersType.SingleRounded, '╮')]
+    [DataRow(BordersType.SingleRound, '╮')]
     [DataRow(BordersType.SingleBold, '┓')]
     [DataRow(BordersType.DoubleStraight, '╗')]
     [DataRow(BordersType.ASCII, '+')]
@@ -89,7 +89,7 @@ public void Borders_TopRight(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '└')]
-    [DataRow(BordersType.SingleRounded, '╰')]
+    [DataRow(BordersType.SingleRound, '╰')]
     [DataRow(BordersType.SingleBold, '┗')]
     [DataRow(BordersType.DoubleStraight, '╚')]
     [DataRow(BordersType.ASCII, '+')]
@@ -108,7 +108,7 @@ public void Borders_BottomLeft(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┘')]
-    [DataRow(BordersType.SingleRounded, '╯')]
+    [DataRow(BordersType.SingleRound, '╯')]
     [DataRow(BordersType.SingleBold, '┛')]
     [DataRow(BordersType.DoubleStraight, '╝')]
     [DataRow(BordersType.ASCII, '+')]
@@ -127,7 +127,7 @@ public void Borders_BottomRight(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '─')]
-    [DataRow(BordersType.SingleRounded, '─')]
+    [DataRow(BordersType.SingleRound, '─')]
     [DataRow(BordersType.SingleBold, '━')]
     [DataRow(BordersType.DoubleStraight, '═')]
     [DataRow(BordersType.ASCII, '-')]
@@ -146,7 +146,7 @@ public void Borders_Horizontal(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '│')]
-    [DataRow(BordersType.SingleRounded, '│')]
+    [DataRow(BordersType.SingleRound, '│')]
     [DataRow(BordersType.SingleBold, '┃')]
     [DataRow(BordersType.DoubleStraight, '║')]
     [DataRow(BordersType.ASCII, '|')]
@@ -165,7 +165,7 @@ public void Borders_Vertical(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┬')]
-    [DataRow(BordersType.SingleRounded, '┬')]
+    [DataRow(BordersType.SingleRound, '┬')]
     [DataRow(BordersType.SingleBold, '┳')]
     [DataRow(BordersType.DoubleStraight, '╦')]
     [DataRow(BordersType.ASCII, '+')]
@@ -184,7 +184,7 @@ public void Borders_Top(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┴')]
-    [DataRow(BordersType.SingleRounded, '┴')]
+    [DataRow(BordersType.SingleRound, '┴')]
     [DataRow(BordersType.SingleBold, '┻')]
     public void Borders_Bottom(BordersType type, char expected)
     {
@@ -201,7 +201,7 @@ public void Borders_Bottom(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '├')]
-    [DataRow(BordersType.SingleRounded, '├')]
+    [DataRow(BordersType.SingleRound, '├')]
     public void Borders_Left(BordersType type, char expected)
     {
         // Arrange
@@ -217,7 +217,7 @@ public void Borders_Left(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┤')]
-    [DataRow(BordersType.SingleRounded, '┤')]
+    [DataRow(BordersType.SingleRound, '┤')]
     public void Borders_Right(BordersType type, char expected)
     {
         // Arrange
@@ -233,7 +233,7 @@ public void Borders_Right(BordersType type, char expected)
     [TestMethod]
     [TestCategory("Borders")]
     [DataRow(BordersType.SingleStraight, '┼')]
-    [DataRow(BordersType.SingleRounded, '┼')]
+    [DataRow(BordersType.SingleRound, '┼')]
     public void Borders_Cross(BordersType type, char expected)
     {
         // Arrange
@@ -272,11 +272,11 @@ public void Borders_UpdateBorderType_SingleRounded()
         Borders borders = new Borders();
 
         // Act
-        borders.UpdateBordersType(BordersType.SingleRounded);
+        borders.UpdateBordersType(BordersType.SingleRound);
         BordersType actual = borders.Type;
 
         // Assert
-        Assert.AreEqual(BordersType.SingleRounded, actual);
+        Assert.AreEqual(BordersType.SingleRound, actual);
     }
     #endregion
 }