Header menu logo Nao

Block Type

Block-level content node. The body of a document is built from these.

Union cases

Union case Description

BlockRaw(format, data)

Full Usage: BlockRaw(format, data)

Parameters:
    format : string
    data : string

Escape hatch for format-specific block content the model doesn't capture.

format : string
data : string

CodeBlock(language, code)

Full Usage: CodeBlock(language, code)

Parameters:
    language : string option
    code : string

A fenced code block with an optional language hint.

language : string option
code : string

Container ContainerSpec

Full Usage: Container ContainerSpec

Parameters:

A layout container holding explicitly-placed children.

Item : ContainerSpec

Heading(level, inlines)

Full Usage: Heading(level, inlines)

Parameters:
    level : int
    inlines : Inline list

A heading of the given level (1 = top level).

level : int
inlines : Inline list

ListBlock ListSpec

Full Usage: ListBlock ListSpec

Parameters:

An ordered or unordered list.

Item : ListSpec

Media MediaSpec

Full Usage: Media MediaSpec

Parameters:

A block-level media embed (image / video / audio) referencing a resource.

Item : MediaSpec

Paragraph(inlines, align)

Full Usage: Paragraph(inlines, align)

Parameters:

A paragraph of inline content with an optional alignment override.

inlines : Inline list
align : TextAlign option

Quote Block list

Full Usage: Quote Block list

Parameters:

A block quote containing nested blocks.

Item : Block list

Table TableSpec

Full Usage: Table TableSpec

Parameters:

A table.

Item : TableSpec

ThematicBreak

Full Usage: ThematicBreak

A horizontal rule / section divider.

Instance members

Instance member Description

this.IsBlockRaw

Full Usage: this.IsBlockRaw

Returns: bool
Returns: bool

this.IsCodeBlock

Full Usage: this.IsCodeBlock

Returns: bool
Returns: bool

this.IsContainer

Full Usage: this.IsContainer

Returns: bool
Returns: bool

this.IsHeading

Full Usage: this.IsHeading

Returns: bool
Returns: bool

this.IsListBlock

Full Usage: this.IsListBlock

Returns: bool
Returns: bool

this.IsMedia

Full Usage: this.IsMedia

Returns: bool
Returns: bool

this.IsParagraph

Full Usage: this.IsParagraph

Returns: bool
Returns: bool

this.IsQuote

Full Usage: this.IsQuote

Returns: bool
Returns: bool

this.IsTable

Full Usage: this.IsTable

Returns: bool
Returns: bool

this.IsThematicBreak

Full Usage: this.IsThematicBreak

Returns: bool
Returns: bool

Type something to start searching.