This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#711](https://github.com/plotly/dash-core-components/pull/711) Added support for `dcc.Link` (dccLink) and nested `dcc.Markdown` (dccMarkdown) react components inside of `dcc.Markdown`
- [#706](https://github.com/plotly/dash-core-components/pull/706)
- Added new `responsive` property that overrides the underlying Plotly.js graph responsiveness from Dash-land
- Added responsiveness on graph parent element resize (previously only worked on window.resize)
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
include dash_core_components/dash_core_components.min.js
include dash_core_components/dash_core_components.min.js.map
include dash_core_components/dash_core_components-shared.js
include dash_core_components/dash_core_components-shared.js.map
include dash_core_components/async~*.js
include dash_core_components/async~*.js.map
include dash_core_components/highlight.pack.js
include dash_core_components/metadata.json
include dash_core_components/package-info.json
include dash_core_components/plotly.min.js
Expand Down
4 changes: 1 addition & 3 deletions babel.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,7 @@ const presets = [
];

const plugins = [
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'@babel/plugin-transform-runtime'
'@babel/plugin-syntax-dynamic-import'
];

// eslint-disable-next-line no-process-env
Expand Down
17 changes: 17 additions & 0 deletions dash_core_components_base/__init__.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,23 @@
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': '{}-shared.js'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js'
).format(__version__),
'namespace': 'dash_core_components'
},
{
'relative_package_path': '{}-shared.js.map'.format(__name__),
'external_url': (
'https://unpkg.com/dash-core-components@{}'
'/dash_core_components/dash_core_components-shared.js.map'
).format(__version__),
'namespace': 'dash_core_components',
'dynamic': True
},
{
'relative_package_path': 'plotly.min.js',
'external_url': (
Expand Down
82 changes: 27 additions & 55 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,6 @@
"@babel/core": "^7.4.0",
"@babel/plugin-proposal-object-rest-spread": "^7.4.0",
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
"@babel/plugin-transform-async-to-generator": "^7.7.4",
"@babel/plugin-transform-runtime": "^7.7.6",
"@babel/preset-env": "^7.4.1",
"@babel/preset-react": "^7.0.0",
"@plotly/dash-component-plugins": "^1.0.2",
Expand All@@ -85,6 +83,8 @@
"prettier": "^1.14.2",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-jsx-parser": "^1.21.0",
"react-resize-detector": "^4.2.1",
"style-loader": "^0.23.1",
"styled-jsx": "^3.1.1",
"terser-webpack-plugin": "^2.3.0",
Expand Down
2 changes: 1 addition & 1 deletion src/fragments/Graph.react.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,7 +270,7 @@ class PlotlyGraph extends Component {
);
}

async graphResize(force = false) {
graphResize(force = false) {
if (!force && !this.isResponsive(this.props)) {
return;
}
Expand Down
29 changes: 28 additions & 1 deletion src/fragments/Markdown.react.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
import React, {Component} from 'react';
import {type} from 'ramda';
import {mergeDeepRight, pick, type} from 'ramda';
import JsxParser from 'react-jsx-parser';
import Markdown from 'react-markdown';

import MarkdownHighlighter from '../utils/MarkdownHighlighter';
import {propTypes, defaultProps} from '../components/Markdown.react';

import DccLink from './../components/Link.react';

export default class DashMarkdown extends Component {
constructor(props) {
super(props);
Expand DownExpand Up@@ -91,6 +94,18 @@ export default class DashMarkdown extends Component {
const displayText =
dedent && textProp ? this.dedent(textProp) : textProp;

const componentTransforms = {
dccLink: props => <DccLink {...props} />,
dccMarkdown: props => (
<Markdown
{...mergeDeepRight(
pick(['dangerously_allow_html', 'dedent'], this.props),
pick(['children'], props)
)}
/>
),
};

@Marc-Andre-RivetMarc-Andre-RivetDec 3, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we define the list of components we want to support are their name in markdown + props customization as needed.


return (
<div
id={id}
Expand All@@ -116,6 +131,18 @@ export default class DashMarkdown extends Component {
<Markdown
source={displayText}
escapeHtml={!dangerously_allow_html}
renderers={{
html: props =>
props.escapeHtml ? (
props.value
) : (
<JsxParser
jsx={props.value}
components={componentTransforms}
renderInWrapper={false}
/>
),
}}
/>
</div>
);
Expand Down
10 changes: 6 additions & 4 deletions src/utils/MarkdownHighlighter.js
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
import lazyhljs from './LazyLoader/hljs';

const MarkdownHighlighter = {
loadhljs: async function() {
this.hljs = await lazyhljs();
this.hljsResolve();
this.isReady = true;
loadhljs: function() {
return lazyhljs().then(hljs => {
this.hljs = hljs;
this.hljsResolve();
this.isReady = true;
});
},
};

Expand Down
Binary file addedtests/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions tests/integration/markdown/test_markdown.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
import os
import pytest
from selenium.common.exceptions import WebDriverException

import dash
from dash.dependencies import Input, Output
import dash_core_components as dcc
import dash_html_components as html


def test_mkdw001_img(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div('Markdown img'),
dcc.Markdown(
['<img src="assets/image.png" />'], dangerously_allow_html=True
),
html.Div('Markdown img - requires dangerously_allow_html'),
dcc.Markdown(['<img src="assets/image.png" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw001 - image display")


def test_mkdw002_dcclink(dash_dcc):
app = dash.Dash(__name__, eager_loading=True)

app.layout = html.Div(
[
html.Div(['Markdown link']),
dcc.Markdown(['[Title](title_crumb)']),
html.Div(['Markdown dccLink']),
dcc.Markdown(
['<dccLink href="title_crumb" children="Title" />'],
dangerously_allow_html=True,
),
html.Div(['Markdown dccLink - explicit children']),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
Title
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink = inlined'),
dcc.Markdown(
[
'This is an inlined <dccLink href="title_crumb" children="Title" /> with text on both sides'
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<img src="assets/image.png" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="## Title" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - nested markdown image'),
dcc.Markdown(
[
'''
<dccLink href="title_crumb">
<dccMarkdown children="![Image](assets/image.png)" />
</dccLink>
'''
],
dangerously_allow_html=True,
),
html.Div('Markdown dccLink - requires dangerously_allow_html'),
dcc.Markdown(['<dccLink href="title_crumb" children="Title" />']),
]
)

dash_dcc.start_server(app)
dash_dcc.percy_snapshot("mkdw002 - markdowns display")
2 changes: 2 additions & 0 deletions tests/integration/misc/test_markdown_highlight.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ def test_msmh001_no_window_variable(dash_dcc):
app.layout = html.Div(dcc.Markdown(md_text))
dash_dcc.start_server(app)

dash_dcc.wait_for_element('code')

window_hljs = dash_dcc.driver.execute_script('return window.hljs')
assert window_hljs is None

Expand Down
Loading