Merge branch 'unite2025/lsp-uitk' into unite2025/screen-reader-improvements

Bianca Marina Stana · Bianca Marina Stana · commit de9390026f2e · 2025-10-03T21:27:30.000-04:00
diff --git a/Assets/Resources/UITk/MainView.uxml b/Assets/Resources/UITk/MainView.uxml
@@ -3,7 +3,7 @@
     <ui:VisualElement name="root" style="flex-grow: 1;">
         <ui:VisualElement name="background" style="flex-grow: 1; position: absolute; top: 0; left: 0; bottom: 0; right: 0; background-color: rgb(11, 163, 109);"/>
         <ui:VisualElement name="viewContainer" style="flex-grow: 1;">
-            <Unity.Samples.LetterSpell.StackView name="stackView" index="0" style="flex-grow: 1;">
+            <Unity.Samples.LetterSpell.StackView name="stackView" index="4" style="flex-grow: 1;">
                 <ui:VisualElement name="splashView" style="flex-grow: 1; background-image: url(&quot;project://database/Assets/UI/Images/Splash-Screen.png?fileID=4602334432413793429&amp;guid=364b68ded9ed04f07848b6c7de25fdad&amp;type=3#Intro Screen_0&quot;);">
                     <ui:Label text="A fun spelling game" name="splashSubTitle">
                         <Bindings>
@@ -90,7 +90,7 @@
                             </Bindings>
                         </ui:Button>
                     </ui:VisualElement>
-                    <ui:ScrollView name="ScrollView" vertical-scroller-visibility="Hidden">
+                    <ui:ScrollView name="settingsScrollView" vertical-scroller-visibility="Hidden">
                         <ui:TextField placeholder-text="Search Options" name="settingsSearchField">
                             <Bindings>
                                 <UnityEngine.Localization.LocalizedString property="placeholderText" table="GUID:cc1d194facb1d9d4380a9ea2032c10ca" entry="Id(2876929896448)"/>
diff --git a/Assets/Resources/UITk/Themes/LetterSpellTheme.uss b/Assets/Resources/UITk/Themes/LetterSpellTheme.uss
@@ -467,29 +467,33 @@
     background-color: rgb(116, 45, 243);
 }
 
