Added ItemTemplateSelector and ItemContainerStyle properties to SuggestBox and improved CachedPathSuggestionDemo

Author: Dirkster99

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/CachedPathInformationSuggest.cs

@@ -7,7 +7,9 @@
 
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
-
+	/// <summary>
+	/// Wraps a LiteDB to generate previously bookmarked suggestions through similarity for a given string.
+	/// </summary>
 	public class CachedPathInformationSuggest : ISuggest
 	{
 		private static readonly int NumberOfResultsReturned = 5;
@@ -25,6 +27,11 @@ public void Insert(string path)
 			LiteRepository.Instance.Insert(directoryInfo.FullName);
 		}
 
+		internal void Delete(string text)
+		{
+			throw new NotImplementedException();
+		}
+
 		/// <summary>
 		/// Makes suggestions of paths based on match between query and the full-name of the path.
 		/// Only returns latest <see cref="NumberOfResultsReturned"/> results (newest first).
@@ -39,13 +46,13 @@ public void Insert(string path)
 		/// f:\\do_letters
 		/// g:\\document\lists.ico
 		/// </example>
-		public async Task<IEnumerable<object>?> MakeSuggestions(string queryThis)
+		public async Task<IEnumerable<ViewModels.List.BaseItem>?> MakeSuggestions(string queryThis)
 		{
 			return await Task.Run(() => MakeSuggestionsPrivate().ToArray());
 
-			IEnumerable<object> MakeSuggestionsPrivate() =>
+			IEnumerable<ViewModels.List.BaseItem> MakeSuggestionsPrivate() =>
 				from item in GetPathInformations(queryThis)
-				select new { Header = item.FullName, Value = item.FullName };
+				select new ViewModels.List.Item( item.FullName, item.FullName );
 
 			static PathInformation[] GetPathInformations(string key)
 			{

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/CombinedSuggest.cs

@@ -1,33 +1,68 @@
 #nullable enable
-using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
+	/// <summary>
+	/// Wraps a LiteDB and a FileSystem data provider to generate similarity based suggestions
+	/// for a given string.
+	/// </summary>
 	class CombinedSuggest : ISuggest
 	{
 		private readonly DirectorySuggest directorySuggest = new DirectorySuggest();
 
-		public readonly CachedPathInformationSuggest CachedPathInformationSuggest = new CachedPathInformationSuggest();
+		private readonly CachedPathInformationSuggest CachedPathInformationSuggest = new CachedPathInformationSuggest();
 
-		public async Task<IEnumerable<object>?> MakeSuggestions(string queryThis)
+		/// <summary>
+		/// Gets a list of combined suggestions based on string similarity from the:
+		/// 1) cached entries (bookmarks) and
+		/// 2) file system data provider.
+		/// </summary>
+		/// <param name="queryThis"></param>
+		/// <returns>
+		/// Both types (cached entries and file system provider entries) of entries are returned
+		/// in a single list. The list contains a separator item (if both types of items are returned).
+		/// The separator item can be used for visual enhancement when displaying the list.
+		/// </returns>
+		public async Task<IEnumerable<ViewModels.List.BaseItem>?> MakeSuggestions(string queryThis)
 		{
-
 			var suggestions1 = (await CachedPathInformationSuggest.MakeSuggestions(queryThis))?.ToArray();
 
 			var suggestions2 = (await directorySuggest.MakeSuggestions(queryThis))?.ToArray();
 
-			if (suggestions2 == null && suggestions1?.Any() == false)
-			{
+			if (suggestions2?.Length == 0 && suggestions1?.Any() == false)
 				return null;
-			}
 
-			return suggestions2 != null ?
-				suggestions1?.Concat(suggestions2) :
-				suggestions1;
+			if (suggestions2?.Length != 0 && suggestions1?.Any() == false)
+				return suggestions2;
+
+			if (suggestions2?.Length == 0 && suggestions1?.Any() == true)
+				return suggestions1;
+
+			// Insert a seperator between bookmarked suggestions and suggestions from file system
+			return suggestions1
+				.Concat(new ViewModels.List.BaseItem[1] { new ViewModels.List.ItemSeperator() })
+				.Concat(suggestions2);
+		}
+
+		/// <summary>
+		/// Insert a new suggestion into the available list of suggestions
+		/// </summary>
+		/// <param name="text"></param>
+		public void InsertCachedSuggestion(string text)
+		{
+			CachedPathInformationSuggest.Insert(text);
+		}
+
+		/// <summary>
+		/// Delete a suggestion in the available list of suggestions
+		/// </summary>
+		/// <param name="text"></param>
+		public void DeleteCachedSuggestion(string text)
+		{
+			CachedPathInformationSuggest.Delete(text);
 		}
 	}
 }

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/DirectorySuggestSource.cs

@@ -10,8 +10,10 @@
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
 	/// <summary>
-	/// Defines a suggestion object to generate suggestions
-	/// based on sub entries of specified string.
+	/// Wraps a LiteDB and a FileSystem data provider to generate similarity based suggestions
+	/// for a given string.
+	/// 
+	/// Defines a suggestion object to generate suggestions based on sub entries of specified string.
 	/// </summary>
 	public class DirectorySuggest : ISuggest
 	{
@@ -31,7 +33,7 @@ public DirectorySuggest()
 		}
 		#endregion ctors
 
-		public async Task<IEnumerable<object>?> MakeSuggestions(string queryThis)
+		public async Task<IEnumerable<ViewModels.List.BaseItem>?> MakeSuggestions(string queryThis)
 		{
 			// Cancel current task(s) if there is any...
 			var queueList = _Queue.Values.ToList();
@@ -67,9 +69,7 @@ public DirectorySuggest()
 
 			return null;
 
-
-
-			static IEnumerable<object>? EnumerateSubDirs(string input)
+			static IEnumerable<ViewModels.List.Item>? EnumerateSubDirs(string input)
 			{
 				if (string.IsNullOrEmpty(input))
 					return EnumerateLogicalDrives();
@@ -80,7 +80,7 @@ public DirectorySuggest()
 
 				// Find last separator and list directories underneath
 				// with * search-pattern
-				IEnumerable<object> Get()
+				IEnumerable<ViewModels.List.Item> Get()
 				{
 					int sepIdx = input.LastIndexOf('\\');
 
@@ -98,24 +98,23 @@ IEnumerable<object> Get()
 					}
 
 					if (directories == null) return EnumerateLogicalDrives();
-					var dirs = new List<object>();
+					var dirs = new List<ViewModels.List.Item>();
 
 					foreach (var t in directories)
-						dirs.Add(new { Header = t, Value = t });
+						dirs.Add(new ViewModels.List.Item (t, t ));
 
 					return dirs;
 				}
 			}
 
-			static IEnumerable<object> EnumerateDrives(string input)
+			static IEnumerable<ViewModels.List.Item> EnumerateDrives(string input)
 			{
 				if (string.IsNullOrEmpty(input))
 					return EnumerateLogicalDrives();
 
 				return EnumeratePaths(input) ?? EnumerateLogicalDrives();
 
-
-				static IEnumerable<object>? EnumeratePaths(string input) => input.Length switch
+				static IEnumerable<ViewModels.List.Item>? EnumeratePaths(string input) => input.Length switch
 				{
 					1 when char.ToUpper(input[0]) >= 'A' && char.ToUpper(input[0]) <= 'Z' =>
 					EnumerateLogicalDriveOrSubDirs(input + ":\\", input),
@@ -124,19 +123,18 @@ 2 when char.ToUpper(input[1]) == ':' &&
 						   char.ToUpper(input[0]) >= 'A' && char.ToUpper(input[0]) <= 'Z' =>
 					EnumerateLogicalDriveOrSubDirs(input + "\\", input),
 
-					2 => new List<object>(),
+					2 => new List<ViewModels.List.Item>(),
 
 					_ when (char.ToUpper(input[1]) == ':' &&
 							char.ToUpper(input[2]) == '\\' &&
 							char.ToUpper(input[0]) >= 'A' && char.ToUpper(input[0]) <= 'Z') =>
 					// Check if we know this drive and list it with sub-folders if we do
 					EnumerateLogicalDriveOrSubDirs(input, input),
-					_ => new List<object>()
+					_ => new List<ViewModels.List.Item>()
 				};
 			}
 
-
-			static IEnumerable<object> EnumerateLogicalDrives()
+			static IEnumerable<ViewModels.List.Item> EnumerateLogicalDrives()
 			{
 				foreach (var driveName in Environment.GetLogicalDrives()
 					.Where(driveName => string.IsNullOrEmpty(driveName) == false))
@@ -155,29 +153,28 @@ static IEnumerable<object> EnumerateLogicalDrives()
 						header = driveName;
 					}
 
-					yield return new { Header = header, Value = driveName };
+					yield return new ViewModels.List.Item (header, driveName );
 				}
 			}
 
