Markdown Module
A component that renders Markdown text as specified by the GitHub Markdown spec. These component uses [react-markdown](https://remarkjs.github.io/react-markdown/) under the hood.
Types
| Type | Description |
A list of children or a property for this dash component |
|
|
record with the field: 'theme: value equal to: 'dark', 'light' (optional)' |
|
|
value equal to: 'dark', 'light' Color scheme; default 'light' |
|
|
A component that renders Markdown text as specified by the GitHub Markdown spec. These component uses [react-markdown](https://remarkjs.github.io/react-markdown/) under the hood. |
|
|
• className (string) - Class name of the container element • dangerously_allow_html (boolean; default false) - A boolean to control raw HTML escaping. Setting HTML from code is risky because it's easy to inadvertently expose your users to a cross-site scripting (XSS) (https://en.wikipedia.org/wiki/Cross-site_scripting) attack. • children (string | list with values of type: string) - A markdown string (or array of strings) that adhreres to the CommonMark spec • dedent (boolean; default true) - 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. • highlight_config (record with the field: 'theme: value equal to: 'dark', 'light' (optional)'; default {}) - Config options for syntax highlighting. gg/ • loading_state (record with the fields: 'is_loading: boolean (optional)', 'prop_name: string (optional)', 'component_name: string (optional)') - Object that holds the loading state object coming from dash-renderer • style (record) - User-defined inline styles for the rendered Markdown |
Functions and values
| Function or value | Description |
Full Usage:
Markdown.markdown id attrs
Parameters:
string
attrs : Attr list
Returns: DashComponent
|
A component that renders Markdown text as specified by the GitHub Markdown spec. These component uses [react-markdown](https://remarkjs.github.io/react-markdown/) under the hood. Properties: • id (string) - 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) - Class name of the container element • dangerously_allow_html (boolean; default false) - A boolean to control raw HTML escaping. Setting HTML from code is risky because it's easy to inadvertently expose your users to a cross-site scripting (XSS) (https://en.wikipedia.org/wiki/Cross-site_scripting) attack. • children (string | list with values of type: string) - A markdown string (or array of strings) that adhreres to the CommonMark spec • dedent (boolean; default true) - 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. • highlight_config (record with the field: 'theme: value equal to: 'dark', 'light' (optional)'; default {}) - Config options for syntax highlighting. • loading_state (record with the fields: 'is_loading: boolean (optional)', 'prop_name: string (optional)', 'component_name: string (optional)') - Object that holds the loading state object coming from dash-renderer • style (record) - User-defined inline styles for the rendered Markdown
|