@toolmain/components 1.2.14 → 1.2.16

package/dist/index.d.ts

@@ -108,6 +108,26 @@ declare type __VLS_Props_5 = {
     provider: ComponentProvider;
 };
 
+declare type __VLS_Props_6 = {
+    /**
+     * drag bar size, specified as width when moving horizontally, and height when moving vertically
+     */
+    size: number | string;
+    /**
+     * drag bar is attached to the `direction` of the `target` element
+     */
+    direction: "top" | "right" | "bottom" | "left";
+    /**
+     * the targe element which size will be changed, if not set,
+     * represent current element's parent element
+     */
+    target?: HTMLElement | null;
+    /**
+     * the target element's style
+     */
+    modelValue: CSSProperties;
+};
+
 declare type __VLS_Slots = {} & {
     default?: (props: typeof __VLS_1) => any;
 };
@@ -248,7 +268,7 @@ export declare type BaseComponentSerialized = {
     children: BaseComponentSerialized[];
 };
 
-declare interface BaseConfigProps {
+export declare interface BaseConfigProps {
     /**
      * 当属性存在多种类型时，要选择最终的类型
      */
@@ -275,7 +295,7 @@ declare interface BaseConfigProps {
     disabled?: boolean;
 }
 
-declare interface BaseProps extends BaseConfigProps {
+export declare interface BaseProps extends BaseConfigProps {
     /**
      * 默认预设值
      */
@@ -390,11 +410,11 @@ export declare type CameraConf = {
     };
 };
 
-declare interface ColorProps extends BaseProps {
+export declare interface ColorProps extends BaseProps {
     type: PropsType.Color;
 }
 
-declare type CombArray<T> = T | T[];
+export declare type CombArray<T> = T | T[];
 
 /**
  * UI组件拥有的默认事件
@@ -409,6 +429,7 @@ export declare type ComponentEvents = {
      */
     args: string[];
     returnType?: string;
+    version?: string;
 };
 
 export declare class ComponentGenerator {
@@ -530,7 +551,15 @@ export declare interface ComponentProvider extends EventBus<ProviderEv> {
     getVarState: () => ComponentVarState;
 }
 
-declare interface ComponentVarState {
+export declare type ComponentUIGroup = {
+    label: string;
+    list: Array<{
+        label: string;
+        icon?: string | VNode;
+    }>;
+};
+
+export declare interface ComponentVarState {
     dispose: () => void;
     createVariable: (config: VariableStatic) => Variable;
     delVariable: (varId: string) => Variable | undefined;
@@ -623,6 +652,11 @@ declare interface DebugPanel {
     node: VNode | Component | string;
 }
 
+/**
+ * 元素默认属性
+ */
+export declare const defaultProps: () => Record<string, Props>;
+
 export declare type DeliverParam = {
     instanceId?: string;
     raw?: RawComponent;
@@ -711,7 +745,7 @@ export declare interface ElRect {
     y: number;
 }
 
-declare interface EnumProps extends BaseProps {
+export declare interface EnumProps extends BaseProps {
     type: PropsType.Enum;
     enums: Array<string | number | boolean>;
 }
@@ -768,12 +802,12 @@ export declare interface EventMap {
     moving: (pos: DragAttr) => void;
 }
 
-declare interface ExtendProps extends BaseProps {
+export declare interface ExtendProps extends BaseProps {
     type: PropsType.Extend;
     extendType: string;
 }
 
-declare interface ExtendPropsParser {
+export declare interface ExtendPropsParser {
     parse(value: Props): PropsValue;
     extendType(): string;
 }
@@ -791,7 +825,7 @@ declare type FixedArray<T, L extends number> = Pick<T[], Exclude<keyof T[], ArrM
     readonly length: L;
 };
 
-declare interface FunctionProps extends BaseProps {
+export declare interface FunctionProps extends BaseProps {
     type: PropsType.Function;
     /**
      * 实际的参数字符串会被传送到`Function`的参数中
@@ -817,6 +851,11 @@ export declare class GeneralLibrary implements ComponentLibrary {
     isPlaceHolder(raw: RawComponent): boolean;
 }
 
+/**
+ * 推算出当前属性的最终类型
+ */
+export declare function getFinalType(props: Props): PropsType | undefined;
+
 export declare function getModel(url: string, onProgress?: (progress: LoadProgressData) => void): Promise<{
     code: number;
     msg: string;
@@ -840,7 +879,7 @@ export declare const htmlTextConfig: (label: string, libraryId: string) => RawCo
 
 export declare const htmlTextLabel: string[];
 
-declare interface IconProps extends BaseProps {
+export declare interface IconProps extends BaseProps {
     type: PropsType.Icon;
 }
 
@@ -850,7 +889,32 @@ export declare function initRect(): Rect;
 
 export declare type InitType = "auto" | "inherit" | "initial" | "unset";
 
-declare interface JSONProps extends BaseProps {
+export declare function isColorProps(props: Props): props is ColorProps;
+
+export declare function isEnumProps(props: Props): props is EnumProps;
+
+export declare function isExtendProps(props: Props): props is ExtendProps;
+
+export declare function isFunctionProps(props: Props): props is FunctionProps;
+
+export declare function isIconProps(props: Props): props is IconProps;
+
+export declare function isJSONProps(props: Props): props is JSONProps;
+
+/**
+ * 判断是否是基本数据类型
+ */
+export declare function isPrimitive(type: unknown): type is Primitive;
+
+export declare function isPrimitiveProps(props: Props): props is PrimitiveProps;
+
+export declare function isTimeProps(props: Props): props is TimeProps;
+
+export declare function isType(src: unknown, target: PropsType): boolean;
+
+export declare function isVueProps(props: Props): props is VueProps;
+
+export declare interface JSONProps extends BaseProps {
     type: PropsType.JSON;
 }
 
@@ -989,7 +1053,7 @@ export declare interface LoadProgressData {
     describe?: string;
 }
 
-declare type MixedProps = BaseProps & Partial<Omit<PrimitiveProps, "type">> & Partial<Omit<ColorProps, "type">> & Partial<Omit<JSONProps, "type">> & Partial<Omit<TimeProps, "type">> & Partial<Omit<EnumProps, "type">> & Partial<Omit<FunctionProps, "type">> & Partial<Omit<VueProps, "type">> & Partial<Omit<ExtendProps, "type">> & Partial<Omit<IconProps, "type">> & {
+export declare type MixedProps = BaseProps & Partial<Omit<PrimitiveProps, "type">> & Partial<Omit<ColorProps, "type">> & Partial<Omit<JSONProps, "type">> & Partial<Omit<TimeProps, "type">> & Partial<Omit<EnumProps, "type">> & Partial<Omit<FunctionProps, "type">> & Partial<Omit<VueProps, "type">> & Partial<Omit<ExtendProps, "type">> & Partial<Omit<IconProps, "type">> & {
     type: Array<PropsType>;
 };
 
@@ -1076,6 +1140,13 @@ declare class NodeTree {
 
 export declare const ParentView: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
+export declare function parseProp(propKey: string, prop: Props, parser: PropsGenerator, provider: ComponentProvider): unknown;
+
+/**
+ * @param [withoutUndefined=false] 是否过滤掉undefined的属性,default:false
+ */
+export declare function parseProps(newProps: Record<string, Props>, parser: PropsGenerator, provider: ComponentProvider, withoutUndefined?: boolean): Record<string, unknown>;
+
 export declare const placeholderNode: () => VNode<RendererNode, RendererElement, {
 [key: string]: any;
 }>;
@@ -1088,13 +1159,13 @@ export declare const placeholderRaw: () => RawComponent;
 /**
  * 基础数据类型的单个或者数组结构类型
  */
-declare interface PrimitiveProps extends BaseProps {
+export declare interface PrimitiveProps extends BaseProps {
     type: CombArray<PropsType.Number | PropsType.String | PropsType.Boolean | PropsType.Undefined | PropsType.Null | PropsType.Symbol | PropsType.BigInt>;
 }
 
-declare type Props = PrimitiveProps | ColorProps | JSONProps | TimeProps | EnumProps | FunctionProps | VueProps | ExtendProps | IconProps | MixedProps;
+export declare type Props = PrimitiveProps | ColorProps | JSONProps | TimeProps | EnumProps | FunctionProps | VueProps | ExtendProps | IconProps | MixedProps;
 
-declare interface PropsGenerator {
+export declare interface PropsGenerator {
     addParser(parser: PropsParser): this;
     addExtendParser(extendParser: ExtendPropsParser): this;
     getParsers(): PropsParser[];
@@ -1112,12 +1183,12 @@ export declare class PropsGeneratorImpl implements PropsGenerator {
     parse(props: Props): PropsValue | undefined;
 }
 
-declare interface PropsParser {
+export declare interface PropsParser {
     parse(value: Props): PropsValue;
     propsType(): PropsType;
 }
 
-declare enum PropsType {
+export declare enum PropsType {
     Number = "Number",
     String = "String",
     Boolean = "Boolean",
@@ -1141,7 +1212,7 @@ declare enum PropsType {
     Extend = "Extend"
 }
 
-declare type PropsValue = Props & {
+export declare type PropsValue = Props & {
     value: unknown;
 };
 
@@ -1267,6 +1338,11 @@ export declare interface Rect {
     y: number;
 }
 
+/**
+ * 注册默认UI组件内部事件
+ */
+export declare const registerEvents: (instanceId: string, raw: RawComponent, provider?: ComponentProvider) => Record<string, CallBackFn>;
+
 /**
  * 远程资源,贴图,视频等
  */
@@ -1306,6 +1382,16 @@ export declare type RendererConf = {
     clearColor: string;
 };
 
+export declare const Resize: DefineComponent<__VLS_Props_6, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+scaling: () => any;
+afterScale: () => any;
+"update:modelValue": (value: CSSProperties) => any;
+}, string, PublicProps, Readonly<__VLS_Props_6> & Readonly<{
+onScaling?: (() => any) | undefined;
+onAfterScale?: (() => any) | undefined;
+"onUpdate:modelValue"?: ((value: CSSProperties) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
 /**
  * tranlate rgb color to hex string
  */
@@ -1618,7 +1704,7 @@ export declare type ThreePanelConf = {
     lights: Array<LightMeta>;
 };
 
-declare interface TimeProps extends BaseProps {
+export declare interface TimeProps extends BaseProps {
     type: PropsType.Time;
     format?: string;
 }
@@ -1716,7 +1802,7 @@ export declare function useTarget(): Target;
 
 export declare const useVarState: () => ComponentVarState;
 
-declare enum ValueType {
+export declare enum ValueType {
     /**
      * 属性值为静态值
      */
@@ -1731,7 +1817,7 @@ declare enum ValueType {
     Remote = "Remote"
 }
 
-declare interface Variable {
+export declare interface Variable {
     /**
      * 唯一ID
      */
@@ -1755,11 +1841,11 @@ declare interface Variable {
     value: Ref<unknown> | Reactive<Array<unknown> | Record<string, unknown>>;
 }
 
-declare type VariableSerialized = Omit<Variable, "value"> & {
+export declare type VariableSerialized = Omit<Variable, "value"> & {
     value: any;
 };
 
-declare type VariableStatic = Omit<Variable, "id" | "value" | "type"> & Partial<Pick<Variable, "id">> & {
+export declare type VariableStatic = Omit<Variable, "id" | "value" | "type"> & Partial<Pick<Variable, "id">> & {
     value?: any;
 };
 
@@ -1774,13 +1860,13 @@ export declare class VarState implements ComponentVarState {
     deserialize(data: VariableSerialized[]): Variable[];
 }
 
-declare enum VarsType {
+export declare enum VarsType {
     Primitive = "Primitive",
     Object = "Object",
     Array = "Array"
 }
 
-declare interface VueProps extends BaseProps {
+export declare interface VueProps extends BaseProps {
     type: PropsType.Vue;
 }