Update README.md

This commit is contained in:
cheney2013 2023-06-02 12:16:05 +08:00 committed by GitHub
parent fd976202fe
commit ed535d0481
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,14 +1,30 @@
# UIState
一个 Cocos Creator 3.x 的插件能够方便的管理多个UI状态
# 项目简介
<b>使用方法简单只需一个在需要记录状态的节点上添加UIState组件即可记录所有子节点包含子孙节点的状态改变</b>
<b>一个 Cocos Creator 3.x 的插件能够方便的管理多个UI状态只需一个在需要记录状态的节点上添加UIState组件即可记录所有子节点包含子孙节点的状态改变</b>
1. 支持嵌套UIState。子节点子孙节点也可以加UIState维护自己的状态
2. 数据量小。仅记录修改的节点
3. 代码逻辑清晰易扩展。可以很方便的扩展记录的组件和属性,支持记录自定义组件
![image](https://github.com/cheney2013/ImageRepo/blob/main/2023-06-02-11-25-41.gif)
# 安装和使用
1. 将 extensions 目录下的 uistate-inspector 拷贝到你项目的 extensions 目录下
![image](https://github.com/cheney2013/ImageRepo/blob/main/Snipaste_2023-06-02_12-08-08.png)
2. 点击 Creator 工具栏的 扩展->扩展管理器,点击已安装扩展,点击刷新扩展,就可以看到 uistate-inspector 扩展
![image](https://github.com/cheney2013/ImageRepo/blob/main/Snipaste_2023-06-02_12-09-33.png)
3. 点击扩展右边的 toggle button启用扩展
4. 将 assets\script\component 目录下的 UIState.ts 文件复制到你项目的任意位置
![image](https://github.com/cheney2013/ImageRepo/blob/main/Snipaste_2023-06-02_12-10-06.png)
5. 为你需要记录UI状态的节点添加 UIState 组件
## 测试场景
嵌套UIState ✔ 父UIState节点不会保存子UIState节点的状态
@ -38,16 +54,3 @@ Widget ✔
## 构建发布测试
Web桌面 ✔
## 开发环境
Node.js
## 安装
```bash
# 安装依赖模块
npm install
# 构建
npm run build
```