-.lsp-dir-ltr .lsp-button-strip-field__button--left {
-    margin-right: 0;
+.lsp-button-strip-field__button--left {
+    border-radius: 30px;
+    border-width: 10px;
     border-right-width: 5px;
     border-top-right-radius: 0;
     border-bottom-right-radius: 0;
 }
 
 .lsp-dir-rtl .lsp-button-strip-field__button--left{
-    margin-left: 0;
+    border-radius: 30px;
+    border-width: 10px;
     border-left-width: 5px;
     border-top-left-radius: 0;
     border-bottom-left-radius: 0;
 }
 
-.lsp-dir-ltr .lsp-button-strip-field__button--right {
+.lsp-button-strip-field__button--right {
+    border-radius: 30px;
+    border-width: 10px;
     border-top-left-radius: 0;
     border-bottom-left-radius: 0;
     border-left-width: 5px;
-    margin-left: 0;
 }
 
 .lsp-dir-rtl .lsp-button-strip-field__button--right {
-    margin-right: 0;
+    border-radius: 30px;
+    border-width: 10px;
     border-right-width: 5px;
     border-top-right-radius: 0;
     border-bottom-right-radius: 0;
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/BasePopupFieldHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/BasePopupFieldHandler.cs
@@ -0,0 +1,141 @@
+using Unity.Samples.LetterSpell;
+using UnityEngine.Accessibility;
+using UnityEngine.Localization.Settings;
+using UnityEngine.Scripting;
+using UnityEngine.UIElements;
+
+namespace Unity.Samples.ScreenReader
+{
+    [Preserve]
+    class BasePopupFieldHandler<TValue, TValueChoice> : BaseFieldHandler<TValue>
+    {
+        bool m_HasPendingCheck;
+
+        public BasePopupFieldHandler()
+        {
+            /*OnSelect += () =>
+            {
+                ownerElement.schedule.Execute(CheckForOpenedPopupMenu).ExecuteLater(200);
+
+               using var evt = NavigationSubmitEvent.GetPooled();
+                ownerElement.SendEvent(evt);
+                OnScreenDebug.Log("Submit event sent to " + ownerElement.name);
+
+                return false;//true;
+            };*/
+        }
+
+        public override string GetHint()
+        {
+            return LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "DROPDOWN_CLOSED_HINT");
+        }
+
+#if UNITY_6000_3_OR_NEWER
+        public override AccessibilityRole GetRole() => AccessibilityRole.Dropdown;
+#endif // UNITY_6000_3_OR_NEWER
+
+        protected override void BindToElement(VisualElement element)
+        {
+            base.BindToElement(element);
+            element.RegisterCallback<PointerDownEvent>(OnPointerDown);
+            element.RegisterCallback<NavigationSubmitEvent>(OnNavigationSubmit);
+        }
+
+        protected override void UnbindFromElement(VisualElement element)
+        {
+            element.UnregisterCallback<PointerDownEvent>(OnPointerDown);
+            element.UnregisterCallback<NavigationSubmitEvent>(OnNavigationSubmit);
+            base.UnbindFromElement(element);
+        }
+
+        void OnNavigationSubmit(NavigationSubmitEvent evt)
+        {
+            OnScreenDebug.Log("Submit event received by " + ownerElement.name);
+            ScheduledCheckForOpenedPopupMenu();
+        }
+
+        void OnPointerDown(PointerDownEvent evt)
+        {
+            OnScreenDebug.Log("Pointer Down event " + ownerElement.name);
+
+            ScheduledCheckForOpenedPopupMenu();
+        }
+
+        void ScheduledCheckForOpenedPopupMenu()
+        {
+            if (m_HasPendingCheck)
+            {
+                return;
+            }
+
+            m_HasPendingCheck = true;
+            ownerElement.schedule.Execute(() =>
+            {
+                m_HasPendingCheck = false;
+                CheckForOpenedPopupMenu();
+            }).ExecuteLater(300);
+        }
+
+        void CheckForOpenedPopupMenu()
+        {
+            var panel = ownerElement.panel;
+
+            if (panel == null)
+            {
+                return;
+            }
+
+            var panelRootVisualElement = panel.visualTree;
+            var popupMenu = panelRootVisualElement.Q(classes: GenericDropdownMenu.ussClassName);
+
+            OnScreenDebug.Log("Showing popup menu: " + (popupMenu != null));
+
+            if (popupMenu != null)
+            {
+                var popupAcc = popupMenu.GetOrCreateAccessibleProperties();
+
+#if UNITY_6000_3_OR_NEWER
+                popupAcc.role = AccessibilityRole.Dropdown;
+#endif // UNITY_6000_3_OR_NEWER
+                popupAcc.active = false;
+                popupAcc.modal = true;
+
+                // Setup items in the popup menu
+                var items = popupMenu.Query(classes: GenericDropdownMenu.itemUssClassName).ToList();
+                var i = 0;
+
+                OnScreenDebug.Log("Item count : " + items.Count);
+                foreach (var item in items)
+                {
+                   // if (item.GetAccessibleProperties() != null)
+                   //     continue;
+
+                    var itemAcc = item.GetOrCreateAccessibleProperties();
+                    var itemLabel = item.Q<Label>();
+
+                    itemAcc.label = itemLabel != null ? itemLabel.text : $"Item {i}";
+                    itemAcc.role = AccessibilityRole.Button;
+                    itemLabel.GetOrCreateAccessibleProperties().ignored = true;
+                    i++;
+                }
+
+                // NotifyChange();
+            }
+
+            /*
+ #if UNITY_6000_3_OR_NEWER
+            var popup = ve.Q("unity-popup");
+
+            if (popup != null && popup.style.display == DisplayStyle.Flex)
+            {
+                SetState(AccessibilityState.Expanded);
+            }
+            else
+            {
+                SetState(AccessibilityState.Collapsed);
+            }
+#endif // UNITY_6000_3_OR_NEWER
+            */
+        }
+    }
+}
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/BasePopupFieldHandler.cs.meta b/Assets/Scripts/Screen Reader/UITk/Handlers/BasePopupFieldHandler.cs.meta
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/ButtonHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/ButtonHandler.cs
@@ -29,10 +29,10 @@ public override string GetLabel()
             return (ownerElement as Button)?.text;
         }
 
+        public override AccessibilityRole GetRole() => AccessibilityRole.Button;
+
         protected override void BindToElement(VisualElement ve)
         {
         }
-
-        public override AccessibilityRole GetRole() => AccessibilityRole.Button;
     }
 }
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/DropdownFieldHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/DropdownFieldHandler.cs
@@ -30,6 +30,10 @@ public override string GetHint()
             return LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "DROPDOWN_CLOSED_HINT");
         }
 
