feat: add rest dropdown control, general improvements and minor bugs

Author: ReneSchwarzer

src/WebUI/Model/Inventory.cs

@@ -0,0 +1,42 @@
+using System;
+using WebExpress.WebApp.WebRestApi;
+using WebExpress.WebCore.WebUri;
+
+namespace WebExpress.Tutorial.WebUI.Model
+{
+    /// <summary>
+    /// Represents a data entity for a dropdown.
+    /// </summary>
+    public class Inventory : IRestApiCrudDropdownItem
+    {
+        /// <summary>
+        /// Returns or sets the identifier of the table data.
+        /// </summary>
+        public Guid Id { get; set; } = Guid.NewGuid();
+
+        /// <summary>
+        /// Returns or sets the name associated with the object.
+        /// </summary>
+        public string Text { get; set; }
+
+        /// <summary>
+        /// Returns or sets the description associated with the object.
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Returns or sets the URI as a string.
+        /// </summary>
+        public IUri Uri { get; set; }
+
+        /// <summary>
+        /// Returns a string representation of the object, including its name, description, and appearances.
+        /// </summary>
+        /// <returns>A string containing the object's name, description, and the context in which it appears, formatted as
+        /// multiple lines.</returns>
+        public override string ToString()
+        {
+            return $"Text: {Text}\nDescription: {Description}";
+        }
+    }
+}

src/WebUI/Model/ViewModel.cs

@@ -12,6 +12,11 @@ public static class ViewModel
         /// </summary>
         public static List<Character> MonkeyIslandCharacters { get; } = [.. GetMonkeyIslandCharacters()];
 
+        /// <summary>
+        /// Returns the list of inventories available in Monkey Island.
+        /// </summary>
+        public static List<Inventory> MonkeyIslanInventories { get; } = [.. GetMonkeyIslandInventories()];
+
         /// <summary>
         /// Retrieves a collection of characters from the Monkey Island universe.
         /// </summary>
@@ -397,5 +402,143 @@ private static IEnumerable<Character> GetMonkeyIslandCharacters()
                 AppearsIn = "Monkey Island 2: LeChuck’s Revenge (1991)"
             };
         }
