Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marc-Andre-Rivet merged 12 commits into from
Nov 15, 2019
Merged

Inline clientside callbacks #967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3756aa8
Adds inline JS clientside functions, passed as strings.
Oct 16, 2019
0cca349
Adds inline clientside callbacks using decorators with a native JS in…
Oct 16, 2019
8e8f320
Removing "source" kwarg in favor of implict namespace/function name.
Oct 18, 2019
67e8a59
Updating clientside_callback docstring.
Oct 18, 2019
c12dd73
Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …
Oct 18, 2019
36b2fff
Somehow messed up a merge ..
Oct 18, 2019
192c9fa
Removed trailing whitespace.
Oct 18, 2019
c47a299
Removed Object.assign use.
Oct 19, 2019
bec5a5d
Merging from upstream/dev
Nov 7, 2019
8bd6ef3
Adding changelog notice.
Nov 7, 2019
2a6f33e
Removed trailing whitespace
Nov 7, 2019
276644f
Merge branch 'dev' into inline_clientside
Marc-Andre-Rivet Nov 15, 2019
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down
81 changes: 67 additions & 14 deletions dash/dash.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
# list of dependencies
self.callback_map = {}

# list of inline scripts
self._inline_scripts = []

# index_string has special setter so can't go in config
self._index_string = ""
self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
if isinstance(src, dict)
else '<script src="{}"></script>'.format(src)
for src in srcs
] +
[
'<script>{}</script>'.format(src)
for src in self._inline_scripts
]
)

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
(JavaScript) function instead of a Python function.

Unlike `@app.calllback`, `clientside_callback` is not a decorator:
it takes a
it takes either a
`dash.dependencies.ClientsideFunction(namespace, function_name)`
argument that describes which JavaScript function to call
(Dash will look for the JavaScript function at
`window[namespace][function_name]`).
`window.dash_clientside[namespace][function_name]`), or it may take

@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

good catch! 🔬

a string argument that contains the clientside function source.

For example:
For example, when using a `dash.dependencies.ClientsideFunction`:
```
app.clientside_callback(
ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
```

