# TinaX Framework - UIKit.
[-blue.svg)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
[](https://github.com/yomunsam/TinaX/blob/master/LICENSE)
TinaX是一个简洁、完整、愉快的开箱即用的Unity应用游戏开发框架， 它采用"Unity 包"的形式提供功能。
`TinaX.UIKit` 为TinaX Framework提供了基于UGUI的UI管理功能
- 基于“页面”概念的UI管理
- UI动画框架
- UGUI功能扩展
package name: `io.nekonya.tinax.uikit`
------
## QuickStart
UIKit的主要服务接口是：
``` csharp
TinaX.UIKit.IUIKit
```
主要服务接口的Facade是:
``` csharp
TinaX.VFSKit.UIKit
```
创建一个“UI页”
在UI页面的根级gameObject上添加组件“XComponent”
并将其设置为“UI处理者”
添加一个ugui的"Text"组件
将其拖进"XComponent"
编写一个 "UIController", (如果你觉得它是MVC结构的话)
``` csharp
using TinaX;
using TinaX.XComponent;
using UnityEngine.UI;
public class MainScreen : XUIBehaviour
{
[Binding("txt_Text")] //对应"XComponent"中的绑定名称
public Text txt_title;
public override async void Start()
{
txt_title.text = "Hello World(❁´◡`❁)";
}
}
```
然后，打开UI 😜
``` csharp
IUIEntity mainScreen = uikit.OpenUIAsync("mainScreen", new MainScreen());
//对象"uikit" (类型为IUIKit) 可通过依赖注入获得. 或者也可使用facade.
```
更多用法请 [查看文档](https://tinax.corala.space).
------
## 安装
### 使用[OpenUPM](https://openupm.com/)安装
``` bash
# Install openupm-cli if not installed.
npm install -g openupm-cli
# OR yarn global add openupm-cli
#run install in your project root folder
openupm add io.nekonya.tinax.uikit
```
### 通过npm安装 (UPM)
修改您的工程中的`Packages/manifest.json` 文件，并在文件的"dependencies"节点前添加如下内容：
``` json
"scopedRegistries": [
{
"name": "TinaX",
"url": "https://registry.npmjs.org",
"scopes": [
"io.nekonya"
]
},
{
"name": "package.openupm.com",
"url": "https://package.openupm.com",
"scopes": [
"com.cysharp.unitask",
"com.neuecc.unirx"
]
}
],
```
如果在进行上述操作后，您仍然未能在"Unity Package Manager"窗口中找到TinaX的相关Packages，您也可以尝试刷新、重启编辑器，或手动添加如下配置到"dependencies":
``` json
"io.nekonya.tinax.uikit" : "6.6.3"
```
### 通过Git方式安装(UPM)
你可使用如下地址在Unity Package Manager窗口中安装本包：
```
git://github.com/yomunsam/TinaX.UIKit.git
```
如果您想手动指定安装某个本本, 您可以使用 release tag, 例如 `#6.6.3`. 或访问Release页面了解细节: [https://github.com/yomunsam/TinaX.VFS/releases](https://github.com/yomunsam/TinaX.VFS/releases)
如不指定版本，Unity将会安装当前git仓库中的最新版本，可能会造成兼容性错误。
### 特殊地区用户指引
由于部分中文开发者居住和生活的地区较为特殊，可能无法以全世界大多数人相同的方式使用互联网。如果在安装时出现问题，可尝试使用如下方式解决：
- 请尽可能努力以各种方式与全世界大多数人保持同样的网络环境。
- 尝试使用[cnpm](https://developer.aliyun.com/mirror/NPM?from=tnpm)镜像,包括UPM方式和OpenUPM方式
- 使用openupm时，您可按照[此处说明](https://github.com/openupm/openupm-cli#command-options)尝试使用第三方register
- 需要说明的是，TinaX的第三方依赖，比如`UniRx`并没有发布到`npmjs.org`, 因此在cnpm中也是找不到它的。
- 如果下载源码遇到困难，可以试试从TinaX在[Gitee的镜像](https://gitee.com/organizations/nekonyas/projects)下载
- 可以在同一个项目中使用不同的方式安装处理不同的packages，如你可以使用"Gitee"、"cnpm"等渠道安装TinaX packages，而如果实在下载不下来第三方依赖（如"Unirx"）的话，直接给下载下来放在项目的Packages目录里也是可行的。（当然，把所有东西都一股脑扔进Packages目录也是可行的，不过这样可能升级的时候会不方便）
------
## 依赖
本项目（包）直接依赖以下包
- [com.neuecc.unirx](https://github.com/neuecc/UniRx#upm-package) :`https://github.com/neuecc/UniRx.git?path=Assets/Plugins/UniRx/Scripts`
- [io.nekonya.tinax.core](https://github.com/yomunsam/tinax.core) :`git://github.com/yomunsam/TinaX.Core.git`
- [io.nekonya.tinax.xcomponent](https://github.com/yomunsam/tinax.xcomponent) :`git://github.com/yomunsam/TinaX.XComponent.git`
> 如果您通过Git方式安装Package，那么您需要手动确保所有依赖项已被安装。如果使用NPM/OpenUPM安装本Package，则所有依赖都将自动被安装。
------
## Learn TinaX
您可以访问TinaX的[文档页面](https://tinax.corala.space/#/cmn-hans)来学习了解各个功能的使用
------
## Third-Party
本项目中使用了以下优秀的第三方库：
- **[TweenRx](https://github.com/fumobox/TweenRx)** : Reactive animation utility for Unity.