Default values for widget model attributes #304

SylvainCorlay · 2016-01-08T16:30:00Z

@jdfreder @parente here is the approach I am proposing for specifying default values for widget attributes on the javascript side.

I started with the base widget classes and the _Bool widgets.

TODO:

figure out what to do with the instance of layout widget.
check commit regarding buffered state diff.
some widgets have the same models and view types, but different default values. Is it worth inheriting and specifying a custom model for these cases (range sliders vs sliders)

This is an API change from the perspective of custom widget authors who need custom models.

jdfreder · 2016-01-08T16:44:28Z

From the sample you have here, I think this is great.

SylvainCorlay · 2016-01-08T17:20:17Z

Test failures seem unrelated.

jdfreder · 2016-01-08T22:10:55Z

ipywidgets/static/widgets/js/widget_bool.js

+    });
+
+    var CheckboxModel = BoolModel.extend({
+        defaults: _.extend(BoolModel.prototype.defaults, {


This is the line that is causing the tests to fail. You need to import underscore.

fixed thanks!

Thank the new karma tests ;)

jdfreder · 2016-01-08T22:11:12Z

Test failures seem unrelated.

They are related, missing import, see above

SylvainCorlay · 2016-01-08T22:16:02Z

Thanks. I will iterate on this PR to cover the other models.

SylvainCorlay · 2016-01-09T00:25:22Z

The color picker widget has a recently added boolean attribute called short specifying whether it should take a full widget width and have a text input area or just have a picker button and have a short widget width. We could rename this to "concise".

jdfreder · 2016-01-11T16:32:08Z

We could rename this to "concise".

Sure

parente · 2016-01-11T17:23:41Z

Ping @lbustelo

SylvainCorlay · 2016-01-11T21:27:10Z

We could rename this to "concise".

Sure

Done

SylvainCorlay · 2016-01-11T21:27:58Z

I have to figure out how to define a default for the instance of layout widget from the js, the default being to instantiate a new one...

jdfreder · 2016-01-11T21:36:58Z

Great work so far! Looking forward to this one

SylvainCorlay · 2016-01-11T23:40:37Z

I would love to have your opinion on the buffered_state_diff commit.

SylvainCorlay · 2016-01-12T04:38:16Z

The issue was that the state from defaults was being added to buffered_state_diff at the time when the base constructor was called. Then the default values were sent back to the backend.

I just changed the code in the following fashion: only buffer state diff after the initial state has been set.

jdfreder · 2016-01-12T17:14:59Z

ipywidgets/static/widgets/js/widget.js

-    var DOMWidgetModel = WidgetModel.extend({}, {
+    var DOMWidgetModel = WidgetModel.extend({
+        defaults: _.extend({}, WidgetModel.prototype.defaults, {
+            layout: undefined,


Isn't this supposed to be null?

Well I don't know. We don't allow None for the layout widget.
In fact, even when building it from JavaScript, we should instantiate a layout widget. Not sure what is the best way to do it. That is why I used undefined.

That's okay for now, note to self: test edge cases of this.

jdfreder · 2016-01-12T17:19:42Z

@SylvainCorlay one small comment

Default values for widget model attributes

jdfreder added this to the 5.0 milestone Jan 8, 2016

jdfreder added the feature request label Jan 8, 2016

jdfreder reviewed Jan 8, 2016
View reviewed changes

SylvainCorlay force-pushed the default_values branch from c2a0a0e to f5e3648 Compare January 8, 2016 22:13

SylvainCorlay force-pushed the default_values branch 6 times, most recently from 5b5cff5 to dcb2d24 Compare January 11, 2016 15:14

SylvainCorlay added 7 commits January 11, 2016 15:35

Add js defaults for base widget classes and widget-bool

37fed7f

Add js default values for widget-box and widget-color

df1fc34

Add js default values for widget-controller

39062cc

Add js default values for widget-string

ff00633

Add js default values for widget-layout

63bf664

Add js default values for widget-button

5bfa8f4

Add js default values for widget-int and widget-float

ec80035

SylvainCorlay force-pushed the default_values branch from 5251eba to ec80035 Compare January 11, 2016 20:37

SylvainCorlay added 3 commits January 11, 2016 16:10

Add js default values for widget-image and widget-link

2e6a63b

Add js default values for widget-output

65fb8be

Widget color property rename (short -> concise)

7e01697

SylvainCorlay force-pushed the default_values branch from 2e1c78c to 7e01697 Compare January 11, 2016 21:11

SylvainCorlay force-pushed the default_values branch 3 times, most recently from 02e636e to 39cbdf3 Compare January 11, 2016 22:29

Add js default values for widget-selection

4356601

SylvainCorlay force-pushed the default_values branch from c5ca4e7 to 29aa633 Compare January 11, 2016 22:53

SylvainCorlay added 2 commits January 11, 2016 18:38

Add js default values for widget-selectioncontainer

65b0883

set buffered_state_diff to empty object

2a422ec

SylvainCorlay force-pushed the default_values branch from 6b70dc4 to 2a422ec Compare January 11, 2016 23:38

Update web example: no need to specify view name, but custom model

8ec96e8

SylvainCorlay added the API change label Jan 12, 2016

Don't buffer state diff from initial state

da64450

jdfreder reviewed Jan 12, 2016
View reviewed changes

Add js default valus for FlexBox and PlaceProxy

f50cd48

SylvainCorlay force-pushed the default_values branch from 508fa4d to f50cd48 Compare January 12, 2016 17:54

jdfreder added a commit that referenced this pull request Jan 12, 2016

Merge pull request #304 from SylvainCorlay/default_values

29871a1

Default values for widget model attributes

jdfreder merged commit 29871a1 into jupyter-widgets:master Jan 12, 2016

SylvainCorlay deleted the default_values branch January 12, 2016 18:53

jdfreder added widget authors beware and removed API change labels Jan 22, 2016

SylvainCorlay mentioned this pull request Jan 24, 2016

Default values bqplot/bqplot#88

Merged

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 25, 2021

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

Default values for widget model attributes #304

Default values for widget model attributes #304

Uh oh!

Conversation

SylvainCorlay commented Jan 8, 2016

Uh oh!

jdfreder commented Jan 8, 2016

Uh oh!

SylvainCorlay commented Jan 8, 2016

Uh oh!

jdfreder Jan 8, 2016

Choose a reason for hiding this comment

Uh oh!

SylvainCorlay Jan 8, 2016

Choose a reason for hiding this comment

Uh oh!

jdfreder Jan 8, 2016

Choose a reason for hiding this comment

Uh oh!

jdfreder commented Jan 8, 2016

Uh oh!

SylvainCorlay commented Jan 8, 2016

Uh oh!

SylvainCorlay commented Jan 9, 2016

Uh oh!

jdfreder commented Jan 11, 2016

Uh oh!

parente commented Jan 11, 2016

Uh oh!

SylvainCorlay commented Jan 11, 2016

Uh oh!

SylvainCorlay commented Jan 11, 2016

Uh oh!

jdfreder commented Jan 11, 2016

Uh oh!

SylvainCorlay commented Jan 11, 2016

Uh oh!

SylvainCorlay commented Jan 12, 2016

Uh oh!

jdfreder Jan 12, 2016

Choose a reason for hiding this comment

Uh oh!

SylvainCorlay Jan 12, 2016

Choose a reason for hiding this comment

Uh oh!

jdfreder Jan 12, 2016

Choose a reason for hiding this comment

Uh oh!

jdfreder commented Jan 12, 2016

Uh oh!

Uh oh!