chore: 样板内容整理

This commit is contained in:
AncTe committed 2025-10-11 16:59:40 +08:00
1 parent f9ab9fb73d
commit c339825f5e
78 files changed
+45 -109

No files matched your search

+1 -1
View File
@@ -131,4 +131,4 @@ export const MyUI = defineComponent(() => {
- 如果不允许交互,那么光标也不会显示
- 同 `zIndex` 下,后插入的元素会在上层,但是这也意味着如果是动态插入的元素(例如由于响应式更改而插入了一个新元素),会显示在后面代码的元素之上
4. **常见问题**
- 参考 [指南](../../guide/ui-faq.md)
- 参考 [指南](../../guide/ui/faq.md)
+12 -12
View File
@@ -32,10 +32,10 @@ interface SpriteProps extends BaseProps {
通过 `render` 函数实现 **动态绘制**,可结合:
- 基础定位/变换参数(继承 `BaseProps`)
- 动画系统(`useAnimation`)
- 帧回调(`onTick`)
- 自定义图形绘制(路径/滤镜/混合模式)
- 基础定位/变换参数(继承 `BaseProps`)
- 动画系统(`useAnimation`)
- 帧回调(`onTick`)
- 自定义图形绘制(路径/滤镜/混合模式)
**注意**,这个标签虽然非常基础,但是应该并不常用,因为很多内容都有对应的标签可以实现(例如线可以使用 `g-line` 标签等),因此如果你在考虑使用此标签,请确认你必须使用它,或是你的场景对性能非常敏感。
@@ -43,7 +43,7 @@ interface SpriteProps extends BaseProps {
## 使用示例
以下的示例代码均应该在**组件内部**编写,哪里是组件内部请参考[指南](../../guide/ui.md)。
以下的示例代码均应该在**组件内部**编写,哪里是组件内部请参考[指南](../../guide/ui/ui.md)。
### 示例 1:基础图形
@@ -67,9 +67,9 @@ const render = (canvas: MotaOffscreenCanvas2D) => {
**效果**:
- 100x100 红色方块,中心点位于 (200,200)
- 45 度旋转,蓝色描边
- 80% 不透明度
- 100x100 红色方块,中心点位于 (200,200)
- 45 度旋转,蓝色描边
- 80% 不透明度
---
@@ -102,8 +102,8 @@ return () => <sprite loc={loc.value} scale={scale.value} render={render} />;
**效果**:
- 矩形横向放大 1.5 倍,横向位置移动 100px
- 2 秒线性动画
- 矩形横向放大 1.5 倍,横向位置移动 100px
- 2 秒线性动画
---
@@ -137,8 +137,8 @@ return () => (
**效果**:
- 鼠标悬浮时添加模糊滤镜
- 鼠标悬浮显示指针光标
- 鼠标悬浮时添加模糊滤镜
- 鼠标悬浮显示指针光标
---
+15 -15
View File
@@ -11,7 +11,7 @@ graph LR
## 类描述
`UIController` 是 UI 控制系统的核心类,负责管理 UI 实例的显示栈、背景控制以及多种显示模式。继承自 `EventEmitter`,支持事件监听。想要编写 UI 请参考[深度指南](../../guide/ui.md)。
`UIController` 是 UI 控制系统的核心类,负责管理 UI 实例的显示栈、背景控制以及多种显示模式。继承自 `EventEmitter`,支持事件监听。想要编写 UI 请参考[深度指南](../../guide/ui/ui.md)。
---
@@ -37,8 +37,8 @@ graph LR
function constructor(id: string): UIController;
```
- **参数**
- `id`: 控制器的唯一标识符(若重复会触发警告日志)
- **参数**
- `id`: 控制器的唯一标识符(若重复会触发警告日志)
**示例**
@@ -84,9 +84,9 @@ function setBackground<T extends UIComponent>(
设置背景 UI 并初始化其实例。
- **参数**
- `back`: 背景 UI 配置实例
- `vBind`: 传递给背景组件的 Props 对象
- **参数**
- `back`: 背景 UI 配置实例
- `vBind`: 传递给背景组件的 Props 对象
**示例**
@@ -156,12 +156,12 @@ function open<T extends UIComponent>(
打开一个新 UI 实例并加入栈中。
- **参数**
- `ui`: UI 配置实例
- `vBind`: 组件 Props
- `alwaysShow`: 是否强制显示(默认 `false`)
- **返回值**
打开的 UI 实例,可以用于关闭等操作
- **参数**
- `ui`: UI 配置实例
- `vBind`: 组件 Props
- `alwaysShow`: 是否强制显示(默认 `false`)
- **返回值**
打开的 UI 实例,可以用于关闭等操作
**示例**
@@ -191,8 +191,8 @@ function closeAll(ui?: IGameUI): void;
关闭所有或指定类型的所有 UI 实例。
- **参数**
- `ui`(可选): 指定要关闭的 UI 类型,不填时表示关闭所有 UI
- **参数**
- `ui`(可选): 指定要关闭的 UI 类型,不填时表示关闭所有 UI
---
@@ -222,7 +222,7 @@ function showAll(stack?: boolean): void;
function showCustom(config: IUICustomConfig): void;
```
切换显示模式:使用自定义模式(需实现 `IUICustomConfig`),参考[指南](../../guide/ui-system.md#自定义显示模式)
切换显示模式:使用自定义模式(需实现 `IUICustomConfig`),参考[指南](../../guide/ui/system.md#自定义显示模式)
---