@vtj / Modules / designer

Module: designer

Table of contents

Enumerations

• RegionType
• WidgetGroup

Classes

• Assets
• Designer
• Engine
• Renderer
• Simulator

Interfaces

• AppWidget
• AssetGroup
• DesignHelper
• EngineOptions
• Setter
• SimulatorEnv
• SimulatorOptions
• TabWidget
• VtjElement
• Widget

Type Aliases

• RegionWrapperInstance
• SkeletonWrapperInstance
• VueComponent
• WidgetWrapperInstance

Variables

• API_METHOD_TYPES
• Binder
• Box
• EVENT_MODIFIERS
• Editor
• EventBinder
• Icon
• Item
• KEYBOARD_EVENT_LIST
• MOBILE_SIZE
• MOUSE_EVENT_LIST
• NAME_REGEX
• PAD_SIZE
• Panel
• RegionWrapper
• SetterView
• SetterWrapper
• Skeleton
• SkeletonWrapper
• SlotsPicker
• Tabs
• VTJ_DESIGNER_VERSION
• VariableBinder
• Viewer
• Viewport
• WidgetWrapper
• builtInDeps
• builtInMaterials
• builtInSetters
• builtInWidgets
• defaultSetter
• depsManager
• engineKey
• regions
• setterManager
• setters
• widgetManager
• widgets

Functions

• confirm
• createSlotsPicker
• expressionValidate
• message
• notify
• useEngine

Type Aliases

RegionWrapperInstance

Ƭ RegionWrapperInstance: InstanceType<typeof RegionWrapper>

Defined in

packages/designer/types/wrappers/region.d.ts:16

---

SkeletonWrapperInstance

Ƭ SkeletonWrapperInstance: InstanceType<typeof SkeletonWrapper>

Defined in

packages/designer/types/wrappers/skeleton.d.ts:79

---

VueComponent

Ƭ VueComponent: Record<string, any> | VNode | DefineComponent<any, any, any, any>

Defined in

packages/designer/types/framework/types.d.ts:4

---

WidgetWrapperInstance

Ƭ WidgetWrapperInstance: InstanceType<typeof WidgetWrapper>

Defined in

packages/designer/types/wrappers/widget.d.ts:25

Variables

API_METHOD_TYPES

• Const API_METHOD_TYPES: string[]

api请求方法

Defined in

packages/designer/types/constants.d.ts:24

---

Binder