-			static IEnumerable<object>? EnumerateLogicalDriveOrSubDirs(string testDrive, string input)
+			static IEnumerable<ViewModels.List.Item>? EnumerateLogicalDriveOrSubDirs(string testDrive, string input)
 			{
 				return System.IO.Directory.Exists(testDrive) ?
 					GetDirectories(testDrive) is { } array ?
 					GetLogicalDriveOrSubDirs2(testDrive, input, array) :
 					null :
 					null;
 
-
-				static IEnumerable<object>? GetLogicalDriveOrSubDirs2(string testDrive, string input, IEnumerable<string> directories)
+				static IEnumerable<ViewModels.List.Item>? GetLogicalDriveOrSubDirs2(string testDrive, string input, IEnumerable<string> directories)
 				{
 					// List the drive itself if there was only 1 or 2 letters
 					// since this is not a valid drive and we don'nt know if the user
 					// wants to go to the drive or a folder contained in it
 					if (input.Length <= 2)
-						yield return new { Header = testDrive, Value = testDrive };
+						yield return new ViewModels.List.Item(testDrive, testDrive );
 
 					foreach (var item in directories)
-						yield return new { Header = item, Value = item };
+						yield return new ViewModels.List.Item(item, item );
 				}
 
 				static string[]? GetDirectories(string testDrive)

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/ISuggest.cs

@@ -5,11 +5,14 @@
 
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
+	/// <summary>
+	/// Defines an interface to make similarity based suggestions for a given string.
+	/// </summary>
 	public interface ISuggest
 	{
 		/// <summary>
 		/// Makes suggestions based on <see cref="queryThis"/>
 		/// </summary>
-		Task<IEnumerable<object>?> MakeSuggestions(string queryThis);
+		Task<IEnumerable<ViewModels.List.BaseItem>?> MakeSuggestions(string queryThis);
 	}
 }

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/LiteRepository.cs