+#if UNITY_6000_3_OR_NEWER
+        public override AccessibilityRole GetRole() => AccessibilityRole.Dropdown;
+#endif // UNITY_6000_3_OR_NEWER
+
         protected override void BindToElement(VisualElement element)
         {
             base.BindToElement(element);
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/LabelHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/LabelHandler.cs
@@ -7,11 +7,11 @@ namespace Unity.Samples.ScreenReader
     [Preserve]
     class LabelHandler : VisualElementAccessibilityHandler
     {
-        public override AccessibilityRole GetRole() => AccessibilityRole.StaticText;
-
         public override string GetLabel()
         {
             return (ownerElement as Label)?.text;
         }
+
+        public override AccessibilityRole GetRole() => AccessibilityRole.StaticText;
     }
 }
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/ScrollViewHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/ScrollViewHandler.cs
@@ -1,4 +1,5 @@
 using UnityEngine;
+using UnityEngine.Accessibility;
 using UnityEngine.Scripting;
 using UnityEngine.UIElements;
 
@@ -7,6 +8,10 @@ namespace Unity.Samples.ScreenReader
     [Preserve]
     public class ScrollViewHandler : VisualElementAccessibilityHandler
     {
+#if UNITY_6000_3_OR_NEWER
+        public override AccessibilityRole GetRole() => AccessibilityRole.ScrollView;
+#endif // UNITY_6000_3_OR_NEWER
+
         protected override void BindToElement(VisualElement ve)
         {
             var scrollView = ve as ScrollView;
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/TabViewHandler.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/TabViewHandler.cs
@@ -1,3 +1,4 @@
+using UnityEngine.Accessibility;
 using UnityEngine.UIElements;
 
 namespace Unity.Samples.ScreenReader
@@ -25,6 +26,10 @@ public override string GetLabel()
         {
             return m_Tab.label;
         }
+
+#if UNITY_6000_3_OR_NEWER
+        public override AccessibilityRole GetRole() => AccessibilityRole.TabButton;
+#endif // UNITY_6000_3_OR_NEWER
     }
 
     class TabHandlerCreator : VisualElementAccessibilityHandlerFactory.ICreator
diff --git a/Assets/Scripts/Screen Reader/UITk/Handlers/VisualElementAccessibilityHandlerFactory.cs b/Assets/Scripts/Screen Reader/UITk/Handlers/VisualElementAccessibilityHandlerFactory.cs
@@ -186,8 +186,9 @@ public static void RegisterBuiltinAccessibleElementFactories()
             RegisterFactory<Button, ButtonHandler>();
             RegisterGenericFactory(typeof(BaseField<>), typeof(BaseFieldHandler<>));
             RegisterGenericFactory(typeof(BaseSlider<>), typeof(BaseSliderHandler<>));
+            RegisterGenericFactory(typeof(BasePopupField<,>), typeof(BasePopupFieldHandler<,>));
             RegisterFactory<TextField, TextFieldFieldHandler>();
-            RegisterFactory<DropdownField, DropdownFieldHandler>();
+            //RegisterFactory<DropdownField, DropdownFieldHandler>();
             RegisterFactory<ListView, ListViewHandler>();
             RegisterFactory<ScrollView, ScrollViewHandler>();
             RegisterFactory(new ListViewItemHandlerCreator());
diff --git a/Assets/Scripts/UITk/MainView.cs b/Assets/Scripts/UITk/MainView.cs
@@ -220,6 +220,7 @@ class MainView : MonoBehaviour
         Button m_CloseSettingsButton;
         Button m_SettingsButton;
         Button m_InGameSettingsButton;
+        private TextField m_SearchField;
         VisualElement m_LastView;
         LetterCardListModel m_Model = new();
         
@@ -415,6 +416,14 @@ void SetupUI()
 
             m_SettingsView = m_StackView.Q("settingsView");
             m_SettingsView.dataSource = m_PlayerSettings;
+            
+            var settingsScrollView = m_SettingsView.Q<ScrollView>("settingsScrollView");
+            settingsScrollView.GetOrCreateAccessibleProperties().label = "Settings Scroll View";
+            
+            m_SearchField = m_SettingsView.Q<TextField>("settingsSearchField");
+            m_SearchField.GetOrCreateAccessibleProperties().label = "Search";
+            m_SearchField.GetOrCreateAccessibleProperties().role = AccessibilityRole.SearchField;
+            m_SearchField.RegisterValueChangedCallback((e) => UpdateSearchField());
 
             // m_SettingsPopup = new PopupWindow();
             // m_SettingsPopup.content = m_SettingsView;
@@ -607,6 +616,35 @@ public void PauseGame()
             Gameplay.instance.PauseGame();
         }
 
