[Wikitech-l] OOjs UI 0.18.0 release (breaking change)

Hello everyone, we've released OOjs UI 0.18.0 today. It will be in MediaWiki core from 1.29.0-wmf.2, which will be deployed to Wikimedia production in the regular train, starting on Tuesday 15 November. As in this release there are six breaking changes, at least nominally, please carefully look over them to see if they affect your code. Breaking changes since last release: * TextInputWidget: remove `isValid()` method, deprecated since v0.12.3 (Ricordisamoa) Though named "isValid", this function has always returned a Promise, and not a boolean (the Promise was resolved with true/false). Way back over a year ago in v0.12.3 we introduced `getValidity()` instead, with saner semantics (it returns a Promise that is resolved or rejected depending on validitity), with the old function left in for backwards compatibility. We're now removing the old function; if you're still using it, you'll need to switch over. * ComboBoxWidget: Remove this deprecated alias for ComboBoxInputWidget (James D. Forrester) We renamed the `ComboBoxWidget` to `ComboBoxInputWidget` a year ago, refactoring it to inherit from `TextInputWidget`, with the old names left as deprecated backwards-compatible options. We're now removing the old name; if you're still using it, you'll need to simply switch over the name of the widget you call. * core: Remove {add|remove}CaptureEventListener (James D. Forrester) We provided 'addCaptureEventListener' and its sibling as proxies for 'node.addEventListener' and its sibling with special code to support Internet Explorer 8. However, from version 0.15.0 we dropped support for that browser (as MediaWiki did), so this indirection was no longer necessary. We're now removing the old methods; if you're still using it, you'll need to simply switch over to the native ones. * icons: Remove deprecated alias 'photoGallery' (Ed Sanders) We renamed the 'photoGallery' icon to 'imageGallery' in v0.13.3 in November 2015, and left the old name as a duplicate for a while for backwards compatibility. We're now removing the old name; if you're still using it, you'll need to simply switch over to the new one. * InputWidget: Remove deprecated #setRTL function (James D. Forrester) We renamed the 'setRTL' function to 'setDir' in v0.13.1 to be more standard in our naming and not imply that LTR is the normal direction. We left the old name for more than a year, but now it's removed, so you'll switch from passing a boolean to one of the strings 'ltr' and 'rtl'. * MediaWiki theme: Remove deprecated `constructive` variables (Volker E) We scrapped the 'constructive' flagged state in the MediaWiki theme some time ago. This also removes the Less variables, which we had temporarily set to the same values as the 'progressive' flag. This might be a breaking change if you were using these downstream, but it is unlikely. Deprecations since last release: * Break out parts of TextInputWidget into a new SearchInputWidget (Prateek Saxena) TextInputWidget is being simplified to reduce load, with specialised assumptions around behaviour and what icons to display by default moved down into a bespoke sub-classed widget for that use case. The old parameters will be respected for now for backwards-compatibility, but please switch over soon if you're using the widget for search. * CapsuleMultiSelectWidget: Rename to CapsuleMultiselectWidget (Bartosz Dziewoński) The capital letter on the 'S' is out of keeping with the rest of our widgets, so we renamed it. The old name is left for backwards-compatibility for at least one full release cycle, but please do switch over sooner rather than later. Additional details are in the full changelog[0]. If you have any further queries or need help dealing with deprecations, please let me know. As always, a general set of library documentation is available on mediawiki.org[1], and there is some comprehensive generated code-level documentation and interactive demos hosted on doc.wikimedia.org[2]. [0] - https://phabricator.wikimedia.org/diffusion/GOJU/browse/master/History.md [1] - https://www.mediawiki.org/wiki/OOjs_UI [2] - https://doc.wikimedia.org/oojs-ui/master/ Best, Volker -- Senior UX Engineer, Editing Wikimedia Foundation volker.e [at] wikimedia @Volker_E