Merge pull request #23 from CoderGamester/develop

Release 0.13.1

Author: CoderGamester

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [0.13.1] - 2025-09-28
+
+**New**:
+- Added *UiToolkitPresenter<Data>* script to allow UI Toolkit based UIs to work similar to *UiPresenter<Data>*
+
+**Changed**:
+- Refactored *UiToolkitPresenter* to also pass the root visual element to it's implemented class and properly assign the element OnValidate
+
 ## [0.13.0] - 2025-09-25
 
 **New**:

Runtime/UiService.cs

@@ -252,16 +252,26 @@ public async UniTask<UiPresenter> OpenUiAsync(Type type)
 		public async UniTask<UiPresenter> OpenUiAsync<TData>(Type type, TData initialData) where TData : struct
 		{
 			var ui = await GetOrLoadUiAsync(type);
-			var uiPresenter = ui as UiPresenter<TData>;
-			
-			if (uiPresenter == null)
+
+			if (ui is UiToolkitPresenter<TData>)
+			{
+				var uiPresenter = ui as UiToolkitPresenter<TData>;
+				
+				uiPresenter.InternalSetData(initialData);
+			}
+			else if (ui is UiPresenter<TData>)
 			{
-				Debug.LogError($"The UiPresenter {type} is not a UiPresenter<TData> type you. " +
+				var uiPresenter = ui as UiPresenter<TData>;
+				
+				uiPresenter.InternalSetData(initialData);
+			}
+			else
+			{
+				Debug.LogError($"The UiPresenter {type} is not a {nameof(UiPresenter<TData>)} nor {nameof(UiToolkitPresenter<TData>)} type. " +
 				               $"Implement it to allow it to open with initial defined data");
 				return ui;
 			}
-
-			uiPresenter.InternalSetData(initialData);
+			
 			OpenUi(type);
 
 			return ui;

Runtime/UiToolkitPresenter.cs

@@ -3,10 +3,10 @@
 
 namespace GameLovers.UiService
 {
-	/// <summary>
-	/// Interface for UI Toolkit-based presenters.
-	/// </summary>
-	public interface IUiPresenter
+	/// /// <summary>
+	/// Tags the <see cref="UiToolkitPresenter"/> as a <see cref="UiToolkitPresenterData{T}"/> to allow defining a
+	/// specific state when opening the UI via the <see cref="UiService"/>
+	public interface IUiToolkitPresenterData : IUiPresenterData
 	{
 	}
 
@@ -15,21 +15,50 @@ public interface IUiPresenter
 	/// and provides derived presenters access to it.
 	/// </summary>
 	[RequireComponent(typeof(UIDocument))]
-	public abstract class UiToolkitPresenter : UiPresenter, IUiPresenter
+	public abstract class UiToolkitPresenter : UiPresenter
 	{
 		[SerializeField] private UIDocument _document;
 
 		/// <summary>
 		/// Provides access to the attached <see cref="UIDocument"/> for derived presenters.
 		/// </summary>
 		protected UIDocument Document => _document;
+		
+		/// <summary>
+		/// The root element of the <see cref="UIDocument"/> defining this presenter
+		/// </summary>
+		protected VisualElement Root => _document.rootVisualElement;
 
 		/// <summary>
 		/// Assigns the serialized <see cref="UIDocument"/> reference from the component on this GameObject.
 		/// </summary>
 		protected virtual void OnValidate()
 		{
-			_document = GetComponent<UIDocument>();
+			_document = _document == null ? GetComponent<UIDocument>() : _document;
+		}
+	}
+	
+	/// <inheritdoc cref="UiToolkitPresenter"/>
+	/// <remarks>
+	/// Extends the <see cref="UiToolkitPresenter"/> behaviour to hold data of type <typeparamref name="T"/>
+	/// </remarks>
+	public abstract class UiToolkitPresenter<T> : UiToolkitPresenter, IUiToolkitPresenterData where T : struct
+	{
+		/// <summary>
+		/// The Ui data defined when opened via the <see cref="UiService"/>
+		/// </summary>
+		public T Data { get; protected set; }
+
+		/// <summary>
+		/// Allows the ui presenter implementation to have extra behaviour when the data defined for the presenter is set
+		/// </summary>
+		protected virtual void OnSetData() {}
+
+		internal void InternalSetData(T data)
+		{
+			Data = data;
+
+			OnSetData();
 		}
 	}
 }

package.json

@@ -2,7 +2,7 @@
   "name": "com.gamelovers.uiservice",
   "displayName": "UiService",
   "author": "Miguel Tomas",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "unity": "6000.0",
   "license": "MIT",
   "description": "This package provides a service to help manage an Unity's, game UI.\nIt allows to open, close, load, unload and request any Ui Configured in the game.\nThe package provides a Ui Set that allows to group a set of Ui Presenters to help load, open and close multiple Uis at the same time.\n\nTo help configure the game's UI you need to create a UiConfigs Scriptable object by:\n- Right Click on the Project View > Create > ScriptableObjects > Configs > UiConfigs",