Member Junction
    Preparing search index...

    Class MarkdownComponent

    Angular component for rendering markdown content.

    Features:

    • Prism.js syntax highlighting for code blocks
    • Mermaid diagram rendering
    • Copy-to-clipboard for code blocks
    • Collapsible heading sections
    • GitHub-style alerts and heading IDs

    Usage:

    <mj-markdown [data]="markdownContent"></mj-markdown>

    <mj-markdown
      [data]="content"
      [enableMermaid]="true"
      [enableCollapsibleHeadings]="true"
      (rendered)="onRendered($event)">
    </mj-markdown>

    Implements

    • OnChanges
    • AfterViewInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    autoExpandLevels? codeCopied collapsibleDefaultExpanded collapsibleHeadingLevel containerClass data enableAlerts enableCodeCopy enableCollapsibleHeadings enableHeadingIds enableHighlight enableHtml enableJavaScript enableLineNumbers enableMermaid enableSmartypants enableSvgRenderer headingClick headingIdPrefix mermaidTheme rendered renderedContent sanitize

    Accessors

    element

    Methods

    getHeadings ngAfterViewInit ngOnChanges ngOnDestroy refresh scrollToHeading

    Constructors

    Properties

    autoExpandLevels?: number[]

    Specify which heading levels should start expanded. Array of heading levels (2-6) that should be expanded by default. Takes precedence over collapsibleDefaultExpanded for specified levels.

    Examples:

    • [2] = Only h2 expanded, h3-h6 collapsed
    • [2, 3] = h2 and h3 expanded, h4-h6 collapsed
    • [] = All collapsed
    • undefined = Uses collapsibleDefaultExpanded for all levels
    codeCopied: EventEmitter<string> = ...

    Emitted when code is copied to clipboard

    collapsibleDefaultExpanded: boolean = DEFAULT_MARKDOWN_CONFIG.collapsibleDefaultExpanded

    Whether collapsible sections should be expanded by default

    collapsibleHeadingLevel: 1 | 2 | 3 | 4 | 5 | 6 = DEFAULT_MARKDOWN_CONFIG.collapsibleHeadingLevel

    Heading level at which to start collapsing

    containerClass: string = ''

    Custom CSS class for the container

    data: string = ''

    The markdown content to render

    enableAlerts: boolean = DEFAULT_MARKDOWN_CONFIG.enableAlerts

    Enable GitHub-style alerts

    enableCodeCopy: boolean = DEFAULT_MARKDOWN_CONFIG.enableCodeCopy

    Enable copy button on code blocks

    enableCollapsibleHeadings: boolean = DEFAULT_MARKDOWN_CONFIG.enableCollapsibleHeadings

    Enable collapsible heading sections

    enableHeadingIds: boolean = DEFAULT_MARKDOWN_CONFIG.enableHeadingIds

    Enable heading IDs for anchor links

    enableHighlight: boolean = DEFAULT_MARKDOWN_CONFIG.enableHighlight

    Enable syntax highlighting

    enableHtml: boolean = DEFAULT_MARKDOWN_CONFIG.enableHtml

    Enable raw HTML passthrough in markdown content. Scripts and event handlers are still stripped unless enableJavaScript is true.

    enableJavaScript: boolean = DEFAULT_MARKDOWN_CONFIG.enableJavaScript

    Enable JavaScript in HTML content (