+        void UpdateSearchField()
+        {
+            var searchText = m_SearchField.text.Trim().ToLowerInvariant();
+
+            foreach (var field in m_SettingsView.Query<Label>(className: "unity-base-field__label").ToList())
+            {
+                if (string.IsNullOrEmpty(searchText))
+                {
+                    field.parent.style.display = DisplayStyle.Flex;
+                    continue;
+                }
+
+                var label = field.Q<Label>();
+                
+                if (label != null && label.text.ToLowerInvariant().Contains(searchText))
+                {
+                    field.parent.style.display = DisplayStyle.Flex;
+                }
+                else
+                {
+                    field.parent.style.display = DisplayStyle.None;
+                }
+            }
+
+            // Refresh the hierarchy to ensure the screen reader is aware of the changes.
+            //AccessibilityManager.GetService<UITkAccessibilityService>()?.RebuildHierarchy();
+            //m_WasHierarchyRefreshed = true;
+        }
+
         /// <summary>
         /// Regenerates all the letter cards.
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,10 @@ public override string GetLabel()`
`29`	`29`	`return (ownerElement as Button)?.text;`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ public override AccessibilityRole GetRole() => AccessibilityRole.Button;`
	`33`	`+`
`32`	`34`	`protected override void BindToElement(VisualElement ve)`
`33`	`35`	`{`
`34`	`36`	`}`
`35`		`-`
`36`		`- public override AccessibilityRole GetRole() => AccessibilityRole.Button;`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,10 @@ public override string GetHint()`
`30`	`30`	`return LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "DROPDOWN_CLOSED_HINT");`
`31`	`31`	`}`
`32`	`32`
	`33`	`+#if UNITY_6000_3_OR_NEWER`
	`34`	`+ public override AccessibilityRole GetRole() => AccessibilityRole.Dropdown;`
	`35`	`+#endif // UNITY_6000_3_OR_NEWER`
	`36`	`+`
`33`	`37`	`protected override void BindToElement(VisualElement element)`
`34`	`38`	`{`
`35`	`39`	`base.BindToElement(element);`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@ namespace Unity.Samples.ScreenReader`
`7`	`7`	`[Preserve]`
`8`	`8`	`class LabelHandler : VisualElementAccessibilityHandler`
`9`	`9`	`{`
`10`		`- public override AccessibilityRole GetRole() => AccessibilityRole.StaticText;`
`11`		`-`
`12`	`10`	`public override string GetLabel()`
`13`	`11`	`{`
`14`	`12`	`return (ownerElement as Label)?.text;`
`15`	`13`	`}`
	`14`	`+`
	`15`	`+ public override AccessibilityRole GetRole() => AccessibilityRole.StaticText;`
`16`	`16`	`}`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using UnityEngine.Accessibility;`
`1`	`2`	`using UnityEngine.UIElements;`
`2`	`3`
`3`	`4`	`namespace Unity.Samples.ScreenReader`
`@@ -25,6 +26,10 @@ public override string GetLabel()`
`25`	`26`	`{`
`26`	`27`	`return m_Tab.label;`
`27`	`28`	`}`
	`29`	`+`
	`30`	`+#if UNITY_6000_3_OR_NEWER`
	`31`	`+ public override AccessibilityRole GetRole() => AccessibilityRole.TabButton;`
	`32`	`+#endif // UNITY_6000_3_OR_NEWER`
`28`	`33`	`}`
`29`	`34`
`30`	`35`	`class TabHandlerCreator : VisualElementAccessibilityHandlerFactory.ICreator`