@eva/plugin-ui 2.1.0-beta.1 → 2.1.0-beta.10

package/dist/plugin-ui.d.ts

@@ -21,6 +21,15 @@ export declare interface CheckBoxParams {
         checked?: ViewRef;
         unchecked?: ViewRef;
     };
+    textStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+    };
+    textOffset?: {
+        x?: number;
+        y?: number;
+    };
     disabledStyle?: CheckBoxStateStyle;
 }
 
@@ -30,7 +39,7 @@ export declare interface CheckBoxStateStyle {
 }
 
 /** 圆形样式 */
-export declare interface CircleStyle extends UIStyle {
+export declare interface CircleStyle extends ShapeStyle {
     x?: number;
     y?: number;
     radius: number;
@@ -48,7 +57,13 @@ export declare interface CircularProgressBarParams {
     fillColor?: number | string;
     backgroundAlpha?: number;
     fillAlpha?: number;
+    cap?: 'round' | 'butt' | 'square';
     bindToStore?: string;
+    rotation?: number;
+    offset?: {
+        x?: number;
+        y?: number;
+    };
 }
 
 export declare const COMPONENT_DEFINITIONS: Record<string, ComponentDefinition>;
@@ -74,6 +89,8 @@ export declare interface ComponentDefinition<TParams = any, TInstance = any> {
     signalMap?: (component: TParams & Record<string, any>) => Record<string, true | ((...args: any[]) => Record<string, any>)>;
     /** CHANGE 事件触发,把字段写回 PIXI 实例 */
     syncOnChange?: (instance: TInstance, component: TParams & Record<string, any>) => void;
+    /** Transform.size -> @pixi/ui 实例尺寸同步。未提供时由 UISystem 使用通用 setSize/width/height 策略。 */
+    applySize?: (instance: TInstance, size: UiRenderSize, component: TParams & Record<string, any>, context: UiSizeSyncContext) => void;
     /** ADD 完成后跑(Dialog 挂 content / MaskedFrame 挂 border)*/
     onAttachedExtra?: (instance: TInstance, component: TParams & Record<string, any>, go: any, game: any) => void;
     /** 实例方法 mixin(注入到 wrapper class.prototype) */
@@ -84,6 +101,51 @@ export declare function defineUiComponent<TParams = any, TInstance = any>(def: C
 
 export declare const Dialog: UiComponentClass<DialogParams>;
 
+declare interface DialogButtonParams {
+    kind?: 'button' | 'fancy';
+    text?: string;
+    value?: string | number;
+    closeOnPress?: boolean;
+    reopenDelay?: number;
+    width?: number;
+    height?: number;
+    radius?: number;
+    color?: number | string;
+    hoverColor?: number | string;
+    pressedColor?: number | string;
+    disabledColor?: number | string;
+    defaultView?: string;
+    hoverView?: string;
+    pressedView?: string;
+    disabledView?: string;
+    nineSliceSprite?: [number, number, number, number];
+    textStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+        fontWeight?: string;
+    };
+    disabled?: boolean;
+    animations?: unknown;
+}
+
+declare interface DialogCheckBoxParams {
+    text?: string;
+    size?: number;
+    radius?: number;
+    checked?: boolean;
+    uncheckedColor?: number | string;
+    checkedColor?: number | string;
+    strokeColor?: number | string;
+    strokeWidth?: number;
+    textStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+        fontWeight?: string;
+    };
+}
+
 export declare interface DialogParams {
     open?: boolean;
     title?: string;
@@ -98,6 +160,50 @@ export declare interface DialogParams {
     contentChildName?: string;
     nineSliceSprite?: [number, number, number, number];
     bindToStore?: string;
+    titleStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+        fontWeight?: string;
+        lineHeight?: number;
+        dropShadow?: unknown;
+    };
+    content?: string;
+    contentStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+        fontWeight?: string;
+        align?: 'left' | 'center' | 'right';
+        wordWrap?: boolean;
+        wordWrapWidth?: number;
+        lineHeight?: number;
+        dropShadow?: unknown;
+    };
+    contentButtons?: DialogButtonParams[];
+    contentCheckBoxes?: DialogCheckBoxParams[];
+    buttons?: DialogButtonParams[];
+    buttonList?: {
+        elementsMargin?: number;
+        type?: ListType;
+        padding?: number;
+    };
+    buttonListOffset?: {
+        x?: number;
+        y?: number;
+    };
+    scrollBox?: Partial<ScrollBoxParams> & {
+        type?: ListType;
+        offset?: {
+            x?: number;
+            y?: number;
+        };
+        size?: {
+            width?: number;
+            height?: number;
+        };
+    };
+    animations?: unknown;
 }
 
 export declare const DoubleSlider: UiComponentClass<DoubleSliderParams>;
@@ -116,12 +222,28 @@ export declare interface DoubleSliderParams {
         slider1?: ViewRef;
         slider2?: ViewRef;
     };
+    nineSliceSprite?: {
+        bg?: [number, number, number, number];
+        fill?: [number, number, number, number];
+    };
+    fillPaddings?: ProgressBarFillPaddings;
+    valueTextStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+    };
+    valueTextOffset?: {
+        x?: number;
+        y?: number;
+    };
+    width?: number;
+    height?: number;
     bindToStore1?: string;
     bindToStore2?: string;
 }
 
 /** 椭圆样式 */
