103 lines
6.0 KiB
Markdown
103 lines
6.0 KiB
Markdown
<!-- Offline documentation -->
|
|
|
|
# About Unity UI Extensions
|
|
|
|
The Unity UI Extensions project is a collection of extension scripts/effects and controls to enhance your Unity UI experience. This includes over 70+ controls, utilities, effects and some much-needed love to make the most out of the Unity UI system (formally uGUI) in Unity.
|
|
[Check out our Tumblr page for a sneak peek](https://www.tumblr.com/blog/unityuiextensions)
|
|
|
|
You can follow the UI Extensions team for updates and news on:
|
|
|
|
### [Twitter - #unityuiextensions](https://twitter.com/search?q=%23unityuiextensions) / [Facebook](https://www.facebook.com/UnityUIExtensions/) / [YouTube](https://www.youtube.com/@UnityUIExtensions)
|
|
|
|
> Ways to get in touch:
|
|
>
|
|
> - [Gitter Chat](https://gitter.im/Unity-UI-Extensions/Lobby) site for the UI Extensions project
|
|
> - [GitHub Discussions](https://github.com/Unity-UI-Extensions/com.unity.uiextensions/discussions), if you have any questions, queries or suggestions
|
|
|
|
# Installing Unity UI Extensions
|
|
|
|
To install this package, follow the instructions in the Package Manager documentation.
|
|
|
|
For more details on [Getting Started](https://unity-ui-extensions.github.io/GettingStarted) please checkout the [online documentation here](https://unity-ui-extensions.github.io/).
|
|
|
|
# Using Unity UI Extensions
|
|
|
|
The UI Extensions project provides many automated functions to add the various controls contained within the project commonly accessed via "***GameObject -> UI -> Extensions -> 'Control'***" from the editor menu. This will add the UI object and all the necessary components to make that control work in the scene in a default state.
|
|
|
|
Some of the features are also available through the GameObject "Add Component" menu in the inspector.
|
|
|
|
For a full list of the controls and how they are used, please see the [online documentation](https://unity-ui-extensions.github.io/Controls.html) for the project.
|
|
|
|
# Technical details
|
|
|
|
## Requirements
|
|
|
|
This version of the Unity UI Extensions is compatible with the following versions of the Unity Editor:
|
|
|
|
- 2019 and above - the recommended path for 2019+ is to use the Unity Package Manager to get access to the package. Full details for installing via UPM can be [found here](https://unity-ui-extensions.github.io/UPMInstallation.html).
|
|
|
|
> Alternatively, the Asset packages have been tested to work with 2019 as well if you prefer to install that way.
|
|
|
|
- 2018 and below - for 2018 and use this package, you will have to import the asset package(s), either from the Asset Store or from the alternate download locations [listed here](https://unity-ui-extensions.github.io/Downloads).
|
|
|
|
## [Release Notes](https://unity-ui-extensions.github.io/ReleaseNotes/RELEASENOTES)
|
|
|
|
## Release 2.3.2 - Rejuvenation - 2023/11/26
|
|
|
|
2023 is certainly an interesting year to keep you on your toes, and finding time to keep managing all the requests and updates that come in are taking their toll, especially for a FREE project, but nonetheless, I still do it.
|
|
|
|
Mainly bugfixes for the end of year update, promoting some resolutions that have been verified and tested since the last release.
|
|
|
|
To get up to speed with the Unity UI Extensions, check out the [Getting Started](https://unity-ui-extensions.github.io/GettingStarted.html) Page.
|
|
|
|
> Ways to get in touch:
|
|
>
|
|
> - [GitHub Discussions](https://github.com/Unity-UI-Extensions/com.unity.uiextensions/discussions), if you have any questions, queries or suggestions
|
|
> - [Gitter Chat](https://gitter.im/Unity-UI-Extensions/Lobby) site for the UI Extensions project
|
|
>
|
|
> Much easier that posting a question / issue on YouTube, Twitter or Facebook :D
|
|
|
|
## Breaking changes
|
|
|
|
For customers upgrading from earlier versions of Unity to Unity 2020, please be aware of the Breaking change related to Text Based components. You will need to manually replace any UI using the older ```Text``` component and replace them with ```TextMeshPro``` versions. This is unavoidable due to Unity deprecating the Text component.
|
|
|
|
> New users to 2022 are unaffected as all the Editor commands have been updated to use the newer TextMeshPro versions.
|
|
|
|
For more details, see the [deprecation notice](https://github.com/Unity-UI-Extensions/com.unity.uiextensions/discussions/428) on GitHub.
|
|
|
|
## Added
|
|
|
|
- Add CalculatePointOnCurve for uilinerenderer (@victornor)
|
|
|
|
## Changed
|
|
|
|
- fix: Fixed an null reference exception with the ResetSelectableHighlight (@FejZa)
|
|
- fix: Resolved an issue where the last line in a flow layout group would overflow the rect bounds.
|
|
- fix: GetPosition when Segments is null (@victornor)
|
|
- fix: Fix Bug! NicerOutline color.a Loss when m_UseGraphicAlpha is true (wanliyun)
|
|
- fix: Update to force Enumerated start for Accordion elements, Resolves: #455
|
|
- Added argument to the UpdateLayout method for the HSS/VSS to move to a new starting page.
|
|
- Updated implementations to handle 2023 support, with 2023 moving in to public release.
|
|
- Added extra event on the AutoCompleteComboBox, to fire when an item in the list is selected, with its display name.
|
|
- FlowLayoutGroup components updated to latest (likely the last as the author has stopped development)
|
|
|
|
## Deprecated
|
|
|
|
- All deprecated Text based components now have "obsolete" tags, to avoid breaking code. Note, these do not function in 2022 and above, as Unity have "changed" things. For any affected component, I recommend updating to use TextMeshPro native features.
|
|
|
|
- [UI Extensions Issue log](https://github.com/Unity-UI-Extensions/com.unity.uiextensions/issues)
|
|
|
|
## Upgrade Notes
|
|
|
|
We recommend using the UPM delivery method. If you are using the Unity asset, there should be no issues updating but if you have a problem, just deleted the old Unity-UI-Extensions folder and import the asset new.
|
|
|
|
# Document revision history
|
|
|
|
|Date|Details|
|
|
|-|-|
|
|
|July 9th, 2020|2019.4 (v2.2) released, first UPM deployment live |
|
|
|September 3rd, 2019|2019.1 (v2.1) released, First major update for the 2.0 series.|
|
|
|August 8th, 2020|2019.4 (v2.2) released, New UPM Delivery.|
|
|
|October 10th, 2020|2019.5 (v2.2) released, New UPM fast delivery|
|
|
|February 7th, 2022|v2.3 released, New Home, UPM fast delivery via OpenUPM|
|