@galacean/engine-ui 2.0.0-alpha.2 → 2.0.0-alpha.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-ui",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -26,10 +26,10 @@
     "types/**/*"
   ],
   "devDependencies": {
-    "@galacean/engine": "2.0.0-alpha.2"
+    "@galacean/engine": "2.0.0-alpha.21"
   },
   "peerDependencies": {
-    "@galacean/engine": "2.0.0-alpha.2"
+    "@galacean/engine": "2.0.0-alpha.21"
   },
   "scripts": {
     "b:types": "tsc"

package/types/component/UICanvas.d.ts

@@ -7,12 +7,11 @@ import { IElement } from "../interface/IElement";
  * handling rendering and events based on it.
  */
 export declare class UICanvas extends Component implements IElement {
-    private static _targetTempPath;
     private static _tempGroupAbleList;
     private static _tempVec3;
     private static _tempMat;
     private _renderMode;
-    private _renderCamera;
+    private _camera;
     private _cameraObserver;
     private _resolutionAdaptationMode;
     private _sortOrder;
@@ -38,8 +37,15 @@ export declare class UICanvas extends Component implements IElement {
     get renderMode(): CanvasRenderMode;
     set renderMode(mode: CanvasRenderMode);
     /**
-     * The camera used to render the UI canvas in `ScreenSpaceCamera` mode.
-     * @remarks If set `ScreenSpaceCamera` but no corresponding camera is assigned, the actual rendering mode defaults to `ScreenSpaceOverlay`.
+     * The camera associated with this canvas.
+     * @remarks
+     * - `ScreenSpaceCamera` mode: Used for rendering adaptation. Defaults to `ScreenSpaceOverlay` if not assigned.
+     * - `WorldSpace` mode: Used for event detection. If not assigned, events are handled by the highest-priority camera.
+     */
+    get camera(): Camera;
+    set camera(value: Camera);
+    /**
+     * @deprecated Use {@link camera} instead.
      */
     get renderCamera(): Camera;
     set renderCamera(value: Camera);

package/types/component/UITransform.d.ts

@@ -1,4 +1,4 @@
-import { Entity, Transform, Vector2 } from "@galacean/engine";
+import { Transform, Vector2 } from "@galacean/engine";
 import { HorizontalAlignmentMode } from "../enums/HorizontalAlignmentMode";
 import { VerticalAlignmentMode } from "../enums/VerticalAlignmentMode";
 /**
@@ -96,7 +96,7 @@ export declare class UITransform extends Transform {
      */
     get alignMiddle(): number;
     set alignMiddle(value: number);
-    _cloneTo(target: UITransform, srcRoot: Entity, targetRoot: Entity): void;
+    _cloneTo(target: UITransform): void;
     protected _onLocalMatrixChanging(): void;
     protected _onWorldMatrixChanging(): void;
     protected _onPositionChanged(): void;

package/types/component/advanced/Button.d.ts

@@ -1,21 +1,18 @@
-import { PointerEventData } from "@galacean/engine";
+import { PointerEventData, Signal } from "@galacean/engine";
 import { UIInteractive } from "../interactive/UIInteractive";
 export declare class Button extends UIInteractive {
-    private _listeners;
+    /** Signal emitted when the button is clicked. */
+    readonly onClick: Signal<[PointerEventData]>;
+    onPointerClick(event: PointerEventData): void;
+    onDestroy(): void;
     /**
      * Add a listening function for click.
-     * @param listener - The listening function
+     * @deprecated Use `onClick.on(listener, context)` instead.
      */
     addClicked(listener: (event: PointerEventData) => void): void;
     /**
      * Remove a listening function of click.
-     * @param listener - The listening function
+     * @deprecated Use `onClick.off(listener, context)` instead.
      */
     removeClicked(listener: (event: PointerEventData) => void): void;
-    onPointerClick(event: PointerEventData): void;
-    onDestroy(): void;
-}
-export interface IUIListener {
-    fn: (event: PointerEventData) => void;
-    destroyed?: boolean;
 }

package/types/component/advanced/Text.d.ts

@@ -15,6 +15,7 @@ export declare class Text extends UIRenderer implements ITextRenderer {
     private _fontSize;
     private _fontStyle;
     private _lineSpacing;
+    private _characterSpacing;
     private _horizontalAlignment;
     private _verticalAlignment;
     private _enableWrapping;
@@ -40,10 +41,15 @@ export declare class Text extends UIRenderer implements ITextRenderer {
     get fontStyle(): FontStyle;
     set fontStyle(value: FontStyle);
     /**
-     * The space between two lines (in pixels).
+     * The space between two lines, in em (ratio of fontSize).
      */
     get lineSpacing(): number;
     set lineSpacing(value: number);
+    /**
+     * The space between two characters, in em (ratio of fontSize).
+     */
+    get characterSpacing(): number;
+    set characterSpacing(value: number);
     /**
      * The horizontal alignment.
      */
@@ -74,7 +80,7 @@ export declare class Text extends UIRenderer implements ITextRenderer {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    _cloneTo(target: Text, srcRoot: Entity, targetRoot: Entity): void;
+    _cloneTo(target: Text): void;
     protected _updateBounds(worldBounds: BoundingBox): void;
     protected _render(context: any): void;
     private _resetSubFont;

package/types/component/interactive/UIInteractive.d.ts

@@ -1,11 +1,10 @@
-import { Entity, Script } from "@galacean/engine";
+import { Script } from "@galacean/engine";
 import { IGroupAble } from "../../interface/IGroupAble";
 import { Transition } from "./transition/Transition";
 /**
  * Interactive component.
  */
 export declare class UIInteractive extends Script implements IGroupAble {
-    private static _targetTempPath;
     protected _transitions: Transition[];
     protected _interactive: boolean;
     protected _state: InteractiveState;
@@ -41,7 +40,6 @@ export declare class UIInteractive extends Script implements IGroupAble {
     onPointerEnter(): void;
     onPointerExit(): void;
     onDestroy(): void;
-    _cloneTo(target: UIInteractive, srcRoot: Entity, targetRoot: Entity): void;
     _onEnableInScene(): void;
     _onDisableInScene(): void;
     private _updateState;

package/types/index.d.ts

@@ -1,10 +1,10 @@
 import { Material } from "@galacean/engine";
 export * from "./component";
 export { CanvasRenderMode } from "./enums/CanvasRenderMode";
-export { ResolutionAdaptationMode } from "./enums/ResolutionAdaptationMode";
-export { UIPointerEventEmitter } from "./input/UIPointerEventEmitter";
 export { HorizontalAlignmentMode } from "./enums/HorizontalAlignmentMode";
+export { ResolutionAdaptationMode } from "./enums/ResolutionAdaptationMode";
 export { VerticalAlignmentMode } from "./enums/VerticalAlignmentMode";
+export { UIPointerEventEmitter } from "./input/UIPointerEventEmitter";
 export declare class EngineExtension {
     _uiDefaultMaterial: Material;
     _getUIDefaultMaterial(): Material;