Interface: JsxComponentDescriptor

Defines the structure of a JSX component that can be used within the markdown document.

Table of contents

Properties

Properties

Editor

Editor: ComponentType<JsxEditorProps>

The editor to use for editing the component


defaultExport

Optional defaultExport: boolean

Wether the component is the default export of the module


hasChildren

Optional hasChildren: boolean

Wether or not the component has children


kind

kind: "text" | "flow"

Wether the component is a flow or text component (inline or block)


name

name: string

The tag name


props

props: JsxPropertyDescriptor[]

The properties that can be applied to the component


source

Optional source: string

The module path from which the component can be imported Omit to skip injecting an import statement