-export declare interface EllipseStyle extends UIStyle {
+export declare interface EllipseStyle extends ShapeStyle {
     x?: number;
     y?: number;
     width: number;
@@ -159,9 +281,44 @@ export declare interface FancyButtonParams {
     views?: FancyButtonViewRefs;
     offset?: FancyButtonOffset;
     textOffset?: FancyButtonOffset;
+    iconOffset?: FancyButtonOffset;
     padding?: number;
     nineSliceSprite?: [number, number, number, number];
     selectedTint?: string;
+    textStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+        fontWeight?: string;
+        dropShadow?: unknown;
+    };
+    textClass?: 'text' | 'html' | 'bitmap';
+    bitmapFontName?: string;
+    defaultTextScale?: {
+        x?: number;
+        y?: number;
+    } | number;
+    defaultIconScale?: {
+        x?: number;
+        y?: number;
+    } | number;
+    defaultTextAnchor?: {
+        x?: number;
+        y?: number;
+    } | number;
+    defaultIconAnchor?: {
+        x?: number;
+        y?: number;
+    } | number;
+    anchor?: number;
+    anchorX?: number;
+    anchorY?: number;
+    scale?: number;
+    animations?: unknown;
+    contentFittingMode?: 'default' | 'fill' | 'none';
+    ignoreRefitting?: boolean;
+    width?: number;
+    height?: number;
 }
 
 export declare type FancyButtonState = 'default' | 'hover' | 'pressed' | 'disabled' | 'selected';
@@ -171,6 +328,7 @@ export declare interface FancyButtonViewRefs {
     hover?: ViewRef;
     pressed?: ViewRef;
     disabled?: ViewRef;
+    icon?: ViewRef;
 }
 
 export declare type FieldKind = 'scalar' | 'shallowMerge' | 'arrayCopy' | 'tuple' | 'opaque';
@@ -188,6 +346,8 @@ export declare interface FieldSpec {
 export declare interface InlineShape {
     type: 'rect' | 'roundedRect' | 'circle' | 'ellipse';
     style: {
+        x?: number;
+        y?: number;
         width?: number;
         height?: number;
         radius?: number;
@@ -214,6 +374,8 @@ export declare interface InputParams {
     cleanOnFocus?: boolean;
     addMask?: boolean;
     bindToStore?: string;
+    width?: number;
+    height?: number;
 }
 
 export declare interface InputStyle {
@@ -276,6 +438,8 @@ export declare interface MaskedFrameParams {
     targetView?: ViewRef;
     maskView?: ViewRef;
     borderView?: ViewRef;
+    borderWidth?: number;
+    borderColor?: number | string;
 }
 
 /**
@@ -287,12 +451,20 @@ export declare class PixiUiComponent<TParams = any> extends Component<TParams> {
     /** runtime 计数,供 spec / debug 验证(toggleCount / pressCount / hoverCount / ...)*/
     toggleCount: number;
     pressCount: number;
+    downCount: number;
+    upCount: number;
     hoverCount: number;
+    outCount: number;
+    upOutCount: number;
     changeCount: number;
     updateCount: number;
     selectCount: number;
+    lastSignal: string;
+    visualState: string;
     /** Input 私有 focused */
     focused: boolean;
+    /** DSL/constructor 中显式传入过的字段,用于区分 metadata default 与用户配置。 */
+    __evaExplicitFields: Set<string>;
     /** 由 factory 通过 metadata 注入的动态字段(views / value / checked / ...)*/
     [key: string]: any;
     init(p?: TParams): void;
@@ -321,6 +493,8 @@ export declare interface ProgressBarParams {
     };
     fillPaddings?: ProgressBarFillPaddings;
     bindToStore?: string;
+    width?: number;
+    height?: number;
 }
 
 export declare class RadioGroup extends Component<RadioGroupParams> {
@@ -350,7 +524,7 @@ export declare interface RadioGroupParams {
 }
 
 /** 矩形样式 */
-export declare interface RectStyle extends UIStyle {
+export declare interface RectStyle extends ShapeStyle {
     x?: number;
     y?: number;
     width: number;
@@ -367,7 +541,7 @@ export declare interface ResolvedViews {
 }
 
 /** 圆角矩形样式 */
-export declare interface RoundedRectStyle extends UIStyle {
+export declare interface RoundedRectStyle extends ShapeStyle {
     x?: number;
     y?: number;
     width: number;
@@ -388,6 +562,16 @@ export declare interface ScrollBoxParams {
     disableDynamicRendering?: boolean;
     disableEasing?: boolean;
     padding?: number;
+    vertPadding?: number;
+    horPadding?: number;
+    topPadding?: number;
+    bottomPadding?: number;
+    leftPadding?: number;
+    rightPadding?: number;
+    globalScroll?: boolean;
+    shiftScroll?: boolean;
+    proximityRange?: number;
+    proximityDebounce?: number;
     inertia?: boolean;
     inertiaDecay?: number;
     bounceFactor?: number;
@@ -415,47 +599,36 @@ export declare interface SelectParams {
     };
     nineSliceSprite?: [number, number, number, number];
     bindToStore?: string;
-}
-
-export declare const Slider: UiComponentClass<SliderParams>;
-
-export declare type SliderOrientation = 'horizontal' | 'vertical';
-
-export declare interface SliderParams {
-    enabled?: boolean;
-    value?: number;
-    min?: number;
-    max?: number;
-    step?: number;
-    orientation?: SliderOrientation;
-    showValue?: boolean;
-    views?: {
-        bg?: ViewRef;
-        fill?: ViewRef;
-        thumb?: ViewRef;
+    width?: number;
+    height?: number;
+    radius?: number;
+    visibleItems?: number;
+    itemWidth?: number;
+    itemHeight?: number;
+    itemBackgroundColor?: number | string;
+    itemHoverColor?: number | string;
+    selectedTextOffset?: {
+        x?: number;
+        y?: number;
     };
-    bindToStore?: string;
-}
-
-export declare const Switcher: UiComponentClass<SwitcherParams>;
-
-export declare interface SwitcherParams {
-    active?: number;
-    views?: ViewRef[];
-    triggerEvent?: SwitcherTriggerEvent;
-    bindToStore?: string;
+    scrollBox?: Partial<ScrollBoxParams> & {
+        offset?: {
+            x?: number;
+            y?: number;
+        };
+    };
+    textClass?: 'text' | 'html';
+    open?: boolean;
 }
 
-export declare type SwitcherTriggerEvent = 'onPress' | 'onDown' | 'onUp' | 'onHover' | 'onOut';
-
 /**
- * UI 组件
+ * Shape 组件
  *
  * 基于 `@eva/plugin-renderer-graphics` 实现 rect/circle/ellipse/roundedRect 的
  * 矢量绘制,支持纯色 / linear-gradient 填充与描边。`shapes` 数组允许在同一个
  * GameObject 上层叠多个形状。
  */
-export declare class UI extends Component<UIParams> {
+declare class Shape extends Component<ShapeParams> {
     /** 组件名称 */
     static componentName: string;
     /** 实例侧 componentName,DSL 序列化时使用 */
@@ -463,7 +636,7 @@ export declare class UI extends Component<UIParams> {
     private shapes;
     /** 编辑器 Inspector 元数据,主仓 ComponentInspector 通过静态方法读取 */
     static getInspectorMetadata(): InspectorFieldMetadata;
-    init(params?: UIParams): void;
+    init(params?: ShapeParams): void;
     awake(): void;
     start(): void;
     /**
@@ -493,17 +666,17 @@ export declare class UI extends Component<UIParams> {
     private drawEllipse;
     private drawRoundedRect;
     /** 追加一个形状 */
-    addShape(type: UIShapeType, style: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle): void;
+    addShape(type: ShapeType, style: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle): void;
     /** 清除所有形状 */
     clearShapes(): void;
     /** 更新指定索引的形状 */
-    updateShape(index: number, type: UIShapeType, style: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle): void;
+    updateShape(index: number, type: ShapeType, style: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle): void;
     /** 移除指定索引的形状 */
     removeShape(index: number): void;
     /** 获取形状数量 */
     getShapeCount(): number;
     /** 获取指定索引的形状(只读视图) */
-    getShape(index: number): UIShape | null;
+    getShape(index: number): ShapeDefinition | null;
     /** 设置所有形状的透明度 */
     setAlpha(alpha: number): void;
     /** 设置所有形状的填充色 */
@@ -511,37 +684,26 @@ export declare class UI extends Component<UIParams> {
     /** 设置所有形状的描边 */
     setStroke(stroke: string, lineWidth?: number): void;
 }
-
-declare type UiComponentClass<TParams = any> = new () => PixiUiComponent<TParams>;
-
-/** 兼容别名:历史代码中沿用的 UIComponentParams */
-export declare type UIComponentParams = UIParams;
-
-/** UI 组件参数接口 */
-export declare interface UIParams {
-    componentName?: string;
-    shapes?: UIShape[];
-    /** 单形状简化用法:type + style */
-    type?: UIShapeType;
-    style?: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle;
-}
+export { Shape }
+export { Shape as UI }
 
 /** 单个 shape 描述 */
-export declare interface UIShape {
-    type: UIShapeType;
+export declare interface ShapeDefinition {
+    type: ShapeType;
     style: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle;
 }
 
-/** UI 形状类型枚举 */
-export declare enum UIShapeType {
-    RECT = "rect",
-    CIRCLE = "circle",
-    ELLIPSE = "ellipse",
-    ROUNDED_RECT = "roundedRect"
+/** Shape component params */
+export declare interface ShapeParams {
+    componentName?: string;
+    shapes?: ShapeDefinition[];
+    /** 单形状简化用法:type + style */
+    type?: ShapeType;
+    style?: RectStyle | CircleStyle | EllipseStyle | RoundedRectStyle;
 }
 
-/** UI 基础样式 */
-export declare interface UIStyle {
+/** Shape base style */
+export declare interface ShapeStyle {
     /** 填充颜色,支持 #RRGGBB / rgb()/rgba() / linear-gradient(...) */
     fill?: string;
     /** 描边颜色 */
@@ -552,18 +714,102 @@ export declare interface UIStyle {
     alpha?: number;
 }
 
+/** Shape primitive type enum */
+export declare enum ShapeType {
+    RECT = "rect",
+    CIRCLE = "circle",
+    ELLIPSE = "ellipse",
+    ROUNDED_RECT = "roundedRect"
+}
+
+export declare const Slider: UiComponentClass<SliderParams>;
+
+export declare type SliderOrientation = 'horizontal' | 'vertical';
+
+export declare interface SliderParams {
+    enabled?: boolean;
+    value?: number;
+    min?: number;
+    max?: number;
+    step?: number;
+    orientation?: SliderOrientation;
+    showValue?: boolean;
+    views?: {
+        bg?: ViewRef;
+        fill?: ViewRef;
+        thumb?: ViewRef;
+    };
+    nineSliceSprite?: {
+        bg?: [number, number, number, number];
+        fill?: [number, number, number, number];
+    };
+    fillPaddings?: ProgressBarFillPaddings;
+    valueTextStyle?: {
+        fontFamily?: string;
+        fontSize?: number;
+        fill?: string | number;
+    };
+    valueTextOffset?: {
+        x?: number;
+        y?: number;
+    };
+    width?: number;
+    height?: number;
+    bindToStore?: string;
+}
+
+export declare const Switcher: UiComponentClass<SwitcherParams>;
+
+export declare interface SwitcherParams {
+    active?: number;
+    views?: ViewRef[];
+    triggerEvent?: SwitcherTriggerEvent | SwitcherTriggerEvent[];
+    bindToStore?: string;
+}
+
+export declare type SwitcherTriggerEvent = 'onPress' | 'onDown' | 'onUp' | 'onHover' | 'onOut' | 'onUpOut';
+
+declare type UiComponentClass<TParams = any> = new () => PixiUiComponent<TParams>;
+
+export declare type UIComponentParams = ShapeParams;
+
+/** Backward-compatible aliases kept for existing TS imports. */
+export declare type UIParams = ShapeParams;
+
+declare interface UiRenderSize {
+    width?: number;
+    height?: number;
+}
+
+export declare type UIShape = ShapeDefinition;
+
+/** Backward-compatible enum value alias for existing TypeScript consumers. */
+export declare const UIShapeType: typeof ShapeType;
+
+export declare type UIShapeType = ShapeType;
+
+declare interface UiSizeSyncContext {
+    componentName: string;
+    component?: Record<string, any>;
+    gameObject?: any;
+    source: 'initial-transform' | 'transform-change' | 'component-change';
+}
+
+export declare type UIStyle = ShapeStyle;
+
 declare class UISystem extends System {
     static systemName: string;
     name: string;
     /** componentName -> instance map(generic 共享一份) */
     private instances;
     private signalCleanups;
+    private transformSizeAuthorities;
     /** 给 RadioGroup 反查 PixiCheckBox 实例用 */
     private get checkBoxInstances();
     private radioGroupInstances;
     update(_e?: any): void;
     componentChanged(changed: ComponentChanged): void;
-    private handleUI;
+    private handleShape;
     private handleGeneric;
     private attachGeneric;
     private detachGeneric;
@@ -571,6 +817,9 @@ declare class UISystem extends System {
     private attachRadioGroup;
     private getInstanceMap;
     private gameRef;
+    private handleTransformSizeChanged;
+    private relayoutLayoutInstances;
+    private applyTransientTransformSize;
 }
 export { UISystem as PluginUiSystem }
 export { UISystem }
@@ -581,7 +830,7 @@ export { UISystem }
  * - { entityName: "background" }  — 引用同 GameObject 的子 entity 的 PIXI.Container,
  *   这个 child entity 必须先 ADD,然后我们把它的 Container "借走" 交给 @pixi/ui 实例。
  *   原 child entity 仍然存在(Transform/逻辑组件还在),只是 PIXI 显示对象被重新 parent。
- * - { ui: { type, style } }  — 内联 UI shape,生成一个新的 PIXI.Graphics(临时,与 plugin-ui-graphics 不同源)
+ * - { shape: { type, style } } — 内联 shape,生成一个新的 PIXI.Graphics(临时,与 Shape 组件不同源)
  * - { texture: "loading.png" } — 从已加载的 Eva 资源池查 texture,生成 PIXI.Sprite
  * - { color: 0xRRGGBB, width, height }  — 生成纯色矩形 Graphics
  * - { fallback: <ViewRef> } — 当主 ref 解析失败时使用
@@ -589,6 +838,9 @@ export { UISystem }
 export declare type ViewRef = {
     entityName: string;
     fallback?: ViewRef;
+} | {
+    shape: InlineShape;
+    fallback?: ViewRef;
 } | {
     ui: InlineShape;
     fallback?: ViewRef;