{"id":13663157,"url":"https://github.com/coryleach/UnityGUI","last_synced_at":"2025-04-25T13:31:54.250Z","repository":{"id":66503800,"uuid":"217923520","full_name":"coryleach/UnityGUI","owner":"coryleach","description":"UGUI Panel Systems for navigation, animation and more","archived":false,"fork":false,"pushed_at":"2023-09-20T06:51:33.000Z","size":676,"stargazers_count":236,"open_issues_count":1,"forks_count":20,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-10T02:54:04.243Z","etag":null,"topics":["effects","gui","package","panel","panelview","stack","transitions","ugui","ui","unity","unity3d"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coryleach.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-27T22:12:50.000Z","updated_at":"2025-03-15T06:26:47.000Z","dependencies_parsed_at":"2024-01-14T01:50:06.776Z","dependency_job_id":null,"html_url":"https://github.com/coryleach/UnityGUI","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryleach%2FUnityGUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryleach%2FUnityGUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryleach%2FUnityGUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryleach%2FUnityGUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coryleach","download_url":"https://codeload.github.com/coryleach/UnityGUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250824999,"owners_count":21493376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["effects","gui","package","panel","panelview","stack","transitions","ugui","ui","unity","unity3d"],"created_at":"2024-08-02T05:02:19.446Z","updated_at":"2025-04-25T13:31:49.204Z","avatar_url":"https://github.com/coryleach.png","language":"C#","readme":"\u003cp align=\"center\"\u003e\n\u003cimg align=\"center\" src=\"https://raw.githubusercontent.com/coryleach/UnityPackages/master/Documentation/GameframeFace.gif\" /\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eGameframe.GUI 👋\u003c/h1\u003e\n\n\u003c!-- BADGE-START --\u003e\n\u003cp\u003e\n\u003cimg alt=\"Version\" src=\"https://img.shields.io/badge/version-3.0.6-blue.svg?cacheSeconds=2592000\" /\u003e\n  \u003ca href=\"https://twitter.com/Cory Leach\"\u003e\n    \u003cimg alt=\"Twitter: coryleach\" src=\"https://img.shields.io/twitter/follow/coryleach.svg?style=social\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003c/p\u003e\n\u003c!-- BADGE-END --\u003e\n\nThis is a library of GUI helpers for UGUI    \nIncludes a panel system that implements a navigation stack.    \nIncludes a scene transition system.    \nIncludes a SRP shader for blurring the background of UI panels.\n\n## Quick Package Install\n\n#### Using UnityPackageManager (for Unity 2019.3 or later)\nOpen the package manager window (menu: Window \u003e Package Manager)\u003cbr/\u003e\nSelect \"Add package from git URL...\", fill in the pop-up with the following link:\u003cbr/\u003e\nhttps://github.com/coryleach/UnityGUI.git#3.0.12\u003cbr/\u003e\n\n#### Using UnityPackageManager (for Unity 2019.1 or later)\n\nFind the manifest.json file in the Packages folder of your project and edit it to look like this:\n```js\n{\n  \"dependencies\": {\n    \"com.gameframe.gui\": \"https://github.com/coryleach/UnityGUI.git#3.0.12\",\n    ...\n  },\n}\n```\n\n\u003c!-- DOC-START --\u003e\n\u003c!--\nChanges between 'DOC START' and 'DOC END' will not be modified by readme update scripts\n--\u003e\n\n## Usage\n\nAfter importing this package via the PackageManager import the Demo/Demo.unitypackage file from the Assets-\u003eImport Package option in the menu.\n\n### PanelView\nPanelView which provides Show \u0026 Hide behavior which can be instant or async and awaitable.\n\n### AnimatedPanelView\nReferences one or more IPanelAnimator components to control animate the Show \u0026 Hide of a panel. If you await the Show \u0026 Hide async methods\n\n### PanelViewController\nController for the display of a PanelView.\n\n### PanelViewControllerBehaviour\nA version of PanelViewController that is also a MonoBehaviour component that can be added to a game object.\nOften you may want to set up \u0026 configure PanelViewControllers with data other than the panel type and using this class will allow you to do that in editor.\n\n### PanelStackSystem\nA scriptable object representation of a panel stack. Main purpose is in maintaining the navigation history of a menu. Push and Pop panel controllers onto this stack. If any PanelViewStackController component that subscribes to the PanelStackSystem will respond to the push and show/hide the corresponding panels. Generally the top PanelViewController on the stack is always visible.\n\n### PanelViewStackController\nA MonoBehaviour that references a PanelStackSystem. It responds to changes in the panel stack by getting the current showing and hiding controllers. It will then perform the necessary transitions.\n\n### PanelViewControllerProvider\nA scriptable object which services is a collection of PanelViewControllers. Generally you register PanelViewControllerBehaviour with a provider so that you can push them using the PanelPusher component. It also controls the location that views are parented to in the hierarchy.\n\n### PanelViewControllerRegisterer\nAdd this component to a PanelViewControllerBehaviour to register the controller with a PanelViewControllerProvider instance.\n\n### PanelType\nContains information about a panel and is used by the PanelViewController to locate the prefab and instantiate the PanelView.\n\n\u003c!-- DOC-END --\u003e\n\n## Author\n\n👤 **Cory Leach**\n\n* Twitter: [@coryleach](https://twitter.com/coryleach)\n* Github: [@coryleach](https://github.com/coryleach)\n\n\n## Show your support\nGive a ⭐️ if this project helped you!\n\n\n***\n_This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_\n","funding_links":[],"categories":["Open Source Repositories","GamePlay","C\\#","Open Source Packages"],"sub_categories":["UI","Skill"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoryleach%2FUnityGUI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoryleach%2FUnityGUI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoryleach%2FUnityGUI/lists"}