Allow configuration of Altair UI Settings (#1044)

graphql-dotnet · Jul 2, 2023 · 312a860 · 312a860
1 parent 3136198
commit 312a860
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 1 deletion.
diff --git a/src/Ui.Altair/AltairOptions.cs b/src/Ui.Altair/AltairOptions.cs
@@ -25,6 +25,12 @@ public class AltairOptions
     /// </summary>
     public Dictionary<string, object?>? SubscriptionsPayload { get; set; }
 
+    /// <summary>
+    /// Altair UI settings.
+    /// <a href="https://altairgraphql.dev/docs/features/settings-pane.html">Available settings</a>
+    /// </summary>
+    public Dictionary<string, object?>? Settings { get; set; }
+
     /// <summary>
     /// Gets or sets a Stream function for retrieving the Altair GraphQL UI page.
     /// </summary>

diff --git a/src/Ui.Altair/Internal/AltairPageModel.cs b/src/Ui.Altair/Internal/AltairPageModel.cs
@@ -37,7 +37,8 @@ public string Render()
                 .Replace("@Model.GraphQLEndPoint", StringEncode(_options.GraphQLEndPoint))
                 .Replace("@Model.SubscriptionsEndPoint", StringEncode(_options.SubscriptionsEndPoint))
                 .Replace("@Model.Headers", JsonSerialize(headers))
-                .Replace("@Model.SubscriptionsPayload", JsonSerialize(_options.SubscriptionsPayload));
+                .Replace("@Model.SubscriptionsPayload", JsonSerialize(_options.SubscriptionsPayload))
+                .Replace("@Model.Settings", JsonSerialize(_options.Settings));
 
             // Here, fully-qualified, absolute and relative URLs are supported for both the
             // GraphQLEndPoint and SubscriptionsEndPoint.  Those paths can be passed unmodified

diff --git a/src/Ui.Altair/Internal/altair.cshtml b/src/Ui.Altair/Internal/altair.cshtml
@@ -61,6 +61,7 @@
         subscriptionsEndpoint: getSubscriptionsEndPoint(),
         initialHeaders: @Model.Headers,
         initialSubscriptionsPayload: @Model.SubscriptionsPayload,
+        initialSettings: @Model.Settings,
     };
 
     window.addEventListener("load", function() {

diff --git a/tests/ApiApprovalTests/netcoreapp31/GraphQL.Server.Ui.Altair.approved.txt b/tests/ApiApprovalTests/netcoreapp31/GraphQL.Server.Ui.Altair.approved.txt
@@ -18,6 +18,7 @@ namespace GraphQL.Server.Ui.Altair
         public System.Collections.Generic.Dictionary<string, string>? Headers { get; set; }
         public System.Func<GraphQL.Server.Ui.Altair.AltairOptions, System.IO.Stream> IndexStream { get; set; }
         public System.Func<GraphQL.Server.Ui.Altair.AltairOptions, string, string> PostConfigure { get; set; }
+        public System.Collections.Generic.Dictionary<string, object?>? Settings { get; set; }
         public string SubscriptionsEndPoint { get; set; }
         public System.Collections.Generic.Dictionary<string, object?>? SubscriptionsPayload { get; set; }
     }

diff --git a/tests/ApiApprovalTests/netstandard20/GraphQL.Server.Ui.Altair.approved.txt b/tests/ApiApprovalTests/netstandard20/GraphQL.Server.Ui.Altair.approved.txt
@@ -18,6 +18,7 @@ namespace GraphQL.Server.Ui.Altair
         public System.Collections.Generic.Dictionary<string, string>? Headers { get; set; }
         public System.Func<GraphQL.Server.Ui.Altair.AltairOptions, System.IO.Stream> IndexStream { get; set; }
         public System.Func<GraphQL.Server.Ui.Altair.AltairOptions, string, string> PostConfigure { get; set; }
+        public System.Collections.Generic.Dictionary<string, object?>? Settings { get; set; }
         public string SubscriptionsEndPoint { get; set; }
         public System.Collections.Generic.Dictionary<string, object?>? SubscriptionsPayload { get; set; }
     }