Gameframe.GUI 👋

[![Codacy Badge](https://camo.githubusercontent.com/69b937fd57debbf0eeb1b3a2cc130e651de5cf1ce285c786b63896fde49274ce/68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3332356564323131646636643432623938306237636462633961666535656237)](https://www.codacy.com/manual/coryleach/UnityGUI?utm_source=github.com&utm_medium=referral&utm_content=coryleach/UnityGUI&utm_campaign=Badge_Grade) ![GitHub release (latest by date including pre-releases)](https://camo.githubusercontent.com/0875152d46554a68181b7315c8bbe2eae313b8407da9a509229687970c8fb3c7/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f636f72796c656163682f556e6974794775693f696e636c7564655f70726572656c6561736573) [![openupm](https://camo.githubusercontent.com/21e1363ff2202589613fa7af2e8c2a286b6ba6389d0cff4be759e7cd7b5fbcaf/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f636f6d2e67616d656672616d652e6775693f6c6162656c3d6f70656e75706d2672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d)](https://openupm.com/packages/com.gameframe.gui/) [![license](https://camo.githubusercontent.com/995d838758318257b26fb3989b48423c826da3fa95ec73ababf36b2873f9e34b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f636f72796c656163682f556e697479477569)](https://github.com/coryleach/UnityGui/raw/master/LICENSE) This is a library of GUI helpers for UGUI Includes a panel system that implements a navigation stack. Includes a scene transition system. Includes a shader for blurring the background of UI panels. ## Quick Package Install #### Using UnityPackageManager (for Unity 2019.3 or later) Open the package manager window (menu: Window > Package Manager)
Select "Add package from git URL...", fill in the pop-up with the following link:
https://github.com/coryleach/UnityGUI.git#2.0.0
#### Using UnityPackageManager (for Unity 2019.1 or later) Find the manifest.json file in the Packages folder of your project and edit it to look like this: ```js { "dependencies": { "com.gameframe.gui": "https://github.com/coryleach/UnityGUI.git#2.0.0", ... }, } ``` ## Usage After importing this package via the PackageManager import the Demo/Demo.unitypackage file from the Assets->Import Package option in the menu. ### PanelView PanelView which provides Show & Hide behavior which can be instant or async and awaitable. ### AnimatedPanelView References one or more IPanelAnimator components to control animate the Show & Hide of a panel. If you await the Show & Hide async methods ### PanelViewController Controller for the display of a PanelView. ### PanelViewControllerBehaviour A version of PanelViewController that is also a MonoBehaviour component that can be added to a game object. Often you may want to set up & configure PanelViewControllers with data other than the panel type and using this class will allow you to do that in editor. ### PanelStackSystem A 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. ### PanelViewStackController A 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. ### PanelViewControllerProvider A 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. ### PanelViewControllerRegisterer Add this component to a PanelViewControllerBehaviour to register the controller with a PanelViewControllerProvider instance. ### PanelType Contains information about a panel and is used by the PanelViewController to locate the prefab and instantiate the PanelView. ## Author 👤 **Cory Leach** * Twitter: [@coryleach](https://twitter.com/coryleach) * Github: [@coryleach](https://github.com/coryleach) ## Show your support Give a ⭐️ if this project helped you! *** _This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_