+
+        /// <summary>
+        /// Retrieves a collection of inventory items.
+        /// </summary>
+        /// <returns>An collection containing the inventory items.</returns>
+        public static IEnumerable<Inventory> GetMonkeyIslandInventories()
+        {
+            // preferences / key items
+            yield return new Inventory
+            {
+                Text = "Sword",
+                Description = "A cutlass used for insult swordfighting and training with the Sword Master."
+            };
+            yield return new Inventory
+            {
+                Text = "Shovel",
+                Description = "A sturdy shovel used to dig up treasure at the X-marked spot."
+            };
+            yield return new Inventory
+            {
+                Text = "Treasure Map (PTA Minutes)",
+                Description = "Looks like PTA minutes, but actually leads to buried treasure on Melee Island."
+            };
+            yield return new Inventory
+            {
+                Text = "Spyglass",
+                Description = "A handy spyglass for distant viewing; favored by lookouts and nosy pirates."
+            };
+
+            // primary / main quest items
+            yield return new Inventory
+            {
+                Text = "Rubber Chicken with a Pulley in the Middle",
+                Description = "A rubber chicken fitted with a pulley, perfect for crossing improvised zip-lines."
+            };
+            yield return new Inventory
+            {
+                Text = "Head of the Navigator",
+                Description = "A disembodied head that points the way through the ghost ship's catacombs."
+            };
+            yield return new Inventory
+            {
+                Text = "Navigator's Necklace",
+                Description = "A mystical necklace that allows mingling with the ghostly realm aboard LeChuck's ship."
+            };
+            yield return new Inventory
+            {
+                Text = "Idol of Many Hands",
+                Description = "A precious idol stolen from the Governor's mansion during a daring heist."
+            };
+            yield return new Inventory
+            {
+                Text = "Cooking Pot",
+                Description = "A robust pot that doubles as protective headgear in questionable circus stunts."
+            };
+            yield return new Inventory
+            {
+                Text = "Gunpowder",
+                Description = "Explosive powder used for making things go boom at the most inappropriate times."
+            };
+            yield return new Inventory
+            {
+                Text = "Rope",
+                Description = "A length of rope that conveniently serves as a fuse and climbing aid."
+            };
+            yield return new Inventory
+            {
+                Text = "Root Beer",
+                Description = "A fizzy beverage with voodoo properties effective against ghost pirates."
+            };
+            yield return new Inventory
+            {
+                Text = "Monkey Head Key",
+                Description = "A peculiar key used to unlock the giant monkey head on Monkey Island."
+            };
+            yield return new Inventory
+            {
+                Text = "Directions to Monkey Island",
+                Description = "Vital directions concocted via a questionable recipe to reach Monkey Island."
+            };
+
+            // secondary / optional or situational items
+            yield return new Inventory
+            {
+                Text = "Fish",
+                Description = "A slippery fish; surprisingly useful for bribes, trolls, and culinary experiments."
+            };
+            yield return new Inventory
+            {
+                Text = "Hunk of Meat",
+                Description = "A chunk of meat from the SCUMM Bar kitchen; perfect for distracting vicious dogs."
+            };
+            yield return new Inventory
+            {
+                Text = "Yellow Petals",
+                Description = "Alchemically potent petals used to spice meat with... unforeseen side effects."
+            };
+            yield return new Inventory
+            {
+                Text = "Red Herring",
+                Description = "A cheeky nautical snack and a blatant adventure-game tradition."
+            };
+            yield return new Inventory
+            {
+                Text = "Mug",
+                Description = "A sturdy mug that, when filled with grog, tends to corrode in concerning ways."
+            };
+            yield return new Inventory
+            {
+                Text = "Mug o' Grog",
+                Description = "Highly corrosive grog that eats through locks and tableware alike."
+            };
+            yield return new Inventory
+            {
+                Text = "\"I beat the Sword Master\" T-Shirt",
+                Description = "A brag-worthy souvenir commemorating a victory over the Sword Master of Melee Island."
+            };
+            yield return new Inventory
+            {
+                Text = "Pieces of Eight",
+                Description = "Shiny pirate currency used for shopping, bribery, and impulsive purchases."
+            };
+            yield return new Inventory
+            {
+                Text = "Breath Mints",
+                Description = "Minty-fresh confidence boosters; surprisingly useful in social piracy."
+            };
+            yield return new Inventory
+            {
+                Text = "Bananas",
+                Description = "A bunch of bananas favored by certain simian companions."
+            };
+            yield return new Inventory
+            {
+                Text = "Note",
+                Description = "A handwritten note of dubious importance; pirates love leaving messages."
+            };
+        }
     }
 }

src/WebUI/WWW/Api/1/MonkeyIslandInventory.cs

@@ -0,0 +1,60 @@
+using System.Collections.Generic;
+using System.Linq;
+using WebExpress.Tutorial.WebUI.Model;
+using WebExpress.WebApp.WebRestApi;
+using WebExpress.WebCore.WebApplication;
+using WebExpress.WebCore.WebAttribute;
+using WebExpress.WebCore.WebMessage;
+using WebExpress.WebCore.WebRestApi;
+using WebExpress.WebCore.WebSitemap;
+
+namespace WebExpress.Tutorial.WebUI.WWW.Api._1
+{
+    /// <summary>
+    /// Represents a REST API dropdown for managing and retrieving data about Monkey Island inventory items.
+    /// </summary>
+    [Title("Monkey Island inventory")]
+    [Method(CrudMethod.GET)]
+    public sealed class MonkeyIslandInventory : RestApiCrudDropdown<Inventory>
+    {
+        /// <summary>
+        /// Initializes a new instance of the class.
+        /// </summary>
+        /// <param name="sitemapManager">
+        /// The sitemap manager used to retrieve URIs for the application context.
+        /// </param>
+        /// <param name="applicationContext">
+        /// The application context containing the current state of the application.
+        /// </param>
+        public MonkeyIslandInventory(ISitemapManager sitemapManager, IApplicationContext applicationContext)
+        {
+            Data = ViewModel.MonkeyIslanInventories;
+        }
+
+        /// <summary>
+        /// Retrieves a collection of objects based on the specified WQL statement and request.
+        /// </summary>
+        /// <param name="filter">
+        /// The filter used to query the data. This parameter defines the filtering and selection criteria.
+        /// </param>
+        /// <param name="request">
+        /// The request context containing additional information for the operation.
+        /// </param>
+        /// <returns>
+        /// An enumerable containing the objects that match the query criteria.
+        /// </returns>
+        public override IEnumerable<Inventory> GetData(string filter, Request request)
+        {
+            if (filter == null || filter == "null")
+            {
+                return Data;
+            }
+
+            return Data
+                .Where
+                (
+                    x => x.Text.Contains(filter, System.StringComparison.InvariantCultureIgnoreCase)
+                );
+        }
+    }
+}

