Merge pull request #348 from Joshi234/add-custom-buttons-to-pagination

Add custom buttons & ability to remove buttons to pagination

Author: Nihlus

Remora.Discord.Pagination/Interactions/PaginationInteractions.cs

@@ -175,6 +175,11 @@ public async Task<Result> HelpAsync()
         {
             return Result.FromSuccess();
         }
+        if (lease.Data.Appearance.HelpEmbed == null)
+        {
+            return new InvalidOperationError("Help embed is not available.");
+        }
+
         return (Result)await _feedback.SendContextualEmbedAsync
         (
             lease.Data.Appearance.HelpEmbed,

Remora.Discord.Pagination/PaginatedAppearanceOptions.cs

@@ -37,10 +37,11 @@ public sealed record PaginatedAppearanceOptions
     ButtonComponent Previous,
     ButtonComponent Next,
     ButtonComponent Last,
-    ButtonComponent Close,
-    ButtonComponent Help,
-    Embed HelpEmbed,
-    string FooterFormat = "Page {0}/{1}"
+    ButtonComponent? Close,
+    ButtonComponent? Help,
+    Embed? HelpEmbed,
+    string FooterFormat = "Page {0}/{1}",
+    ButtonComponent[]? CustomButtons = null
 )
 {
     /// <summary>
@@ -94,7 +95,7 @@ public sealed record PaginatedAppearanceOptions
     /// <summary>
     /// Gets the appearance options' configured buttons as an array.
     /// </summary>
-    public IReadOnlyList<ButtonComponent> Buttons { get; } = new[]
+    public IReadOnlyList<ButtonComponent?> Buttons { get; } = new[]
     {
         First,
         Previous,

Remora.Discord.Pagination/PaginatedMessageData.cs

@@ -156,6 +156,19 @@ public Embed GetCurrentPage()
     /// <returns>The buttons.</returns>
     public IReadOnlyList<IMessageComponent> GetCurrentComponents()
     {
+        List<ButtonComponent> customComponents = new List<ButtonComponent>();
+        if (this.Appearance.Help != null)
+        {
+            customComponents.Add(this.Appearance.Help with { CustomID = CustomIDHelpers.CreateButtonID("help") });
+        }
+        if (this.Appearance.Close != null)
+        {
+            customComponents.Add(this.Appearance.Close with { CustomID = CustomIDHelpers.CreateButtonID("close") });
+        }
+        if (this.Appearance.CustomButtons != null)
+        {
+            customComponents.AddRange(this.Appearance.CustomButtons);
+        }
         return new[]
         {
             new ActionRowComponent
@@ -186,11 +199,7 @@ this.Appearance.Last with
             ),
             new ActionRowComponent
             (
-                new[]
-                {
-                    this.Appearance.Close with { CustomID = CustomIDHelpers.CreateButtonID("close") },
-                    this.Appearance.Help with { CustomID = CustomIDHelpers.CreateButtonID("help") }
-                }
+                customComponents
             )
         };
     }