• Const Binder: __VLS_WithTemplateSlots<DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { cancel: (...args: any[]) => void ; close: (...args: any[]) => void ; pick: (...args: any[]) => void ; submit: (...args: any[]) => void ; unbind: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>> & { onCancel?: (...args: any[]) => any ; onClose?: (...args: any[]) => any ; onPick?: (...args: any[]) => any ; onSubmit?: (...args: any[]) => any ; onUnbind?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, {}, {}>, { default?: (_: {}) => any }>

Defined in

packages/designer/types/components/shared/binder.d.ts:15

---

Box

• Const Box: DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { dragend: (...args: any[]) => void ; dragstart: (...args: any[]) => void ; edit: (...args: any[]) => void ; remove: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>> & { onDragend?: (...args: any[]) => any ; onDragstart?: (...args: any[]) => any ; onEdit?: (...args: any[]) => any ; onRemove?: (...args: any[]) => any }, {}, {}>

Defined in

packages/designer/types/components/shared/box.d.ts:11

---

EVENT_MODIFIERS

• Const EVENT_MODIFIERS: string[]

事件修饰符

Defined in

packages/designer/types/constants.d.ts:28

---

Editor

• Const Editor: DefineComponent<{ border: { type: PropType<boolean> } ; dark: { default: boolean ; type: PropType<boolean> } ; height: { default: string ; type: PropType<string> } ; lang: { default: string ; type: PropType<string> } ; minimap: { default: boolean ; type: PropType<boolean> } ; modelValue: { default: string ; type: PropType<string> } ; options: { default: () => {} ; type: PropType<editor.IEditorConstructionOptions> } ; readonly: { default: boolean ; type: PropType<boolean> } }, { getEditor: () => editor.IStandaloneCodeEditor | null }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { blur: (...args: any[]) => void ; change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ border: { type: PropType<boolean> } ; dark: { default: boolean ; type: PropType<boolean> } ; height: { default: string ; type: PropType<string> } ; lang: { default: string ; type: PropType<string> } ; minimap: { default: boolean ; type: PropType<boolean> } ; modelValue: { default: string ; type: PropType<string> } ; options: { default: () => {} ; type: PropType<editor.IEditorConstructionOptions> } ; readonly: { default: boolean ; type: PropType<boolean> } }>> & { onBlur?: (...args: any[]) => any ; onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { dark: boolean ; height: string ; lang: string ; minimap: boolean ; modelValue: string ; options: editor.IEditorConstructionOptions ; readonly: boolean }, {}>

Defined in

packages/designer/types/components/editor/index.d.ts:2

---

EventBinder

• Const EventBinder: DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>>, {}, {}>

Defined in

packages/designer/types/components/binders/event.d.ts:11

---

Icon

• Const Icon: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { active: boolean ; open: boolean }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { click: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { active: boolean ; open: boolean }>>> & { onClick?: (...args: any[]) => any }, { active: boolean ; open: boolean }, {}>

Defined in

packages/designer/types/components/shared/Icon.d.ts:10

---

Item

• Const Item: __VLS_WithTemplateSlots<DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { actions: () => never[] }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { action: (...args: any[]) => void ; click: (...args: any[]) => void ; switch: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { actions: () => never[] }>>> & { onAction?: (...args: any[]) => any ; onClick?: (...args: any[]) => any ; onSwitch?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { actions: ("add" | "copy" | "invisible" | "visible" | "remove" | "edit" | "lock" | "unlock" | "home")[] }, {}>, { default?: (_: {}) => any ; status?: (_: {}) => any }>

Defined in

packages/designer/types/components/shared/item.d.ts:56

---

KEYBOARD_EVENT_LIST

• Const KEYBOARD_EVENT_LIST: string[]

键盘事件

Defined in

packages/designer/types/constants.d.ts:20

---

MOBILE_SIZE

• Const MOBILE_SIZE: Object

Type declaration

Name	Type
height	number
width	number

Defined in

packages/designer/types/constants.d.ts:1

---

MOUSE_EVENT_LIST

• Const MOUSE_EVENT_LIST: string[]

鼠标事件列表

Defined in

packages/designer/types/constants.d.ts:16

---

NAME_REGEX

• Const NAME_REGEX: RegExp

名称正则表达式

Defined in

packages/designer/types/constants.d.ts:12

---

PAD_SIZE

• Const PAD_SIZE: Object

Type declaration

Name	Type
height	number
width	number

Defined in

packages/designer/types/constants.d.ts:5

---

Panel

• Const Panel: __VLS_WithTemplateSlots<DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { header: boolean }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { back: (...args: any[]) => void ; edit: (...args: any[]) => void ; plus: (...args: any[]) => void ; remove: (...args: any[]) => void ; save: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { header: boolean }>>> & { onBack?: (...args: any[]) => any ; onEdit?: (...args: any[]) => any ; onPlus?: (...args: any[]) => any ; onRemove?: (...args: any[]) => any ; onSave?: (...args: any[]) => any }, { header: boolean }, {}>, { actions?: (_: {}) => any ; default?: (_: {}) => any ; footer?: (_: {}) => any }>

Defined in

packages/designer/types/components/shared/panel.d.ts:13

---

RegionWrapper

• Const RegionWrapper: DefineComponent<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }, { regionRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, {}, {}>

Defined in

packages/designer/types/wrappers/region.d.ts:3

---

SetterView

• Const SetterView: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { label: string ; options: () => never[] ; variable: boolean }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; remove: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { label: string ; options: () => never[] ; variable: boolean }>>> & { onChange?: (...args: any[]) => any ; onRemove?: (...args: any[]) => any }, { label: string ; options: any[] ; variable: boolean }, {}>

Defined in

packages/designer/types/components/setter.d.ts:18

---

SetterWrapper

• Const SetterWrapper: DefineComponent<{ context: { default: null ; type: PropType<Context | null> } ; current: { default: null ; type: PropType<BlockModel | null> } ; label: StringConstructor ; name: StringConstructor ; options: { type: ArrayConstructor ; default: () => never[] } ; removable: { default: boolean ; type: BooleanConstructor } ; setters: { required: true ; type: PropType<string | MaterialSetter | (string | MaterialSetter)[]> ; default: () => never[] } ; title: StringConstructor ; value: { default: undefined ; type: (BooleanConstructor | StringConstructor | ObjectConstructor | ArrayConstructor | NumberConstructor)[] } ; variable: { default: boolean ; type: BooleanConstructor } }, unknown, unknown, { computedOptions: () => unknown[] ; computedSetters: () => { component: any ; label: string ; name: string ; props: Record<string, any> }[] ; defaultSetter: () => string }, { changeValue: (val: any) => void ; getSetter: (name: string | Setter) => Setter ; onRemove: (name: string) => void }, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "remove")[], "change" | "remove", PublicProps, Readonly<ExtractPropTypes<{ context: { default: null ; type: PropType<Context | null> } ; current: { default: null ; type: PropType<BlockModel | null> } ; label: StringConstructor ; name: StringConstructor ; options: { type: ArrayConstructor ; default: () => never[] } ; removable: { default: boolean ; type: BooleanConstructor } ; setters: { required: true ; type: PropType<string | MaterialSetter | (... | ...)[]> ; default: () => never[] } ; title: StringConstructor ; value: { default: undefined ; type: (BooleanConstructor | StringConstructor | ObjectConstructor | ArrayConstructor | NumberConstructor)[] } ; variable: { default: boolean ; type: BooleanConstructor } }>> & { onChange?: (...args: any[]) => any ; onRemove?: (...args: any[]) => any }, { context: Context | null ; current: BlockModel | null ; options: unknown[] ; removable: boolean ; setters: string | MaterialSetter | (string | MaterialSetter)[] ; value: string | number | boolean | Record<string, any> | unknown[] ; variable: boolean }, {}>

Defined in

packages/designer/types/wrappers/setter.d.ts:6

---

Skeleton

• Const Skeleton: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { footerHeight: string ; headerHeight: string ; leftWidth: string ; rightWidth: string }>, { actions: Ref<any> ; apps: Ref<any> ; brand: Ref<any> ; collapsed: Ref<boolean> ; isPreview: Ref<boolean> ; leftWidth: Ref<number> ; preview: Ref<any> ; rightWidth: Ref<number> ; settable: Ref<boolean> ; settings: Ref<any> ; status: Ref<any> ; toolbar: Ref<any> ; workspace: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { footerHeight: string ; headerHeight: string ; leftWidth: string ; rightWidth: string }>>>, { footerHeight: string ; headerHeight: string ; leftWidth: string ; rightWidth: string }, {}>

Defined in

packages/designer/types/components/skeleton.d.ts:8

---

SkeletonWrapper

• Const SkeletonWrapper: DefineComponent<{}, { engine: ShallowReactive<Engine> ; skeletonRef: Ref<any> ; widgets: Ref<Record<string, CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<...> } ; widget: { required: true ; type: PropType<...> } }>>, {}, true, {}, {}, { B: {} ; C: {} ; D: {} ; Defaults: {} ; M: {} ; P: {} }, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>>> }, {}, {}, { closePreview: () => void ; getRegion: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<"Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview"> } }>>, { regionRef: Ref<any> }, {}, {}, {}, {}> ; getWidget: (name: string) => undefined | CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}> ; getWidgets: (region: "Brand" | "Toolbar" | "Actions" | "Apps" | "Workspace" | "Settings" | "Status" | "Preview") => CreateComponentPublicInstance<Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, {}, true, {}, {}, OptionTypesType<{}, {}, {}, {}, {}, {}>, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, { widgetRef: Ref<any> }, {}, {}, {}, {}>[] ; openPreview: (_id: string) => void ; settable: (val: boolean) => void ; toggleCollapse: (value?: boolean) => void }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>

Defined in

packages/designer/types/wrappers/skeleton.d.ts:6

---

SlotsPicker

• Const SlotsPicker: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { slots: () => never[] }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { submit: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { slots: () => never[] }>>> & { onSubmit?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { slots: MaterialSlot[] }, {}>

Defined in

packages/designer/types/components/shared/slots.d.ts:7

---

Tabs

• Const Tabs: __VLS_WithTemplateSlots<DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { items: () => never[] }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { action-click: (...args: any[]) => void ; command: (...args: any[]) => void ; remove: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { items: () => never[] }>>> & { onAction-click?: (...args: any[]) => any ; onCommand?: (...args: any[]) => any ; onRemove?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { items: TabsItem[] }, {}>, { default?: (_: {}) => any }>

Defined in

packages/designer/types/components/shared/tabs.d.ts:11

---

VTJ_DESIGNER_VERSION

• Const VTJ_DESIGNER_VERSION: "0.8.7"

! Copyright (c) 2024, VTJ.PRO All rights reserved.

Name

@vtj/designer

Author

CHC chenhuachun1549@dingtalk.com

Version

0.8.7

License

MIT License

Defined in

packages/designer/types/version.d.ts:8

---

VariableBinder

• Const VariableBinder: DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>>, {}, {}>

Defined in

packages/designer/types/components/binders/variable.d.ts:10

---

Viewer

• Const Viewer: DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { copy: (...args: any[]) => void ; pick: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>> & { onCopy?: (...args: any[]) => any ; onPick?: (...args: any[]) => any }, {}, {}>

Defined in

packages/designer/types/components/shared/viewer.d.ts:7

---

Viewport

• Const Viewport: __VLS_WithTemplateSlots<DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { mode: string }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, { mode: string }>>>, { mode: "pc" | "mobile" | "pad" }, {}>, { default?: (_: {}) => any }>

Defined in

packages/designer/types/components/shared/viewport.d.ts:7

---

WidgetWrapper

• Const WidgetWrapper: DefineComponent<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }, { widgetRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } ; widget: { required: true ; type: PropType<Widget> } }>>, {}, {}>

Defined in

packages/designer/types/wrappers/widget.d.ts:4

---

builtInDeps

• Const builtInDeps: Dependencie[]

Defined in

packages/designer/types/managers/built-in/deps.d.ts:3

---

builtInMaterials

• Const builtInMaterials: Material[]

Defined in

packages/designer/types/managers/built-in/materials.d.ts:3

---

builtInSetters

• Const builtInSetters: Setter[]

Defined in

packages/designer/types/managers/built-in/setters.d.ts:4

---

builtInWidgets

• Const builtInWidgets: (AppWidget | TabWidget | Widget)[]

Defined in

packages/designer/types/managers/built-in/widgets.d.ts:3

---

defaultSetter

• Const defaultSetter: Setter

Defined in

packages/designer/types/managers/built-in/setters.d.ts:3

---

depsManager

• Const depsManager: DepsManager

Defined in

packages/designer/types/managers/deps.d.ts:33

---

engineKey

• Const engineKey: InjectionKey<ShallowReactive<Engine>>

Defined in

packages/designer/types/framework/engine.d.ts:8

---

regions

• Const regions: Object

Type declaration

Name	Type
Actions	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
Apps	DefineComponent<{ index: { default: number ; type: PropType<number> } ; region: { required: true ; type: PropType<RegionType> } }, { setActive: (name: string) => void ; widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ index: { default: number ; type: PropType<number> } ; region: { required: true ; type: PropType<RegionType> } }>>, { index: number }, {}>
Brand	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
EmptyRegion	DefineComponent<{ region: { required: true ; type: PropType<string> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<string> } }>>, {}, {}>
Preview	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { currentTab: Ref<string> ; widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
Settings	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
Status	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
Toolbar	DefineComponent<{ preview: { type: PropType<boolean> } ; region: { required: true ; type: PropType<RegionType> } }, { widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ preview: { type: PropType<boolean> } ; region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>
Workspace	DefineComponent<{ region: { required: true ; type: PropType<RegionType> } }, { currentTab: Ref<string> ; openTab: (name: string, props?: Record<string, any>) => void ; widgets: ComputedRef<Widget[]> ; widgetsRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ region: { required: true ; type: PropType<RegionType> } }>>, {}, {}>

Defined in

packages/designer/types/components/regions/index.d.ts:3

---

setterManager

• Const setterManager: SetterManager

Defined in

packages/designer/types/managers/setter.d.ts:29

---

setters

• Const setters: Object

Type declaration

Name	Type
BooleanSetter	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
ColorSetter	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
ExpressionSetter	DefineComponent<{ context: { type: PropType<Context> } ; modelValue: { type: PropType<string | JSExpression> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ context: { type: PropType<Context> } ; modelValue: { type: PropType<string | JSExpression> } }>> & { onChange?: (...args: any[]) => any }, {}, {}>
FileSetter	DefineComponent<{ attachment: { type: PropType<Record<string, any>> } ; modelValue: { type: PropType<string> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ attachment: { type: PropType<Record<string, any>> } ; modelValue: { type: PropType<string> } }>> & { onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, {}, {}>
FunctionSetter	DefineComponent<{ modelValue: { default: () => { type: string ; value: string } ; type: PropType<JSFunction> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { default: () => { type: string ; value: string } ; type: PropType<JSFunction> } }>> & { onChange?: (...args: any[]) => any }, { modelValue: JSFunction }, {}>
IconSetter	DefineComponent<{ modelValue: { default: string ; type: PropType<string> } ; size: { default: string ; type: PropType<"" | "default" | "small" | "large"> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { default: string ; type: PropType<string> } ; size: { default: string ; type: PropType<"" | "default" | "small" | "large"> } }>> & { onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { modelValue: string ; size: "" | "default" | "small" | "large" }, {}>
ImageSetter	DefineComponent<{ limit: { default: number ; type: PropType<number> } ; modelValue: { type: PropType<any> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ limit: { default: number ; type: PropType<number> } ; modelValue: { type: PropType<any> } }>> & { onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { limit: number }, {}>
JsonSetter	DefineComponent<{ modelValue: { default: undefined ; type: PropType<any> } ; type: { default: string ; type: PropType<"Array" | "Object" | "JSON"> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { default: undefined ; type: PropType<any> } ; type: { default: string ; type: PropType<"Array" | "Object" | "JSON"> } }>> & { onChange?: (...args: any[]) => any }, { modelValue: any ; type: "Array" | "Object" | "JSON" }, {}>
NumberSetter	DefineComponent<{ modelValue: { type: PropType<any> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { type: PropType<any> } }>> & { onChange?: (...args: any[]) => any }, {}, {}>
RadioSetter	DefineComponent<{ options: { default: () => never[] ; type: PropType<{ label: string ; svg?: string ; value: any }[]> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ options: { default: () => never[] ; type: PropType<{ label: string ; svg?: string ; value: any }[]> } }>>, { options: { label: string ; svg?: string ; value: any }[] }, {}>
SectionSetter	DefineComponent<{ modelValue: { type: PropType<string> } ; sections: { default: number ; type: PropType<number> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { type: PropType<string> } ; sections: { default: number ; type: PropType<number> } }>> & { onChange?: (...args: any[]) => any }, { sections: number }, {}>
SelectSetter	DefineComponent<{ options: { default: () => never[] ; type: PropType<{ label: string ; value: any }[]> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ options: { default: () => never[] ; type: PropType<{ label: string ; value: any }[]> } }>>, { options: { label: string ; value: any }[] }, {}>
SizeSetter	DefineComponent<{ modelValue: { type: PropType<string> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { type: PropType<string> } }>> & { onChange?: (...args: any[]) => any }, {}, {}>
SliderSetter	DefineComponent<{ modelValue: { default: undefined ; type: PropType<number | number[]> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { default: undefined ; type: PropType<number | number[]> } }>> & { onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { modelValue: number | number[] }, {}>
StringSetter	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
TagSetter	DefineComponent<{ modelValue: { type: PropType<any> } ; options: { default: () => never[] ; type: PropType<{ label: string ; svg?: string ; value: any }[]> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (...args: any[]) => void ; update:modelValue: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ modelValue: { type: PropType<any> } ; options: { default: () => never[] ; type: PropType<{ label: string ; svg?: ... | ... ; value: any }[]> } }>> & { onChange?: (...args: any[]) => any ; onUpdate:modelValue?: (...args: any[]) => any }, { options: { label: string ; svg?: string ; value: any }[] }, {}>

Defined in

packages/designer/types/components/setters/index.d.ts:4

---

widgetManager

• Const widgetManager: WidgetManager

Defined in

packages/designer/types/managers/widget.d.ts:36

---

widgets

• Const widgets: Object

Type declaration

Name	Type
About	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Actions	DefineComponent<{ coder: { default: boolean ; type: PropType<boolean> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ coder: { default: boolean ; type: PropType<boolean> } }>>, { coder: boolean }, {}>
Apis	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Blocks	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Components	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Css	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
DataSources	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Defined	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Deps	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Designer	DefineComponent<{}, { designer: ComputedRef<Designer | null> ; mode: ComputedRef<any> }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Directives	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Docs	DefineComponent<{ url: { default: string ; type: PropType<string> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ url: { default: string ; type: PropType<string> } }>>, { url: string }, {}>
EmptyWidget	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Events	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
History	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Logo	DefineComponent<{ icon: { type: PropType<string> } ; link: { type: PropType<string> } ; text: { default: string ; type: PropType<string> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ icon: { type: PropType<string> } ; link: { type: PropType<string> } ; text: { default: string ; type: PropType<string> } }>>, { text: string }, {}>
NodePath	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Outline	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Pages	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Previewer	DefineComponent<{ path: { type: PropType<(block: BlockModel) => string> } }, { refresh: () => void }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ path: { type: PropType<(block: BlockModel) => string> } }>>, {}, {}>
ProjectConfig	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Properties	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Raw	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Schema	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Scripts	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>
Style	DefineComponent<{ isStyleCodeMode: { required: true ; type: PropType<boolean> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ isStyleCodeMode: { required: true ; type: PropType<boolean> } }>>, {}, {}>
Switcher	DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { click: (...args: any[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{}>> & { onClick?: (...args: any[]) => any }, {}, {}>
Toolbar	DefineComponent<{ preview: { type: PropType<boolean> } }, { mode: Ref<string> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ preview: { type: PropType<boolean> } }>>, {}, {}>

Defined in

packages/designer/types/components/widgets/index.d.ts:4

Functions

confirm

▸ confirm(message): Promise<boolean | MessageBoxData>

Parameters

Name	Type
message	string

Returns

Promise<boolean | MessageBoxData>

Defined in

packages/designer/types/utils.d.ts:5

---

createSlotsPicker

▸ createSlotsPicker(slots): Promise<MaterialSlot>

Parameters

Name	Type
slots	MaterialSlot[]

Returns

Promise<MaterialSlot>

Defined in

packages/designer/types/framework/designer.d.ts:6

---

expressionValidate

▸ expressionValidate(str, self, thisRequired?): boolean

Parameters

Name	Type
str	JSExpression | JSFunction
self	any
thisRequired?	boolean

Returns

boolean

Defined in

packages/designer/types/utils.d.ts:7

---

message

▸ message(message, type?): MessageHandler

Parameters

Name	Type
message	string
type?	"success" | "warning"

Returns

MessageHandler

Defined in

packages/designer/types/utils.d.ts:6

---

notify

▸ notify(message, title?): NotificationHandle

Parameters

Name	Type
message	string
title?	string

Returns

NotificationHandle

Defined in

packages/designer/types/utils.d.ts:4

---

useEngine

▸ useEngine(): ShallowReactive<Engine>

Returns

ShallowReactive<Engine>

Defined in

packages/designer/types/framework/engine.d.ts:57