src/WebUI/WWW/Controls/Dropdown.cs

@@ -23,7 +23,7 @@ public sealed class Dropdown : PageControl
         private readonly IControlDropdownItem _item2 = new ControlDropdownItemLink() { Text = "First Entry", Icon = new IconWrench() };
         private readonly IControlDropdownItem _item3 = new ControlDropdownItemLink() { Text = "Second Entry" };
         private readonly IControlDropdownItem _item4 = new ControlDropdownItemDivider();
-        private readonly IControlDropdownItem _item5 = new ControlDropdownItemLink() { Text = "Third Entry" };
+        private readonly IControlDropdownItem _item5 = new ControlDropdownItemLink() { Text = "Third Entry", Modal = "myModal" };
 
         /// <summary>  
         /// Initializes a new instance of the class.  
@@ -39,29 +39,47 @@ public Dropdown(IPageContext pageContext, ISitemapManager sitemapManager)
             The `Dropdown` provides a button with a dropdown menu, offering a clean and efficient design.";
 
             Stage.Controls = [
-                new ControlDropdown(null, _item1, _item2, _item3, _item4, _item5)
+                new ControlDropdown()
                 {
                     Text = "Dropdown",
                     TextColor = new PropertyColorText(TypeColorText.Default),
                     Color = new PropertyColorButton(TypeColorButton.Primary),
                 }
+                    .Add(_item1)
+                    .Add(_item2)
+                    .Add(_item3)
+                    .Add(_item4)
+                    .Add(_item5),
+                new ControlModalRemoteForm("myModal")
+                {
+                    Header = "My modal",
+                    Size = TypeModalSize.ExtraLarge,
+                    Uri = sitemapManager.GetUri<Form.Index>(pageContext.ApplicationContext),
+                    Selector = "#conformationform"
+                }
             ];
 
+            Stage.DarkControls = [
+               new ControlDropdown(null, _item1, _item2, _item3, _item4, _item5)
+                {
+                    Text = "Dropdown",
+                    TextColor = new PropertyColorText(TypeColorText.Default),
+                    Color = new PropertyColorButton(TypeColorButton.Primary),
+                }
+           ];
+
             Stage.Code = @"
-            new ControlDropdown
-            (
-                null, 
-                new ControlDropdownItemHeader() { Text = ""Header"" }, 
-                new ControlDropdownItemLink() { Text = ""First Entry"", Icon = new IconWrench() }, 
-                new ControlDropdownItemLink() { Text = ""Second Entry"" }, 
-                new ControlDropdownItemDivider(),
-                new ControlDropdownItemLink() { Text = ""Third Entry"" }
-            )
+            new ControlDropdown()
             {
                 Text = ""Dropdown"",
                 TextColor = new PropertyColorText(TypeColorText.Default),
                 BackgroundColor = new PropertyColorButton(TypeColorButton.Primary)
-            };";
+            }
+                .Add(new ControlDropdownItemHeader() { Text = ""Header"" }) 
+                .Add(new ControlDropdownItemLink() { Text = ""First Entry"", Icon = new IconWrench() })
+                .Add(new ControlDropdownItemLink() { Text = ""Second Entry"" })
+                .Add(new ControlDropdownItemDivider())
+                .Add(new ControlDropdownItemLink() { Text = ""Third Entry"", Modal = ""myModal"" });";
 
             Stage.AddProperty
             (