slightning-coco-widget
Version:
SLIGHTNING 的 CoCo 控件框架。
157 lines (156 loc) • 4.93 kB
TypeScript
/**
* 本文件内容来自 https://www.yuque.com/zaona/cp/widget_apis_v1#nC37P，有修改。
*/
import { widgetClass } from "./widget";
export type Types = {
type: string;
label: string;
icon: string;
visibleWidget: boolean;
category?: string | undefined;
default?: {
width?: number | undefined;
height?: number | undefined;
} | undefined;
color?: string | undefined;
emits: EmitTypes[];
methods: MethodTypes[];
props: PropTypes[];
noPropFlyout?: boolean | undefined;
staticWidget?: boolean | undefined;
noMovaable?: boolean | undefined;
global: boolean;
common?: boolean | undefined;
noPreprocess?: boolean | undefined;
rawBlocklyWidget?: boolean | undefined;
rawBlocks?: any | undefined;
rawFlyout?: any | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
noRender?: boolean | undefined;
noContextMenu?: boolean | undefined;
noWidgetsBoxItem?: boolean | undefined;
};
export type PropTypes = {
key: string;
label: string;
noBlock?: boolean | undefined;
rawProp?: string | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
changeCallback?: string | undefined;
extData?: any | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
noFlyout?: boolean | undefined;
justVisibleWidget?: boolean | undefined;
} & PropValueTypes;
export type PropValueTypes = AfferentValueTypes;
export type MethodTypes = {
key: string;
label?: string | undefined;
params: MethodParamTypes[];
static?: boolean | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
noPs?: boolean | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
noNs?: boolean | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
color?: string | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
tipBefore?: string | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
tipAfter?: string | undefined;
rawBlock?: any | undefined;
fn?: ((this: widgetClass, ...arg: any[]) => any) | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
padding?: number | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
flyoutOptions?: {
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
line?: string | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
gap?: number | undefined;
} | undefined;
rawBlocklyCheck?: any | undefined;
/**
* @deprecated 此属性已弃用。将在 v2 版本中删除
*/
tooltip?: string | undefined;
} & MethodValueTypes;
export type MethodParamTypes = {
key: string;
label?: string | undefined;
labelAfter?: string | undefined;
rawBlocklyCheck?: any | undefined;
dropdown?: [string, string][] | (() => [string, string][]) | undefined;
codeNotBreakLine?: boolean | undefined;
runtimeFn?: boolean | undefined;
cclType?: "string" | "boolean" | "number" | undefined;
} & MethodParamValueTypes;
export type MethodParamValueTypes = AfferentValueTypes | {
valueType: "any";
defaultValue?: number | string | boolean | null | object | undefined;
} | MutatorTypes | CodeTypes;
export type MutatorTypes = {
valueType: "mutator";
mutator?: MethodParamTypes[] | undefined;
mutatorMax?: number | undefined;
mutatorMin?: number | undefined;
mutatorItem?: number | undefined;
};
export type CodeTypes = {
valueType: "code";
codeParams?: MethodParamCodeParamTypes[] | undefined;
};
export type MethodParamCodeParamTypes = {
key: string;
label: string;
} & EfferentValueTypes;
export type MethodValueTypes = {
valueType?: ValueType | "code" | string | undefined;
};
export type EmitTypes = {
key: string;
label: string;
params: EmitParamTypes[];
};
export type EmitParamTypes = {
key: string;
label: string;
} & EmitParamValueTypes;
export type EmitParamValueTypes = EfferentValueTypes;
export type ValueType = "string" | "number" | "boolean" | "image" | "multiline_string" | "array" | "object" | "color" | "audio" | "video";
export type AfferentValueTypes = CommonAfferentValueTypes | DropdownTypes;
export type EfferentValueTypes = {
valueType: ValueType;
};
export type CommonAfferentValueTypes = {
valueType: ValueType;
defaultValue?: number | string | boolean | null | object | undefined;
};
export type DropdownTypes = {
valueType: "dropdown";
dropdown: [string, string][] | (() => [string, string][]);
};