feat: add samples

jonisavo · May 12, 2022 · f4c0ccf · f4c0ccf
1 parent 14a813d
commit f4c0ccf
Show file tree

Hide file tree

Showing 66 changed files with 99 additions and 109 deletions.
diff --git a/.github/workflows/upm.yml b/.github/workflows/upm.yml
@@ -27,6 +27,10 @@ jobs:
           git config --global user.email '[email protected]'
       - name: Copy meta files to package folder
         run: cp CHANGELOG.md CHANGELOG.md.meta LICENSE.md LICENSE.md.meta README.md README.md.meta "$UICOMPONENTS_PATH"
+      - name: Copy samples to package folder
+        run: |
+          cp -r Assets/Samples/ "$UICOMPONENTS_PATH"/Samples~
+          rm "$UICOMPONENTS_PATH"/Samples~/*.meta
       - name: Create commit for the meta files
         run: |
           git add -A

diff --git a/Assets/AddressableAssetsData/AssetGroups/Default Local Group.asset b/Assets/AddressableAssetsData/AssetGroups/Default Local Group.asset
@@ -25,12 +25,12 @@ MonoBehaviour:
     m_Address: Assets/UIComponents.Tests/Addressables/Assets/Component.uxml
     m_ReadOnly: 0
     m_SerializedLabels: []
-  - m_GUID: 3f5abc4da50c49b8b1d34cf4fa50850a
-    m_Address: Assets/Examples/Addressables/Data/AddressablesExampleComponent.uss
+  - m_GUID: e9bbd2fb164840019750b795061e4bf2
+    m_Address: Assets/Samples/Addressables/Data/AddressablesExampleComponent.uxml
     m_ReadOnly: 0
     m_SerializedLabels: []
-  - m_GUID: e9bbd2fb164840019750b795061e4bf2
-    m_Address: Assets/Examples/Addressables/Data/AddressablesExampleComponent.uxml
+  - m_GUID: 3f5abc4da50c49b8b1d34cf4fa50850a
+    m_Address: Assets/Samples/Addressables/Data/AddressablesExampleComponent.uss
     m_ReadOnly: 0
     m_SerializedLabels: []
   m_ReadOnly: 0

diff --git a/Assets/Examples/Editor.meta b/Assets/Examples/Editor.meta
diff --git a/Assets/Examples/Editor/AssetDatabaseExampleComponentWindow.cs b/Assets/Examples/Editor/AssetDatabaseExampleComponentWindow.cs
diff --git a/Assets/Examples/Editor/AssetDatabaseExampleComponentWindow.cs.meta b/Assets/Examples/Editor/AssetDatabaseExampleComponentWindow.cs.meta
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase.meta b/Assets/Examples/Editor/LoadFromAssetDatabase.meta
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.cs b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.cs
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.cs.meta b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.cs.meta
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uss b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uss
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uss.meta b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uss.meta
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uxml b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uxml
diff --git a/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uxml.meta b/Assets/Examples/Editor/LoadFromAssetDatabase/AssetDatabaseExampleComponent.uxml.meta
diff --git a/Assets/Examples/Editor/UIComponentsExamples.Editor.asmdef.meta b/Assets/Examples/Editor/UIComponentsExamples.Editor.asmdef.meta
diff --git a/Assets/Examples/UIComponentsExamples.asmdef.meta b/Assets/Examples/UIComponentsExamples.asmdef.meta
diff --git a/Assets/Examples.meta → Assets/Samples.meta b/Assets/Examples.meta → Assets/Samples.meta
diff --git a/Assets/Examples/Addressables.meta → Assets/Samples/Addressables.meta b/Assets/Examples/Addressables.meta → Assets/Samples/Addressables.meta
diff --git a/...ressables/AddressablesExampleComponent.cs → ...ressables/AddressablesExampleComponent.cs b/...ressables/AddressablesExampleComponent.cs → ...ressables/AddressablesExampleComponent.cs
@@ -1,9 +1,8 @@
-using UIComponents;
-using UIComponents.Addressables;
+using UIComponents.Addressables;
 
-namespace UIComponentsExamples.Addressables
+namespace UIComponents.Samples.Addressables
 {
-    [AssetPath("Assets/Examples/Addressables/Data")]
+    [AssetPath("Assets/Samples/Addressables/Data")]
     [Layout("AddressablesExampleComponent.uxml")]
     [Stylesheet("AddressablesExampleComponent.uss")]
     [Dependency(typeof(IAssetResolver), provide: typeof(AddressableAssetResolver))]

diff --git a/...bles/AddressablesExampleComponent.cs.meta → ...bles/AddressablesExampleComponent.cs.meta b/...bles/AddressablesExampleComponent.cs.meta → ...bles/AddressablesExampleComponent.cs.meta
diff --git a/Assets/Examples/Addressables/Data.meta → Assets/Samples/Addressables/Data.meta b/Assets/Examples/Addressables/Data.meta → Assets/Samples/Addressables/Data.meta
diff --git a/...les/Data/AddressablesExampleComponent.uss → ...les/Data/AddressablesExampleComponent.uss b/...les/Data/AddressablesExampleComponent.uss → ...les/Data/AddressablesExampleComponent.uss
diff --git a/...ata/AddressablesExampleComponent.uss.meta → ...ata/AddressablesExampleComponent.uss.meta b/...ata/AddressablesExampleComponent.uss.meta → ...ata/AddressablesExampleComponent.uss.meta
diff --git a/...es/Data/AddressablesExampleComponent.uxml → ...es/Data/AddressablesExampleComponent.uxml b/...es/Data/AddressablesExampleComponent.uxml → ...es/Data/AddressablesExampleComponent.uxml
diff --git a/...ta/AddressablesExampleComponent.uxml.meta → ...ta/AddressablesExampleComponent.uxml.meta b/...ta/AddressablesExampleComponent.uxml.meta → ...ta/AddressablesExampleComponent.uxml.meta
diff --git a/Assets/Examples/Addressables/Editor.meta → Assets/Samples/Addressables/Editor.meta b/Assets/Examples/Addressables/Editor.meta → Assets/Samples/Addressables/Editor.meta
diff --git a/...tor/AddressablesExampleComponentWindow.cs → ...tor/AddressablesExampleComponentWindow.cs b/...tor/AddressablesExampleComponentWindow.cs → ...tor/AddressablesExampleComponentWindow.cs
@@ -1,7 +1,7 @@
 using UnityEditor;
 using UnityEngine;
 
-namespace UIComponentsExamples.Addressables.Editor
+namespace UIComponents.Samples.Addressables.Editor
 {
     public class AddressablesExampleComponentWindow : EditorWindow
     {

diff --git a/...ddressablesExampleComponentWindow.cs.meta → ...ddressablesExampleComponentWindow.cs.meta b/...ddressablesExampleComponentWindow.cs.meta → ...ddressablesExampleComponentWindow.cs.meta
diff --git a/...onentsExamples.Addressables.Editor.asmdef → ...onents.Samples.Addressables.Editor.asmdef b/...onentsExamples.Addressables.Editor.asmdef → ...onents.Samples.Addressables.Editor.asmdef
@@ -1,9 +1,8 @@
 {
-    "name": "UIComponentsExamples.Addressables.Editor",
-    "rootNamespace": "UIComponentsExamples",
+    "name": "UIComponents.Samples.Addressables.Editor",
+    "rootNamespace": "UIComponents.Samples",
     "references": [
         "GUID:d593635333b4cae48bac5b5f0b596e90",
-        "GUID:12a73a47a9014699b2fba61bc5f9a0dc",
         "GUID:3784f1f14a0a4923ae912fdf829426a8",
         "GUID:9e24947de15b9834991c9d8411ea37cf",
         "GUID:84651a3751eca9349aac36a66bba901b"

diff --git a/...sExamples.Addressables.Editor.asmdef.meta → ...s.Samples.Addressables.Editor.asmdef.meta b/...sExamples.Addressables.Editor.asmdef.meta → ...s.Samples.Addressables.Editor.asmdef.meta
diff --git a/.../UIComponentsExamples.Addressables.asmdef → .../UIComponents.Samples.Addressables.asmdef b/.../UIComponentsExamples.Addressables.asmdef → .../UIComponents.Samples.Addressables.asmdef
@@ -1,9 +1,8 @@
 {
-    "name": "UIComponentsExamples.Addressables",
-    "rootNamespace": "UIComponentsExamples",
+    "name": "UIComponents.Samples.Addressables",
+    "rootNamespace": "UIComponents.Samples",
     "references": [
         "GUID:d593635333b4cae48bac5b5f0b596e90",
-        "GUID:12a73a47a9014699b2fba61bc5f9a0dc",
         "GUID:9e24947de15b9834991c9d8411ea37cf",
         "GUID:34063fb90481ae5469861eb4a68e5445",
         "GUID:84651a3751eca9349aac36a66bba901b"

diff --git a/...mponentsExamples.Addressables.asmdef.meta → ...mponents.Samples.Addressables.asmdef.meta b/...mponentsExamples.Addressables.asmdef.meta → ...mponents.Samples.Addressables.asmdef.meta
diff --git a/Assets/Examples/Counter.meta → Assets/Samples/Counter.meta b/Assets/Examples/Counter.meta → Assets/Samples/Counter.meta
diff --git a/Assets/Examples/Counter/CounterComponent.cs → Assets/Samples/Counter/CounterComponent.cs b/Assets/Examples/Counter/CounterComponent.cs → Assets/Samples/Counter/CounterComponent.cs
@@ -1,7 +1,6 @@
-using UIComponents;
-using UnityEngine.UIElements;
+using UnityEngine.UIElements;
 
-namespace UIComponentsExamples
+namespace UIComponents.Samples.Counter
 {
     [Dependency(typeof(ICounterService), provide: typeof(CounterService))]
     public class CounterComponent : UIComponent

diff --git a/...Examples/Counter/CounterComponent.cs.meta → .../Samples/Counter/CounterComponent.cs.meta b/...Examples/Counter/CounterComponent.cs.meta → .../Samples/Counter/CounterComponent.cs.meta
diff --git a/Assets/Examples/Counter/CounterService.cs → Assets/Samples/Counter/CounterService.cs b/Assets/Examples/Counter/CounterService.cs → Assets/Samples/Counter/CounterService.cs
@@ -1,4 +1,4 @@
-namespace UIComponentsExamples
+namespace UIComponents.Samples.Counter
 {
     public class CounterService : ICounterService
     {

diff --git a/...s/Examples/Counter/CounterService.cs.meta → ...ts/Samples/Counter/CounterService.cs.meta b/...s/Examples/Counter/CounterService.cs.meta → ...ts/Samples/Counter/CounterService.cs.meta
diff --git a/Assets/Samples/Counter/Editor.meta b/Assets/Samples/Counter/Editor.meta
diff --git a/...Examples/Editor/CounterComponentWindow.cs → .../Counter/Editor/CounterComponentWindow.cs b/...Examples/Editor/CounterComponentWindow.cs → .../Counter/Editor/CounterComponentWindow.cs
@@ -1,7 +1,7 @@
 using UnityEditor;
 using UnityEngine;
 
-namespace UIComponentsExamples.Editor
+namespace UIComponents.Samples.Counter.Editor
 {
     public class CounterComponentWindow : EditorWindow
     {

diff --git a/...les/Editor/CounterComponentWindow.cs.meta → ...ter/Editor/CounterComponentWindow.cs.meta b/...les/Editor/CounterComponentWindow.cs.meta → ...ter/Editor/CounterComponentWindow.cs.meta
diff --git a/...Editor/UIComponentsExamples.Editor.asmdef → ...IComponents.Samples.Counter.Editor.asmdef b/...Editor/UIComponentsExamples.Editor.asmdef → ...IComponents.Samples.Counter.Editor.asmdef
@@ -1,10 +1,9 @@
 {
-    "name": "UIComponentsExamples.Editor",
-    "rootNamespace": "UIComponentsExamples.Editor",
+    "name": "UIComponents.Samples.Counter.Editor",
+    "rootNamespace": "UIComponents.Samples",
     "references": [
         "GUID:d593635333b4cae48bac5b5f0b596e90",
-        "GUID:7282a494dd2226f45a32fcf2256d7c89",
-        "GUID:12a73a47a9014699b2fba61bc5f9a0dc"
+        "GUID:85e613970e1a4b2da36dc72b51d4b4d0"
     ],
     "includePlatforms": [
         "Editor"

diff --git a/Assets/Samples/Counter/Editor/UIComponents.Samples.Counter.Editor.asmdef.meta b/Assets/Samples/Counter/Editor/UIComponents.Samples.Counter.Editor.asmdef.meta
diff --git a/Assets/Examples/Counter/ICounterService.cs → Assets/Samples/Counter/ICounterService.cs b/Assets/Examples/Counter/ICounterService.cs → Assets/Samples/Counter/ICounterService.cs
@@ -1,4 +1,4 @@
-namespace UIComponentsExamples
+namespace UIComponents.Samples.Counter
 {
     public interface ICounterService
     {

diff --git a/.../Examples/Counter/ICounterService.cs.meta → ...s/Samples/Counter/ICounterService.cs.meta b/.../Examples/Counter/ICounterService.cs.meta → ...s/Samples/Counter/ICounterService.cs.meta
diff --git a/Assets/Examples/UIComponentsExamples.asmdef → ...unter/UIComponents.Samples.Counter.asmdef b/Assets/Examples/UIComponentsExamples.asmdef → ...unter/UIComponents.Samples.Counter.asmdef
@@ -1,6 +1,6 @@
 {
-    "name": "UIComponentsExamples",
-    "rootNamespace": "UIComponentsExamples",
+    "name": "UIComponents.Samples.Counter",
+    "rootNamespace": "UIComponents.Samples",
     "references": [
         "GUID:d593635333b4cae48bac5b5f0b596e90"
     ],

diff --git a/Assets/Samples/Counter/UIComponents.Samples.Counter.asmdef.meta b/Assets/Samples/Counter/UIComponents.Samples.Counter.asmdef.meta
diff --git a/Assets/Examples/Counter/counter.gif → Assets/Samples/Counter/counter.gif b/Assets/Examples/Counter/counter.gif → Assets/Samples/Counter/counter.gif
diff --git a/Assets/Examples/Counter/counter.gif.meta → Assets/Samples/Counter/counter.gif.meta b/Assets/Examples/Counter/counter.gif.meta → Assets/Samples/Counter/counter.gif.meta
diff --git a/Assets/Examples/LoadFromResources.meta → Assets/Samples/Resources.meta b/Assets/Examples/LoadFromResources.meta → Assets/Samples/Resources.meta
diff --git a/Assets/Samples/Resources/Editor.meta b/Assets/Samples/Resources/Editor.meta
diff --git a/...Editor/ResourcesExampleComponentWindow.cs → ...Editor/ResourcesExampleComponentWindow.cs b/...Editor/ResourcesExampleComponentWindow.cs → ...Editor/ResourcesExampleComponentWindow.cs
@@ -1,7 +1,7 @@
 using UnityEditor;
 using UnityEngine;
 
-namespace UIComponentsExamples.Editor
+namespace UIComponents.Samples.Resources.Editor
 {
     public class ResourcesExampleComponentWindow : EditorWindow
     {

diff --git a/...r/ResourcesExampleComponentWindow.cs.meta → ...r/ResourcesExampleComponentWindow.cs.meta b/...r/ResourcesExampleComponentWindow.cs.meta → ...r/ResourcesExampleComponentWindow.cs.meta
diff --git a/Assets/Samples/Resources/Editor/UIComponents.Samples.Resources.Editor.asmdef b/Assets/Samples/Resources/Editor/UIComponents.Samples.Resources.Editor.asmdef
@@ -0,0 +1,19 @@
+{
+    "name": "UIComponents.Samples.Resources.Editor",
+    "rootNamespace": "UIComponents.Samples",
+    "references": [
+        "GUID:d593635333b4cae48bac5b5f0b596e90",
+        "GUID:af36ccbbcbfb40b09be04c65626bd552"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}
diff --git a/Assets/Samples/Resources/Editor/UIComponents.Samples.Resources.Editor.asmdef.meta b/Assets/Samples/Resources/Editor/UIComponents.Samples.Resources.Editor.asmdef.meta
diff --git a/...Examples/LoadFromResources/Resources.meta → Assets/Samples/Resources/Resources.meta b/...Examples/LoadFromResources/Resources.meta → Assets/Samples/Resources/Resources.meta
diff --git a/...adFromResources/Resources/Components.meta → ...mples/Resources/Resources/Components.meta b/...adFromResources/Resources/Components.meta → ...mples/Resources/Resources/Components.meta
diff --git a/...nents/ResourcesExampleComponent.style.uss → ...nents/ResourcesExampleComponent.style.uss b/...nents/ResourcesExampleComponent.style.uss → ...nents/ResourcesExampleComponent.style.uss
diff --git a/.../ResourcesExampleComponent.style.uss.meta → .../ResourcesExampleComponent.style.uss.meta b/.../ResourcesExampleComponent.style.uss.meta → .../ResourcesExampleComponent.style.uss.meta
diff --git a/...Components/ResourcesExampleComponent.uxml → ...Components/ResourcesExampleComponent.uxml b/...Components/ResourcesExampleComponent.uxml → ...Components/ResourcesExampleComponent.uxml
diff --git a/...nents/ResourcesExampleComponent.uxml.meta → ...nents/ResourcesExampleComponent.uxml.meta b/...nents/ResourcesExampleComponent.uxml.meta → ...nents/ResourcesExampleComponent.uxml.meta
diff --git a/...s/LoadFromResources/Resources/Margins.uss → ...s/Samples/Resources/Resources/Margins.uss b/...s/LoadFromResources/Resources/Margins.uss → ...s/Samples/Resources/Resources/Margins.uss
diff --git a/...dFromResources/Resources/Margins.uss.meta → ...ples/Resources/Resources/Margins.uss.meta b/...dFromResources/Resources/Margins.uss.meta → ...ples/Resources/Resources/Margins.uss.meta
diff --git a/...romResources/ResourcesExampleComponent.cs → ...es/Resources/ResourcesExampleComponent.cs b/...romResources/ResourcesExampleComponent.cs → ...es/Resources/ResourcesExampleComponent.cs
@@ -1,6 +1,4 @@
-using UIComponents;
-
-namespace UIComponentsExamples
+namespace UIComponents.Samples.Resources
 {
     /// <summary>
     /// Assets are loaded from Resources by default.

diff --git a/...sources/ResourcesExampleComponent.cs.meta → ...sources/ResourcesExampleComponent.cs.meta b/...sources/ResourcesExampleComponent.cs.meta → ...sources/ResourcesExampleComponent.cs.meta
diff --git a/Assets/Samples/Resources/UIComponents.Samples.Resources.asmdef b/Assets/Samples/Resources/UIComponents.Samples.Resources.asmdef
@@ -0,0 +1,16 @@
+{
+    "name": "UIComponents.Samples.Resources",
+    "rootNamespace": "UIComponents.Samples",
+    "references": [
+        "GUID:d593635333b4cae48bac5b5f0b596e90"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}
diff --git a/Assets/Samples/Resources/UIComponents.Samples.Resources.asmdef.meta b/Assets/Samples/Resources/UIComponents.Samples.Resources.asmdef.meta
diff --git a/Assets/UIComponents/package.json b/Assets/UIComponents/package.json
@@ -15,6 +15,23 @@
         "uielements",
         "library"
     ],
+    "samples": [
+        {
+            "displayName": "CounterComponent (Dependency injection)",
+            "description": "Contains an example of simple dependency injection.",
+            "path": "Samples~/Counter"
+        },
+        {
+            "displayName": "Asset Loading from Resources",
+            "description": "Contains an example of asset loading from Resources.",
+            "path": "Samples~/Resources"
+        },
+        {
+            "displayName": "Asset Loading from Addressables",
+            "description": "Contains an example of asset loading from Addressables.",
+            "path": "Samples~/Addressables"
+        }
+    ],
     "license": "MIT",
     "changelogUrl": "https://github.com/jonisavo/uicomponents/blob/main/CHANGELOG.md",
     "documentationUrl": "https://github.com/jonisavo/uicomponents/blob/main/README.md",

diff --git a/README.md b/README.md
@@ -169,7 +169,7 @@ This creates a component which can be used to increment a number.
 **Each instance of CounterComponent receives the same instance of
 CounterService.**
 
-![CounterComponent in action](https://github.com/jonisavo/uicomponents/blob/main/Assets/Examples/Counter/counter.gif?raw=true)
+![CounterComponent in action](https://github.com/jonisavo/uicomponents/blob/main/Assets/Samples/Counter/counter.gif?raw=true)
 
 ### Get dependency safely