Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INumberedHeading

Interface describing a numbered heading.

Hierarchy

Index

Properties

Properties

Optional html

html: string

Special HTML markup.

Notes
  • The HTML string should be properly sanitized!
  • The HTML string can be used to render Markdown headings which have already been rendered as HTML.

level

level: number

HTML heading level.

Optional numbering

numbering: string

Heading numbering.

onClick

onClick: () => void

Type declaration

    • (): void

    • Callback invoked upon clicking a ToC item.

      Notes
      • This will typically be used to scroll the parent widget to this item.

      Returns void

text

text: string

Heading text.

Generated using TypeDoc