dash_mp_components.Markdown

class dash_mp_components.Markdown(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, dedent: bool | None = None, loading_state: LoadingState | None = None, style: Any | None = None, **kwargs)[source]

Bases: Component

A Markdown component. A custom re-worked version of dcc.Markdown. Uses v6 of react-markdown and applies five plugins to the markdown component by default: - remark-gfm - remark-slug - remark-highlight.js - remark-math - rehype-katex

Keyword arguments:

  • children (string | list of strings; optional):

    A markdown string (or array of strings) that adhreres to the CommonMark spec.

  • id (string; optional):

    The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.

  • className (string; optional):

    Class name of the container element.

  • dedent (boolean; optional):

    Remove matching leading whitespace from all lines. Lines that are empty, or contain only whitespace, are ignored. Both spaces and tab characters are removed, but only if they match; we will not convert tabs to spaces or vice versa.

  • loading_state (dict; optional):

    Object that holds the loading state object coming from dash-renderer.

    loading_state is a dict with keys:

    • is_loading (boolean; optional):

      Determines if the component is loading or not.

    • prop_name (string; optional):

      Holds which property is loading.

    • component_name (string; optional):

      Holds the name of the component that is loading.

__init__(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, dedent: bool | None = None, loading_state: LoadingState | None = None, style: Any | None = None, **kwargs)

Methods

__init__([children, id, className, dedent, ...])

to_plotly_json()

Attributes

REQUIRED

UNDEFINED

available_wildcard_properties

class LoadingState

Bases: TypedDict