@@ -7,26 +7,65 @@
 
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
+	/// <summary>
+	/// Implements a static service provider for searching and editing a LiteDB file.
+	/// </summary>
 	public sealed class LiteRepository
 	{
+		#region fields
 		private const string DbPath = @"..\..\..\Data\KeyValue.litedb";
 
 		// Collection needs a name because object, keyvaluepair<string,string> is generic.
 		private const string CollectionName = "collection";
+		#endregion fields
 
-		// Explicit static constructor to tell C# compiler
-		// not to mark type as beforefieldinit
+		#region ctors
+		/// <summary>
+		/// Explicit static constructor to tell C# compiler
+		/// not to mark type as beforefieldinit
+		/// </summary>
 		static LiteRepository()
 		{
 		}
 
+		/// <summary>
+		/// Class constructor
+		/// </summary>
+		private LiteRepository()
+		{
+			Directory.GetParent(DbPath).Create();
+
+			// Id needed to ensure Upsert works.
+			BsonMapper.Global.Entity<KeyValuePair<string, string>>().Id(x => x.Value);
+		}
+		#endregion ctors
+
+		/// <summary>
+		/// Gets the repository instance from this static instance.
+		/// </summary>
+		public static LiteRepository Instance { get; } = new LiteRepository();
+
+		/// <summary>
+		/// Inserts a new string into the collection of bookmarked strings.
+		/// </summary>
+		/// <param name="k"></param>
+		/// <param name="collectionName"></param>
 		public void Insert(string k, string? collectionName = null)
 		{
 			using var db = new LiteDatabase(DbPath);
 			var col = db.GetCollection<KeyValuePair<string, DateTime>>(collectionName ?? CollectionName);
+
+			// Make sure string is not already present
 			col.Upsert(new KeyValuePair<string, DateTime>(k, DateTime.Now));
 		}
 
+		/// <summary>
+		/// Filters the collection of bookmark strings by the given string and
+		/// returns the resulting collection.
+		/// </summary>
+		/// <param name="key"></param>
+		/// <param name="collectionName"></param>
+		/// <returns></returns>
 		public IEnumerable<KeyValuePair<string, DateTime>> Filter(string key, string? collectionName = null)
 		{
 			using var db = new LiteDatabase(DbPath);
@@ -35,17 +74,5 @@ public IEnumerable<KeyValuePair<string, DateTime>> Filter(string key, string? co
 				col.Query().ToArray() :
 				col.Find(Query.Contains(nameof(KeyValuePair<string, DateTime>.Key), key)).ToArray();
 		}
-
-		private LiteRepository()
-		{
-			Directory.GetParent(DbPath).Create();
-
-			// Id needed to ensure Upsert works.
-			BsonMapper.Global.Entity<KeyValuePair<string, string>>()
-				.Id(x => x.Value);
-
-		}
-
-		public static LiteRepository Instance { get; } = new LiteRepository();
 	}
 }

source/Demos/CachedPathSuggestBoxDemo/Infrastructure/PathInformation.cs

@@ -3,8 +3,15 @@
 
 namespace CachedPathSuggestBoxDemo.Infrastructure
 {
+	/// <summary>
+	/// Implements a simple path information object to keep track of its full name and path etc.
+	/// </summary>
 	public class PathInformation : IEquatable<PathInformation>
 	{
+		/// <summary>
+		/// Class constructor
+		/// </summary>
+		/// <param name="argValue"></param>
 		public PathInformation(string argValue)
 		{
 			Name = new DirectoryInfo(argValue).Parent == null ? argValue :
@@ -14,8 +21,14 @@ public PathInformation(string argValue)
 			FullName = argValue;
 		}
 
+		/// <summary>
+		/// Gets the name of a directory (without the path)
+		/// </summary>
 		public string Name { get; }
 
+		/// <summary>
+		/// Gets the full name (including path) for a directory
+		/// </summary>
 		public string FullName { get; }