With this signature, Dash's front-end will call
`window.my_clientside_library.my_function` with the current
values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
`window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
and `another-input` whenever those values change.

Include a JavaScript file by including it your `assets/` folder. The
file can be named anything but you'll need to assign the function's
namespace to the `window.dash_clientside` namespace. For example,
this file might look:
```
window.my_clientside_library = {
window.dash_clientside = window.dash_clientside || {};
window.dash_clientside.my_clientside_library = {
my_function: function(input_value_1, input_value_2) {
return (
parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
}
}
```

Alternatively, you can pass the JavaScript source directly to
`clientside_callback`. In this case, the same example would look like:
```
app.clientside_callback(
'''
function(input_value_1, input_value_2) {
return (
parseFloat(input_value_1, 10) +
parseFloat(input_value_2, 10)
);
}
''',
Output('my-div' 'children'),
[Input('my-input', 'value'),
Input('another-input', 'value')]
)
```
"""
self._validate_callback(output, inputs, state)
callback_id = _create_callback_id(output)

# If JS source is explicitly given, create a namespace and function
# name, then inject the code.
if isinstance(clientside_function, str):

out0 = output
if isinstance(output, (list, tuple)):
out0 = output[0]

namespace = '_dashprivate_{}'.format(out0.component_id)
function_name = '{}'.format(out0.component_property)

self._inline_scripts.append(
"""
var clientside = window.dash_clientside = window.dash_clientside || {{}};
var ns = clientside["{0}"] = clientside["{0}"] || {{}};
ns["{1}"] = {2};
""".format(namespace.replace('"', '\\"'),
function_name.replace('"', '\\"'),
clientside_function)
)

# Callback is stored in an external asset.
else:
namespace = clientside_function.namespace
function_name = clientside_function.function_name

self.callback_map[callback_id] = {
"inputs": [
{"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
for c in state
],
"clientside_function": {
"namespace": clientside_function.namespace,
"function_name": clientside_function.function_name,
"namespace": namespace,
"function_name": function_name,
},
}

Expand Down
3 changes: 3 additions & 0 deletions dash/dependencies.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
# pylint: disable=too-few-public-methods
def __init__(self, namespace=None, function_name=None):

if namespace.startswith('_dashprivate_'):
raise ValueError("Namespaces cannot start with '_dashprivate_'.")

if namespace in ['PreventUpdate', 'no_update']:
raise ValueError('"{}" is a forbidden namespace in'
' dash_clientside.'.format(namespace))
Expand Down
45 changes: 43 additions & 2 deletions tests/integration/clientside/test_clientside.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
app = Dash(__name__, assets_folder="assets")

app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
dash_duo.wait_for_text_to_equal("#first", '111')
dash_duo.wait_for_text_to_equal("#second", '3')
dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
app = Dash(__name__, assets_folder="assets")

app.layout = html.Div(
[
dcc.Input(id="input"),
html.Div(id="output-clientside"),
html.Div(id="output-serverside"),
]
)

@app.callback(
Output("output-serverside", "children"), [Input("input", "value")]
)
def update_output(value):
return 'Server says "{}"'.format(value)

app.clientside_callback(
"""
function (value) {
return 'Client says "' + value + '"';
}
""",
Output("output-clientside", "children"),
[Input("input", "value")],
)

dash_duo.start_server(app)

dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
dash_duo.wait_for_text_to_equal(
"#output-clientside", 'Client says "undefined"'
)

dash_duo.find_element("#input").send_keys("hello world")
dash_duo.wait_for_text_to_equal(
"#output-serverside", 'Server says "hello world"'
)
dash_duo.wait_for_text_to_equal(
"#output-clientside", 'Client says "hello world"'
)
, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )

, '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
Inline clientside callbacks#967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Marc-Andre-Rivet
merged 12 commits into

from

Nov 15, 2019
 Merged


Inline clientside callbacks
#967
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
3756aa8

Adds inline JS clientside functions, passed as strings.

Oct 16, 2019
0cca349

Adds inline clientside callbacks using decorators with a native JS in…

Oct 16, 2019
8e8f320

Removing "source" kwarg in favor of implict namespace/function name.

Oct 18, 2019
67e8a59

Updating clientside_callback docstring.

Oct 18, 2019
c12dd73

Merge branch 'inline_clientside' of https://github.com/jjaraalm/dash …

Oct 18, 2019
36b2fff

Somehow messed up a merge ..

Oct 18, 2019
192c9fa

Removed trailing whitespace.

Oct 18, 2019
c47a299

Removed Object.assign use.

Oct 19, 2019
bec5a5d

Merging from upstream/dev

Nov 7, 2019
8bd6ef3

Adding changelog notice.

Nov 7, 2019
2a6f33e

Removed trailing whitespace

Nov 7, 2019
276644f

Merge branch 'dev' into inline_clientside


Marc-Andre-Rivet Nov 15, 2019

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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,11 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
### Added
- [#967](https://github.com/plotly/dash/pull/967) Adds support for defining
clientside JavaScript callbacks via inline strings.

## [1.6.1] - 2019-11-14
### Fixed
- [#1006](https://github.com/plotly/dash/pull/1006) Fix IE11 / ES5 compatibility and validation issues
Expand Down

81 changes: 67 additions & 14 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -307,6 +307,9 @@ def __init__(
 # list of dependencies
 self.callback_map = {}

 # list of inline scripts
 self._inline_scripts = []

 # index_string has special setter so can't go in config
 self._index_string = ""
 self.index_string = index_string
Expand DownExpand Up@@ -636,6 +639,10 @@ def _generate_scripts_html(self):
 if isinstance(src, dict)
 else '<script src="{}"></script>'.format(src)
 for src in srcs
 ] +
 [
 '<script>{}</script>'.format(src)
 for src in self._inline_scripts
 ]
 )

Expand DownExpand Up@@ -1194,13 +1201,14 @@ def clientside_callback(
 (JavaScript) function instead of a Python function.

 Unlike `@app.calllback`, `clientside_callback` is not a decorator:
 it takes a
 it takes either a
 `dash.dependencies.ClientsideFunction(namespace, function_name)`
 argument that describes which JavaScript function to call
 (Dash will look for the JavaScript function at
 `window[namespace][function_name]`).
 `window.dash_clientside[namespace][function_name]`), or it may take
@alexcjohnsonalexcjohnsonOct 18, 2019

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

good catch! 🔬
 a string argument that contains the clientside function source.

 For example:
 For example, when using a `dash.dependencies.ClientsideFunction`:
 ```
 app.clientside_callback(
 ClientsideFunction('my_clientside_library', 'my_function'),
Expand All@@ -1211,16 +1219,17 @@ def clientside_callback(
 ```

 With this signature, Dash's front-end will call
 `window.my_clientside_library.my_function` with the current
 values of the `value` properties of the components
`my-input` and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder.
The file can be named anything but you'll need to assign the
function's namespace to the `window`. For example, this file might
look like:
 `window.dash_clientside.my_clientside_library.my_function` with the
current values of the `value` properties of the components `my-input`
 and `another-input` whenever those values change.

 Include a JavaScript file by including it your `assets/` folder. The
 file can be named anything but you'll need to assign the function's
 namespace to the `window.dash_clientside` namespace. For example,
this file might look:
 ```
 window.my_clientside_library = {
 window.dash_clientside = window.dash_clientside || {};
 window.dash_clientside.my_clientside_library = {
 my_function: function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
Expand All@@ -1229,10 +1238,54 @@ def clientside_callback(
 }
 }
 ```

 Alternatively, you can pass the JavaScript source directly to
 `clientside_callback`. In this case, the same example would look like:
 ```
 app.clientside_callback(
 '''
 function(input_value_1, input_value_2) {
 return (
 parseFloat(input_value_1, 10) +
 parseFloat(input_value_2, 10)
 );
 }
 ''',
 Output('my-div' 'children'),
 [Input('my-input', 'value'),
 Input('another-input', 'value')]
 )
 ```
 """
 self._validate_callback(output, inputs, state)
 callback_id = _create_callback_id(output)

 # If JS source is explicitly given, create a namespace and function
 # name, then inject the code.
 if isinstance(clientside_function, str):

 out0 = output
 if isinstance(output, (list, tuple)):
 out0 = output[0]

 namespace = '_dashprivate_{}'.format(out0.component_id)
 function_name = '{}'.format(out0.component_property)

 self._inline_scripts.append(
 """
 var clientside = window.dash_clientside = window.dash_clientside || {{}};
 var ns = clientside["{0}"] = clientside["{0}"] || {{}};
 ns["{1}"] = {2};
 """.format(namespace.replace('"', '\\"'),
 function_name.replace('"', '\\"'),
 clientside_function)
 )

 # Callback is stored in an external asset.
 else:
 namespace = clientside_function.namespace
 function_name = clientside_function.function_name

 self.callback_map[callback_id] = {
 "inputs": [
 {"id": c.component_id, "property": c.component_property}
Expand All@@ -1243,8 +1296,8 @@ def clientside_callback(
 for c in state
 ],
 "clientside_function": {
 "namespace": clientside_function.namespace,
 "function_name": clientside_function.function_name,
 "namespace": namespace,
 "function_name": function_name,
 },
 }

Expand Down

3 changes: 3 additions & 0 deletions
dash/dependencies.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,9 @@ class ClientsideFunction:
 # pylint: disable=too-few-public-methods
 def __init__(self, namespace=None, function_name=None):

 if namespace.startswith('_dashprivate_'):
 raise ValueError("Namespaces cannot start with '_dashprivate_'.")

 if namespace in ['PreventUpdate', 'no_update']:
 raise ValueError('"{}" is a forbidden namespace in'
 ' dash_clientside.'.format(namespace))
Expand Down

45 changes: 43 additions & 2 deletions
tests/integration/clientside/test_clientside.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,6 @@ def test_clsd005_clientside_fails_when_returning_a_promise(dash_duo):
 dash_duo.wait_for_text_to_equal("#side-effect", "side effect")
 dash_duo.wait_for_text_to_equal("#output", "output")


def test_clsd006_PreventUpdate(dash_duo):
 app = Dash(__name__, assets_folder="assets")

Expand DownExpand Up@@ -307,7 +306,7 @@ def test_clsd006_PreventUpdate(dash_duo):
 dash_duo.wait_for_text_to_equal("#third", '3')


def test_clsd006_no_update(dash_duo):
def test_clsd007_no_update(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
Expand DownExpand Up@@ -344,3 +343,45 @@ def test_clsd006_no_update(dash_duo):
 dash_duo.wait_for_text_to_equal("#first", '111')
 dash_duo.wait_for_text_to_equal("#second", '3')
 dash_duo.wait_for_text_to_equal("#third", '4')

def test_clsd008_clientside_inline_source(dash_duo):
 app = Dash(__name__, assets_folder="assets")

 app.layout = html.Div(
 [
 dcc.Input(id="input"),
 html.Div(id="output-clientside"),
 html.Div(id="output-serverside"),
 ]
 )

 @app.callback(
 Output("output-serverside", "children"), [Input("input", "value")]
 )
 def update_output(value):
 return 'Server says "{}"'.format(value)

 app.clientside_callback(
 """
 function (value) {
 return 'Client says "' + value + '"';
 }
 """,
 Output("output-clientside", "children"),
 [Input("input", "value")],
 )

 dash_duo.start_server(app)

 dash_duo.wait_for_text_to_equal("#output-serverside", 'Server says "None"')
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "undefined"'
 )

 dash_duo.find_element("#input").send_keys("hello world")
 dash_duo.wait_for_text_to_equal(
 "#output-serverside", 'Server says "hello world"'
 )
 dash_duo.wait_for_text_to_equal(
 "#output-clientside", 'Client says "hello world"'
 )