Merge branch 'master' into chlog8

Author: jasongrout

docs/source/examples/Widget List.ipynb

@@ -1388,9 +1388,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Stacked\n",
+    "### Stack\n",
     "\n",
-    "The `Stacked` widget can have multiple children widgets as for `Tab` and `Accordion`, but only shows one at a time depending on the value of ``selected_index``:"
+    "The `Stack` widget can have multiple children widgets as for `Tab` and `Accordion`, but only shows one at a time depending on the value of ``selected_index``:"
    ]
   },
   {
@@ -1401,8 +1401,8 @@
    "source": [
     "button = widgets.Button(description='Click here')\n",
     "slider = widgets.IntSlider()\n",
-    "stacked = widgets.Stacked([button, slider], selected_index=0)\n",
-    "stacked  # will show only the button"
+    "stack = widgets.Stack([button, slider], selected_index=0)\n",
+    "stack  # will show only the button"
    ]
   },
   {
@@ -1419,15 +1419,15 @@
    "outputs": [],
    "source": [
     "dropdown = widgets.Dropdown(options=['button', 'slider'])\n",
-    "widgets.jslink((dropdown, 'index'), (stacked, 'selected_index'))\n",
-    "widgets.VBox([dropdown, stacked])"
+    "widgets.jslink((dropdown, 'index'), (stack, 'selected_index'))\n",
+    "widgets.VBox([dropdown, stack])"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Accordion,  Tab, and Stacked use `selected_index`, not value\n",
+    "### Accordion,  Tab, and Stack use `selected_index`, not value\n",
     "\n",
     "Unlike the rest of the widgets discussed earlier, the container widgets `Accordion` and `Tab` update their `selected_index` attribute when the user changes which accordion or tab is selected. That means that you can both see what the user is doing *and* programmatically set what the user sees by setting the value of `selected_index`.\n",
     "\n",

docs/source/migration_guides.md

@@ -88,7 +88,7 @@ The ``DOMWidgetView.pWidget`` property has been renamed ``DOMWidgetView.luminoWi
 + this.luminoWidget
 ```
 
-The ``DOMWidgetView.processPhosphorMessage`` method has been renamed ``DOMWidgetView.processLuminoMessage``. If you want to support both ipywidgets 7.x and 8.x, you should implement both methods:
+The ``DOMWidgetView.processPhosphorMessage`` method has been renamed ``DOMWidgetView.processLuminoMessage``. If you want to support both ipywidgets 7.x and 8.x, you should implement both methods and call the correct super method:
 
 ```diff
 - processPhosphorMessage(msg: Message): void {
@@ -109,15 +109,15 @@ The ``DOMWidgetView.processPhosphorMessage`` method has been renamed ``DOMWidget
 + }
 +
 + processPhosphorMessage(msg: Message): void {
-+     this._processLuminoMessage(msg, (DOMWidgetView as any).processPhosphorMessage);
++     this._processLuminoMessage(msg, super.processPhosphorMessage);
 + }
 +
 + processLuminoMessage(msg: Message): void {
-+     this._processLuminoMessage(msg, (DOMWidgetView as any).processLuminoMessage);
++     this._processLuminoMessage(msg, super.processLuminoMessage);
 + }
 ```
 
-I you're dropping ipywidgets 7.x support, you can simply rename the `processPhosphorMessage` method into `processLuminoMessage`.
+If you're dropping ipywidgets 7.x support, you can simply rename the `processPhosphorMessage` method to `processLuminoMessage`.
 
 #### Widget manager import
 
@@ -128,7 +128,7 @@ As mentioned before, if you depend on the ``ManagerBase`` class, you will **eith
 + import { ManagerBase } from '@jupyter-widgets/base-manager';
 ```
 
-**or**, siwtch to using the new `IWidgetManager` interface in the `base` package:
+**or**, switch to using the new `IWidgetManager` interface in the `base` package:
 
 ```diff
 - import { ManagerBase } from '@jupyter-widgets/base';
@@ -153,7 +153,7 @@ export async function myDeserializer(
 
 #### Backbone extend
 
-The version of backbone that ipywidgets depend on has changed from 1.2.3 to 1.4.0. If you were extending the base widget model with `var CustomWidgetModel = Widget.extend({ ... });` you will need to update the class definition using the ES6 notation:
+The version of [Backbone.js](https://backbonejs.org/) that ipywidgets depends on has changed from 1.2.3 to 1.4.0. If you were extending the base widget model with `var CustomWidgetModel = Widget.extend({ ... });` you will need to update the class definition using the ES6 notation:
 
 ```diff
 - var CustomWidgetModel = Widget.extend({
@@ -164,8 +164,27 @@ The version of backbone that ipywidgets depend on has changed from 1.2.3 to 1.4.
 + }
 ```
 
-Note: If you were relying on setting certain instance attributes via the `extend` method, you might now need override the `preinitialize` method in order for their values to be set in time.
+#### Custom tag names
 
+If you were changing the base HTML tag for your widget by defining the `tagName` property, this can now be done in ipywidgets 8 in the `preinitialize` method (see https://github.com/jupyter-widgets/ipywidgets/commit/a342e0dbc7c779bb668e5a21c097d7cec9a6ac44 for example changes in core widgets):
+
+```diff
+- get tagName() {
+-   return 'button';
+- }
++ preinitialize() {
++   this.tagName = 'button';
++ }
+```
+
+If you need compatibility with ipywidgets 7, continue using the `get tagName` accessor instead of `preinitialize`. However, newer versions of Typescript will complain that you are overriding a property with a function. If you want to maintain compatibility with both ipywidgets 7 and ipywidgets 8, and you are using Typescript, you can add a `ts-ignore` directive to mollify Typescript, like is done in [ipydatawidgets](https://github.com/vidartf/ipydatawidgets/blob/489586982c375c03d5ffd3089dd4f427c8266443/packages/jupyter-datawidgets/src/media.ts#L131):
+
+```diff
++ // @ts-ignore: 2611
+  get tagName() {
+    return 'button';
+  }
+```
 
 Migrating from 6.0 to 7.0
 -------------------------

docs/source/user_migration_guides.md

@@ -33,7 +33,8 @@ As part of an effort to make it possible to
 the old `description_tooltip` attribute for certain widgets was deprecated. Now all widgets
 that inherit `DOMWidget` have the attribute `tooltip` instead.
 
-Suggested migration: Search and replace `description_tooltip` to `tooltip`.
+Suggested migration: Search and replace `description_tooltip` to `tooltip` when you no longer
+need to support ipywidgets 7.
 
 #### Selection Widgets
 

packages/controls/src/widget_selectioncontainer.ts

@@ -422,17 +422,17 @@ export class TabView extends DOMWidgetView {
   luminoWidget: JupyterLuminoTabPanelWidget;
 }
 
-export class StackedModel extends SelectionContainerModel {
+export class StackModel extends SelectionContainerModel {
   defaults(): Backbone.ObjectHash {
     return {
       ...super.defaults(),
-      _model_name: 'StackedModel',
-      _view_name: 'StackedView',
+      _model_name: 'StackModel',
+      _view_name: 'StackView',
     };
   }
 }
 
-export class StackedView extends BoxView {
+export class StackView extends BoxView {
   initialize(parameters: WidgetView.IInitializeParameters): void {
     super.initialize(parameters);
     this.listenTo(this.model, 'change:selected_index', this.update_children);

packages/schema/jupyterwidgetmodels.latest.json

@@ -6554,7 +6554,7 @@
         "type": "string"
       },
       {
-        "default": "StackedModel",
+        "default": "StackModel",
         "help": "",
         "name": "_model_name",
         "type": "string"
@@ -6572,7 +6572,7 @@
         "type": "string"
       },
       {
-        "default": "StackedView",
+        "default": "StackView",
         "help": "",
         "name": "_view_name",
         "type": "string"
@@ -6634,12 +6634,12 @@
     ],
     "model": {
       "module": "@jupyter-widgets/controls",
-      "name": "StackedModel",
+      "name": "StackModel",
       "version": "2.0.0"
     },
     "view": {
       "module": "@jupyter-widgets/controls",
-      "name": "StackedView",
+      "name": "StackView",
       "version": "2.0.0"
     }
   },

packages/schema/jupyterwidgetmodels.latest.md

@@ -1168,17 +1168,17 @@ Attribute        | Type             | Default          | Help
 `description_width` | string           | `''`             | Width of the description to the side of the control.
 `handle_color`   | `null` or string | `null`           | Color of the slider handle.
 
-### StackedModel (@jupyter-widgets/controls, 2.0.0); StackedView (@jupyter-widgets/controls, 2.0.0)
+### StackModel (@jupyter-widgets/controls, 2.0.0); StackView (@jupyter-widgets/controls, 2.0.0)
 
 Attribute        | Type             | Default          | Help
 -----------------|------------------|------------------|----
 `_dom_classes`   | array of string  | `[]`             | CSS classes applied to widget DOM element
 `_model_module`  | string           | `'@jupyter-widgets/controls'` | 
 `_model_module_version` | string           | `'2.0.0'`        | 
-`_model_name`    | string           | `'StackedModel'` | 
+`_model_name`    | string           | `'StackModel'`   | 
 `_view_module`   | string           | `'@jupyter-widgets/controls'` | 
 `_view_module_version` | string           | `'2.0.0'`        | 
-`_view_name`     | string           | `'StackedView'`  | 
+`_view_name`     | string           | `'StackView'`    | 
 `box_style`      | string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''`             | Use a predefined styling for the box.
 `children`       | array of reference to Widget widget | `[]`             | List of widget children
 `layout`         | reference to Layout widget | reference to new instance | 

python/ipywidgets/ipywidgets/widgets/__init__.py

@@ -19,7 +19,7 @@
 from .widget_time import TimePicker
 from .widget_output import Output
 from .widget_selection import RadioButtons, ToggleButtons, ToggleButtonsStyle, Dropdown, Select, SelectionSlider, SelectMultiple, SelectionRangeSlider
-from .widget_selectioncontainer import Tab, Accordion, Stacked
+from .widget_selectioncontainer import Tab, Accordion, Stack
 from .widget_string import HTML, HTMLMath, Label, Text, Textarea, Password, Combobox
 from .widget_controller import Controller
 from .interaction import interact, interactive, fixed, interact_manual, interactive_output

python/ipywidgets/ipywidgets/widgets/tests/test_selectioncontainer.py

@@ -5,50 +5,164 @@
 
 from traitlets import TraitError
 
-from ipywidgets.widgets import Accordion, HTML
+from ipywidgets.widgets import Accordion, Tab, Stack, HTML
 
+class TestTab(TestCase):
+
+    def setUp(self):
+        self.children = [HTML('0'), HTML('1')]
+        self.widget = Tab
+
+    def test_selected_index_none(self):
+        widget = self.widget(self.children, selected_index=None)
+        state = widget.get_state()
+        assert state['selected_index'] == 0
+
+    def test_selected_index_default(self):
+        widget = self.widget(self.children)
+        state = widget.get_state()
+        assert state['selected_index'] == 0
+
+    def test_selected_index(self):
+        widget = self.widget(self.children, selected_index=1)
+        state = widget.get_state()
+        assert state['selected_index'] == 1
+
+    def test_selected_index_out_of_bounds(self):
+        with self.assertRaises(TraitError):
+            self.widget(self.children, selected_index=-1)
+
+    def test_children_position_argument(self):
+        self.widget(self.children)
+
+    def test_titles(self):
+        widget = self.widget(self.children, selected_index=None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles == ('', '')
+
+        widget.set_title(1, 'Title 1')
+        assert widget.get_state()['titles'] == ('', 'Title 1')
+        assert widget.titles[1] == 'Title 1'
+        assert widget.get_title(1) == 'Title 1'
+
+        # Backwards compatible with 7.x api
+        widget.set_title(1, None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles[1] == ''
+        assert widget.get_title(1) == ''
+
+        with self.assertRaises(IndexError):
+            widget.set_title(2, 'out of bounds')
+        with self.assertRaises(IndexError):
+            widget.get_title(2)
+
+        widget.children = tuple(widget.children[:1])
+        assert len(widget.children) == 1
+        assert widget.titles == ('',)
 
 class TestAccordion(TestCase):
 
     def setUp(self):
         self.children = [HTML('0'), HTML('1')]
+        self.widget = Accordion
+
+    def test_selected_index_none(self):
+        widget = self.widget(self.children, selected_index=None)
+        state = widget.get_state()
+        assert state['selected_index'] is None
+
+    def test_selected_index_default(self):
+        widget = self.widget(self.children)
+        state = widget.get_state()
+        assert state['selected_index'] is None
+
+    def test_selected_index(self):
+        widget = self.widget(self.children, selected_index=1)
+        state = widget.get_state()
+        assert state['selected_index'] == 1
+
+    def test_selected_index_out_of_bounds(self):
+        with self.assertRaises(TraitError):
+            self.widget(self.children, selected_index=-1)
+
+    def test_children_position_argument(self):
+        self.widget(self.children)
+
+    def test_titles(self):
+        widget = self.widget(self.children, selected_index=None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles == ('', '')
+
+        widget.set_title(1, 'Title 1')
+        assert widget.get_state()['titles'] == ('', 'Title 1')
+        assert widget.titles[1] == 'Title 1'
+        assert widget.get_title(1) == 'Title 1'
+
+        # Backwards compatible with 7.x api
+        widget.set_title(1, None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles[1] == ''
+        assert widget.get_title(1) == ''
+
+        with self.assertRaises(IndexError):
+            widget.set_title(2, 'out of bounds')
+        with self.assertRaises(IndexError):
+            widget.get_title(2)
+
+        widget.children = tuple(widget.children[:1])
+        assert len(widget.children) == 1
+        assert widget.titles == ('',)
+
+class TestStack(TestCase):
+
+    def setUp(self):
+        self.children = [HTML('0'), HTML('1')]
+        self.widget = Stack
 
     def test_selected_index_none(self):
-        accordion = Accordion(self.children, selected_index=None)
-        state = accordion.get_state()
+        widget = self.widget(self.children, selected_index=None)
+        state = widget.get_state()
+        assert state['selected_index'] is None
+
+    def test_selected_index_default(self):
+        widget = self.widget(self.children)
+        state = widget.get_state()
         assert state['selected_index'] is None
 
     def test_selected_index(self):
-        accordion = Accordion(self.children, selected_index=1)
-        state = accordion.get_state()
+        widget = self.widget(self.children, selected_index=1)
+        state = widget.get_state()
         assert state['selected_index'] == 1
 
     def test_selected_index_out_of_bounds(self):
         with self.assertRaises(TraitError):
-            Accordion(self.children, selected_index=-1)
+            self.widget(self.children, selected_index=-1)
 
+    def test_children_position_argument(self):
+        self.widget(self.children)
 
     def test_titles(self):
-        accordion = Accordion(self.children, selected_index=None)
-        assert accordion.get_state()['titles'] == ('', '')
-        assert accordion.titles == ('', '')
+        widget = self.widget(self.children, selected_index=None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles == ('', '')
 
-        accordion.set_title(1, 'Title 1')
-        assert accordion.get_state()['titles'] == ('', 'Title 1')
-        assert accordion.titles[1] == 'Title 1'
-        assert accordion.get_title(1) == 'Title 1'
+        widget.set_title(1, 'Title 1')
+        assert widget.get_state()['titles'] == ('', 'Title 1')
+        assert widget.titles[1] == 'Title 1'
+        assert widget.get_title(1) == 'Title 1'
 
         # Backwards compatible with 7.x api
-        accordion.set_title(1, None)
-        assert accordion.get_state()['titles'] == ('', '')
-        assert accordion.titles[1] == ''
-        assert accordion.get_title(1) == ''
+        widget.set_title(1, None)
+        assert widget.get_state()['titles'] == ('', '')
+        assert widget.titles[1] == ''
+        assert widget.get_title(1) == ''
 
         with self.assertRaises(IndexError):
-            accordion.set_title(2, 'out of bounds')
+            widget.set_title(2, 'out of bounds')
         with self.assertRaises(IndexError):
-            accordion.get_title(2)
+            widget.get_title(2)
+
+        widget.children = tuple(widget.children[:1])
+        assert len(widget.children) == 1
+        assert widget.titles == ('',)
 
-        accordion.children = tuple(accordion.children[:1])
-        assert len(accordion.children) == 1
-        assert accordion.titles == ('',)