InlineMarkdownSpecOptions

@blockslides/core

---

@blockslides/core / InlineMarkdownSpecOptions

Interface: InlineMarkdownSpecOptions

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:43

Properties

nodeName

nodeName: string

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:45

The Tiptap node name this spec is for

---

name?

optional name: string

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:47

The shortcode name (defaults to nodeName if not provided)

---

getContent()?

optional getContent: (node) => string

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:49

Function to extract content from the node for serialization

Parameters

node

any

Returns

string

---

parseAttributes()?

optional parseAttributes: (attrString) => Record<string, any>

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:51

Function to parse attributes from the attribute string

Parameters

attrString

string

Returns

Record<string, any>

---

serializeAttributes()?

optional serializeAttributes: (attrs) => string

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:53

Function to serialize attributes to string

Parameters

attrs

Record<string, any>

Returns

string

---

defaultAttributes?

optional defaultAttributes: Record<string, any>

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:55

Default attributes to apply when parsing

---

selfClosing?

optional selfClosing: boolean

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:57

Whether this is a self-closing shortcode (no content, like [emoji name=party])

---

allowedAttributes?

optional allowedAttributes: string[]

Defined in: blockslides/packages/core/src/utilities/markdown/createInlineMarkdownSpec.ts:59

Allowlist of attributes to include in markdown (if not provided, all attributes are included)