@vtj • Docs

---

@vtj / core / MaterialDescription

Interface: MaterialDescription

Properties

alias?

optional alias: string

组件别名，即组件库导出的原始名称 如 import { Button } from 'ant-design-vue'

Defined in

packages/core/src/protocols/assets/material.ts:60

---

categoryId?

optional categoryId: string | number

分类Id

Defined in

packages/core/src/protocols/assets/material.ts:91

---

childIncludes?

optional childIncludes: boolean | string[]

只能允许哪些子组件， 如果不设置，则表示可以放置任何子组件, false表示不能放置在任何子组件

Defined in

packages/core/src/protocols/assets/material.ts:121

---

doc?

optional doc: string

组件文档Url

Defined in

packages/core/src/protocols/assets/material.ts:86

---

events?

optional events: (string | MaterialEvent)[]

组件支持事件

Defined in

packages/core/src/protocols/assets/material.ts:101

---

from?

optional from: NodeFrom

组件来源

Defined in

packages/core/src/protocols/assets/material.ts:131

---

hidden?

optional hidden: boolean

不显示在组件面板

Defined in

packages/core/src/protocols/assets/material.ts:126

---

icon?

optional icon: string

组件预览图标

Defined in

packages/core/src/protocols/assets/material.ts:76

---

id?

optional id: string

Block Id

Defined in

packages/core/src/protocols/assets/material.ts:136

---

label?

optional label: string

组件中文名称描述

Defined in

packages/core/src/protocols/assets/material.ts:81

---

name

name: string

组件名称

Defined in

packages/core/src/protocols/assets/material.ts:55

---

package?

optional package: string

所属包名

Defined in

packages/core/src/protocols/assets/material.ts:141

---

parent?

optional parent: string

组件库导出的名称 如 import { Button } from 'ant-design-vue' parent: Button alias: Group name: AButtonGroup const AButtonGroup = Button.Group; 当 parent 有值时 alias 可以设置多级，如 Group.Item

Defined in

packages/core/src/protocols/assets/material.ts:71

---

parentIncludes?

optional parentIncludes: boolean | string[]

只能放置在哪些组件内， 如果不设置，则表示可以放置在任何组件内, false表示不能放置在任何组件内

Defined in

packages/core/src/protocols/assets/material.ts:116

---

props?

optional props: MaterialProp[]

组件支持属性，待定义

Defined in

packages/core/src/protocols/assets/material.ts:96

---

slots?

optional slots: (string | MaterialSlot)[]

组件支持的插槽

Defined in

packages/core/src/protocols/assets/material.ts:106

---

snippet?

optional snippet: Partial<NodeSchema>

初始化时的低代码片段

Defined in

packages/core/src/protocols/assets/material.ts:111