Export output widget in embed bundle #1410

pbugnion · 2017-06-05T05:44:13Z

Prior to this PR, the output widget could not be embedded. Addresses issue #986 .

This is a rewrite of PR #1380, which had become out of date after the htmlmanager was moved to a stand-alone package.

I think this still needs:

Unittest widget (e.g. with a mock manager)
migrate rendermime to a singleton or to the HTMLManager to avoid re-instantiating it for every output area
Expose ability to define new renderers (and override the default ones).
Custom CSS for the output area (at the moment, it doesn't look great)

pbugnion · 2017-06-12T06:04:43Z

@jasongrout I'm about to start work on letting users override renderers in the HTML Manager. How were you thinking users would hook into this?

One way would be to define a top-level method in embed-webpack (e.g. bound to window) called configureWidgets that defines top-level options. The options would be stored in some form of global state.

Alternatively, we could just expose the options as an extra argument to renderInlineWidgets. We are then just catering for users who use the htmlmanager as a library and who instantiate the widgets themselves. If we go down that route, I'll add another example demonstrating how to do this.

I think I'm mildly in favour of the second option, since it exposes less magic.

jasongrout · 2017-06-12T13:19:16Z

IIRC, a top-level method won't work since you might have multiple instances of the widget manager on a single page - I think this may happen in some of the documentation scenarios.

Since your rendermime instance is exposed as a public attribute on the manager (i.e., the manager's rendermime is what is passed to the output widget), I think that may be enough - people can access the rendermime directly and add other renderers as needed.

jasongrout · 2017-06-17T09:49:30Z

jupyter-widgets-htmlmanager/src/htmlmanager.ts

@@ -45,11 +54,11 @@ class HTMLManager extends widgets.ManagerBase<HTMLElement> {
     */
    protected loadClass(className: string, moduleName: string, moduleVersion: string) {
        return new Promise(function(resolve, reject) {
-            if (moduleName === '@jupyter-widgets/controls') {
+            if (coreWidgetModules.indexOf(moduleName) >= 0) {


The @jupyter-widgets/base base classes (like DOMWidgetView, WidgetModel, etc.) shouldn't be exported in @jupyter-widgets/controls - I think you'll need two checks here, one for each of your coreWidgetModules. See

ipywidgets/widgetsnbextension/src/manager.js

Line 97 in 36dd0aa

if (moduleName === "@jupyter-widgets/controls") {

jasongrout · 2017-06-17T09:50:34Z

jupyter-widgets-htmlmanager/src/htmlmanager.ts

+        new RenderMime({
+            items: [
+                { mimeType: WIDGET_MIMETYPE, renderer: new WidgetRenderer(this) },
+                ... RenderMime.getDefaultItems()


please delete the space after ...

Embedding widgets does not work against the versions of jupyter-widgets/{base,controls} deployed on NPM (which still refer to the old 'jupyter-js-widgets' module name.

This is the first step towards allowing customisation of renderers.

jasongrout · 2017-06-22T15:41:27Z

Also, I changed a bit how testing is done and how the repos are built. There's only a few conflicts, but perhaps resolve those and rebasing or merging master in will help isolate the failures.

jasongrout · 2017-06-23T11:19:50Z

@pbugnion - I was looking into updating this. Are you working on it too?

pbugnion · 2017-06-23T11:34:11Z

@jasongrout I definitely won't be working on this today, and probably won't be able to over the weekend, so go ahead! Thanks.

1. The codemirror module uses tildes to denote packages, but postcss does not recognize that, so we strip tildes. 2. Many packages use global variables in their CSS, so we import those definitions for each CSS file we compile.

…onfig file.

jasongrout · 2017-06-24T03:21:42Z

@pbugnion - I think it should work, but I haven't tested it to see if it actually does yet.

jasongrout · 2017-06-24T05:03:35Z

I just tested by hand (modified the example with some state of an output widget), and the text and an embedded widget worked fine. I'll clean up one last thing with the model_id rename and merge when tests pass.

jasongrout · 2017-06-24T05:04:22Z

Actually, let's make the model_id rename a different PR, since it's really a different issue. It came up here because the widgetsnbextension output widget is broken without it.

pbugnion · 2017-06-24T06:15:08Z

Ah this is great -- thanks for your help!

pbugnion mentioned this pull request Jun 5, 2017

[WIP] Export output widget in embed bundle #1380

Closed

pbugnion force-pushed the output-area-embed-widget branch 3 times, most recently from ffda808 to 049d035 Compare June 11, 2017 09:06

jasongrout reviewed Jun 17, 2017

View reviewed changes

pbugnion mentioned this pull request Jun 19, 2017

[WIP] Fix build errors #1430

Merged

jasongrout added this to the 7.0 milestone Jun 19, 2017

jasongrout mentioned this pull request Jun 19, 2017

Fix embed resolution issues #1428

Merged

pbugnion added 19 commits June 21, 2017 07:00

Depend on local versions of jupyter-widgets

10a8c79

Embedding widgets does not work against the versions of jupyter-widgets/{base,controls} deployed on NPM (which still refer to the old 'jupyter-js-widgets' module name.

Initial commit for including the output widgets

6d2665f

Actually display widget output

5dea8b7

Include rendermime CSS

21f6660

Ability to render nested widgets

80678fe

Framework for testing output widget

69c4dd9

Missing semi

9df8f10

Load CSS correctly in tests

3f86e29

Test fixture for output widget

6197083

Split out state in test

ba61cac

Add types to test

9bc1463

Tests for text content

af95487

Rename test definition

2406064

Factor out test fixture

56f184c

Test for displaying dataframes

fb8a479

Test for displaying a widget

dc23fda

Move renderers to manager

14f4d04

This is the first step towards allowing customisation of renderers.

Layout fix

e324945

Fix embed widgets example

4e4e85a

jasongrout added 2 commits June 23, 2017 09:23

Merge branch 'master' into output-area-embed-widget

80d054e

Update htmlmanager dependencies to match others.

e2afc49

jasongrout force-pushed the output-area-embed-widget branch from c4f34ce to e2afc49 Compare June 23, 2017 13:24

jasongrout added 8 commits June 23, 2017 09:30

htmlmanager styling

609e88b

Consolidate travis scripts at the repo level.

2a3a0d2

Run the html manager tests.

35b6d59

Update the lab variables in @jupyter-widgets/controls.

ddb886d

Add license header.

f6a469b

Work around issues with jupyterlab modules

f806c98

1. The codemirror module uses tildes to denote packages, but postcss does not recognize that, so we strip tildes. 2. Many packages use global variables in their CSS, so we import those definitions for each CSS file we compile.

Downgrade postcss-loader to avoid problem with not having a postcss c…

55f86af

…onfig file.

Put in workarounds for the webpack for the html manager test suite.

b3e0c81

jasongrout force-pushed the output-area-embed-widget branch from 462a8ff to b3e0c81 Compare June 23, 2017 20:42

This was referenced Jun 24, 2017

Move CSS imports to the extensions. jupyterlab/jupyterlab#2529

Closed

Update Changelog #1279

Closed

jasongrout force-pushed the output-area-embed-widget branch from 1046670 to cff5f5a Compare June 24, 2017 05:02

jasongrout force-pushed the output-area-embed-widget branch from cff5f5a to b3e0c81 Compare June 24, 2017 05:05

jasongrout merged commit 9de6cee into jupyter-widgets:master Jun 24, 2017

jasongrout changed the title ~~[WIP] Export output widget in embed bundle~~ Export output widget in embed bundle Jun 24, 2017

jasongrout mentioned this pull request Jun 24, 2017

Make an Output model and view for the embedded widget manager #986

Closed

This was referenced Sep 19, 2017

Button which rerunns all cells in jupyter notebook does not work on dashboard server jupyter/dashboards_server#300

Closed

Output widgets do not render in dashboard jupyter/dashboards_server#337

Open

github-actions bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 13, 2021

github-actions bot locked as resolved and limited conversation to collaborators Feb 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Export output widget in embed bundle #1410

Export output widget in embed bundle #1410

pbugnion commented Jun 5, 2017 •

edited

Loading

pbugnion commented Jun 12, 2017

jasongrout commented Jun 12, 2017

jasongrout Jun 17, 2017

jasongrout Jun 17, 2017

jasongrout commented Jun 22, 2017

jasongrout commented Jun 23, 2017

pbugnion commented Jun 23, 2017

jasongrout commented Jun 24, 2017

jasongrout commented Jun 24, 2017

jasongrout commented Jun 24, 2017

pbugnion commented Jun 24, 2017

Export output widget in embed bundle #1410

Export output widget in embed bundle #1410

Conversation

pbugnion commented Jun 5, 2017 • edited Loading

pbugnion commented Jun 12, 2017

jasongrout commented Jun 12, 2017

jasongrout Jun 17, 2017

Choose a reason for hiding this comment

jasongrout Jun 17, 2017

Choose a reason for hiding this comment

jasongrout commented Jun 22, 2017

jasongrout commented Jun 23, 2017

pbugnion commented Jun 23, 2017

jasongrout commented Jun 24, 2017

jasongrout commented Jun 24, 2017

jasongrout commented Jun 24, 2017

pbugnion commented Jun 24, 2017

pbugnion commented Jun 5, 2017 •

edited

Loading