|
3 | 3 | All notable changes to this project will be documented in this file. |
4 | 4 | See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. |
5 | 5 |
|
| 6 | +# [1.0.0-rc.5](https://github.com/SAP/ui5-webcomponents/compare/v1.0.0-rc.4...v1.0.0-rc.5) (2019-12-02) |
| 7 | + |
| 8 | +## [Migration guide](https://github.com/SAP/ui5-webcomponents/blob/master/docs/Migration-guides.md) from v1.0.0-rc.4 to v1.0.0-rc.5 |
| 9 | +The current release includes several new npm packages, such as `@ui5/webcomponents-fiori` and `@ui5/webcomponents-icons`. |
| 10 | +To make the transition from v1.0.0-rc.4 to v1.0.0-rc.5 smoother, we prepared this [migration guide](https://github.com/SAP/ui5-webcomponents/blob/master/docs/Migration-guides.md). |
| 11 | + |
| 12 | +### Bug Fixes |
| 13 | + |
| 14 | +* **ui5-button:** prevents setting 0 height to icons in IE ([#902](https://github.com/SAP/ui5-webcomponents/issues/902)) ([20511c6](https://github.com/SAP/ui5-webcomponents/commit/20511c6)) |
| 15 | +* **ui5-checkbox:** fix layouting in IE ([#926](https://github.com/SAP/ui5-webcomponents/issues/926)) ([ffdc271](https://github.com/SAP/ui5-webcomponents/commit/ffdc271)) |
| 16 | +* **ui5-checkbox:** fix truncation in compactSize ([#998](https://github.com/SAP/ui5-webcomponents/issues/998)) ([3cdcede](https://github.com/SAP/ui5-webcomponents/commit/3cdcede)) |
| 17 | +* **ui5-datepicker:** fix hover effect ([#999](https://github.com/SAP/ui5-webcomponents/issues/999)) ([44d6c27](https://github.com/SAP/ui5-webcomponents/commit/44d6c27)) |
| 18 | +* **ui5-datepicker:** enable setting an empty placeholder ([#997](https://github.com/SAP/ui5-webcomponents/issues/997)) ([3eca602](https://github.com/SAP/ui5-webcomponents/commit/3eca602)) |
| 19 | +* **ui5-input:** correct ACC implementation ([#846](https://github.com/SAP/ui5-webcomponents/issues/846)) ([7d547ec](https://github.com/SAP/ui5-webcomponents/commit/7d547ec)) |
| 20 | +* **ui5-input:** fix input pushed downward ([#891](https://github.com/SAP/ui5-webcomponents/issues/891)) ([bda9714](https://github.com/SAP/ui5-webcomponents/commit/bda9714)) |
| 21 | +* **ui5-multi-combobox:** close popover & empty value on selection ([#832](https://github.com/SAP/ui5-webcomponents/issues/832)) ([1b3e40d](https://github.com/SAP/ui5-webcomponents/commit/1b3e40d)) |
| 22 | +* **ui5-popover:** restrict max content height when overflowing the screen ([#908](https://github.com/SAP/ui5-webcomponents/issues/908)) ([6671793](https://github.com/SAP/ui5-webcomponents/commit/6671793)) |
| 23 | +* **ui5-select:** remove unsupported method in IE ([#919](https://github.com/SAP/ui5-webcomponents/issues/919)) ([f1bceea](https://github.com/SAP/ui5-webcomponents/commit/f1bceea)) |
| 24 | +* **ui5-tabcontainer:** adjust tabs to take 100% of TC height ([#895](https://github.com/SAP/ui5-webcomponents/issues/895)) ([6fcf259](https://github.com/SAP/ui5-webcomponents/commit/6fcf259)) |
| 25 | +* **ui5-tabcontainer:** fix overflow items default semantic color ([#989](https://github.com/SAP/ui5-webcomponents/issues/989)) ([a003189](https://github.com/SAP/ui5-webcomponents/commit/a003189)), closes [#988](https://github.com/SAP/ui5-webcomponents/issues/988) |
| 26 | +* **ui5-tabcontainer:** fix overflow items appearance and selection ([#988](https://github.com/SAP/ui5-webcomponents/issues/988)) ([8cd2a8b](https://github.com/SAP/ui5-webcomponents/commit/8cd2a8b)) |
| 27 | +* **ui5-list:** prevent item navigaion with Left/Right keys([#985](https://github.com/SAP/ui5-webcomponents/issues/985)) ([3d46e2d](https://github.com/SAP/ui5-webcomponents/commit/3d46e2d)) |
| 28 | +* **ui5-table:** pressing SPACE works for HTML elements inside ui5-table ([#964](https://github.com/SAP/ui5-webcomponents/issues/964)) ([2384236](https://github.com/SAP/ui5-webcomponents/commit/2384236)) |
| 29 | +* **ui5-table:** fix JS error when there are less cells than columns ([#841](https://github.com/SAP/ui5-webcomponents/issues/841)) ([fd3b690](https://github.com/SAP/ui5-webcomponents/commit/fd3b690)) |
| 30 | +* **ui5-table:** fix row navigation and focus handling ([#876](https://github.com/SAP/ui5-webcomponents/issues/876)) ([f69f42c](https://github.com/SAP/ui5-webcomponents/commit/f69f42c)) |
| 31 | +* **ItemNavigation:** fix Item Navigation cycling ([#985](https://github.com/SAP/ui5-webcomponents/issues/985)) ([3d46e2d](https://github.com/SAP/ui5-webcomponents/commit/3d46e2d)) |
| 32 | +* **Framework:** order slots in state as in Light DOM ([#874](https://github.com/SAP/ui5-webcomponents/issues/874)) ([b8efea0](https://github.com/SAP/ui5-webcomponents/commit/b8efea0)), closes [#873](https://github.com/SAP/ui5-webcomponents/issues/873) |
| 33 | +* **Framework:** skip waiting for polyfill in case already loaded ([#851](https://github.com/SAP/ui5-webcomponents/issues/851)) ([d5e19f6](https://github.com/SAP/ui5-webcomponents/commit/d5e19f6)) |
| 34 | +* **Framework:** trigger DOM mutation observer independent of insertion order ([#847](https://github.com/SAP/ui5-webcomponents/issues/847)) ([d7d96ec](https://github.com/SAP/ui5-webcomponents/commit/d7d96ec)), closes [#839](https://github.com/SAP/ui5-webcomponents/issues/839) |
| 35 | +* **JS Doc** enable release candidates versions to be displayed as since tags ([#983](https://github.com/SAP/ui5-webcomponents/issues/983)) ([3051d76](https://github.com/SAP/ui5-webcomponents/commit/3051d76)) |
| 36 | + |
| 37 | +### Features |
| 38 | +* **ui5-product-switch:** introduce new component within @ui5/webcomponents-fiori package([#971](https://github.com/SAP/ui5-webcomponents/pull/971)) ([4646fcd](https://github.com/SAP/ui5-webcomponents/commit/70d44b1ebf4b47c7e99ebf96feb19e5c04646fcd)) |
| 39 | +* **ui5-input:** introduce maxlength property ([#976](https://github.com/SAP/ui5-webcomponents/issues/976)) ([c149f5f](https://github.com/SAP/ui5-webcomponents/commit/c149f5f)) |
| 40 | +* **ui5-label:** introduce showColon property ([#965](https://github.com/SAP/ui5-webcomponents/issues/965)) ([ae95a8d](https://github.com/SAP/ui5-webcomponents/commit/ae95a8d)) |
| 41 | +* **ui5-multicombobox:** implement ACC support ([#937](https://github.com/SAP/ui5-webcomponents/issues/937)) ([0a44a92](https://github.com/SAP/ui5-webcomponents/commit/0a44a92)) |
| 42 | +* **ui5-multicombobox:** introduce open property and openChange event ([#930](https://github.com/SAP/ui5-webcomponents/issues/930)) ([c0b51f5](https://github.com/SAP/ui5-webcomponents/commit/c0b51f5)) |
| 43 | +* **ui5-panel:** improve accessibility ([#864](https://github.com/SAP/ui5-webcomponents/issues/864)) ([b133468](https://github.com/SAP/ui5-webcomponents/commit/b133468)) |
| 44 | +* **ui5-textarea:** implement input event ([#543](https://github.com/SAP/ui5-webcomponents/issues/543)) ([7c5647e](https://github.com/SAP/ui5-webcomponents/commit/7c5647e)) |
| 45 | +* **Documentation:** introduce new playground app ([#751](https://github.com/SAP/ui5-webcomponents/pull/751)) ([fdcddaa](https://github.com/SAP/ui5-webcomponents/commit/fdcddaa241cd14b182010f7815a26833655f95c4)) |
| 46 | +* **Configuration:** introduce animationMode configuration ([#905](https://github.com/SAP/ui5-webcomponents/issues/905)) ([c90e3b0](https://github.com/SAP/ui5-webcomponents/commit/c90e3b0)) |
| 47 | +* **Framework:** render SVG content with lit svg` ([#904](https://github.com/SAP/ui5-webcomponents/issues/904)) ([59fead4](https://github.com/SAP/ui5-webcomponents/commit/59fead4)) |
| 48 | +* **Framework:** introduce navigationMode property ([#910](https://github.com/SAP/ui5-webcomponents/issues/910)) ([9c43533](https://github.com/SAP/ui5-webcomponents/commit/9c43533)) |
| 49 | + |
| 50 | +### Code Refactoring |
| 51 | +* **ui5-button:** subscribe event handlers via HBS template |
| 52 | +* **ui5-shellbar:** move component to @ui5/webcomponents-fiori package ([#887](https://github.com/SAP/ui5-webcomponents/pull/887)) ([06f1770](https://github.com/SAP/ui5-webcomponents/commit/17c25ff123436c1f6e11513055b33977b06f1770)) |
| 53 | +* **ui5-card:** replace "avatar" property with "avatar" slot ([#928](https://github.com/SAP/ui5-webcomponents/issues/928)) ([0489673](https://github.com/SAP/ui5-webcomponents/commit/0489673)) |
| 54 | +* **ui5-icon:** change "src" property to "name" ([#928](https://github.com/SAP/ui5-webcomponents/issues/928)) ([0489673](https://github.com/SAP/ui5-webcomponents/commit/0489673)) |
| 55 | +* **ui5-shellbar:** rename "icon" slot to "startButton" ([#901](https://github.com/SAP/ui5-webcomponents/issues/901)) ([5ca3280](https://github.com/SAP/ui5-webcomponents/commit/5ca3280)) |
| 56 | +* **ui5-shellbar:** extract animated co-pilot SVG as add-on asset ([#904](https://github.com/SAP/ui5-webcomponents/pull/904)) ([c25e0a7](https://github.com/SAP/ui5-webcomponents/commit/59fead49d7a3222d55270584bb048190dc25e0a7)) |
| 57 | +* **ui5-shellbar:** optimize animated co-pilot SVG size from 15kb to 8kb ([#960](https://github.com/SAP/ui5-webcomponents/pull/960)) ([42bd7cd](https://github.com/SAP/ui5-webcomponents/commit/66d8c62658648cfeb7392607e9b66548c42bd7cd)) |
| 58 | +* **ui5-shellbar-item:** rename "src" property to "name" ([#928](https://github.com/SAP/ui5-webcomponents/pull/928)) ([8e060d1](https://github.com/SAP/ui5-webcomponents/commit/0489673610ce2fd0e96d0a3a1f4e0465d8e060d1)) |
| 59 | + |
| 60 | +### BREAKING CHANGES |
| 61 | + |
| 62 | +* **icons:** move all individual icons to a new npm package called `@ui5/webcomponents-icons`. |
| 63 | + |
| 64 | +You have to install the package |
| 65 | +```js |
| 66 | +npm i @ui5/webcomponents-icons --save |
| 67 | +``` |
| 68 | +The import statements should be changed |
| 69 | + |
| 70 | +Before: |
| 71 | +```js |
| 72 | +@ui5/webcomponents/dist/icons/add.js |
| 73 | +``` |
| 74 | + |
| 75 | +After: |
| 76 | +```js |
| 77 | +@ui5/webcomponents-icons/dist/icons/add.js |
| 78 | +``` |
| 79 | +*Note:* The `ui5-icon` web component is not affected by this change, it is still in the `@ui5/webcomponents` package. Only the icons themselves (the icon assets) have been moved. |
| 80 | + |
| 81 | +* **ui5-icon:** "src" property was renamed to "name". |
| 82 | + |
| 83 | +The "name" poperty accepts icon name (such as "add") instead of icon src (such as "sap-icon://add"). |
| 84 | +Note: the src property will continue to work until the next release due to the impact of the change, but will produce a warning in the console. |
| 85 | + |
| 86 | +* **ui5-shellbar:** move component to new `@ui5/webcomponents-fiori` package ([#887](https://github.com/SAP/ui5-webcomponents/pull/887)) ([06f1770](https://github.com/SAP/ui5-webcomponents/commit/17c25ff123436c1f6e11513055b33977b06f1770)) |
| 87 | + |
| 88 | +Now, you have to import the `<ui5-shellbar>` from the newly created package as follows: |
| 89 | +```js |
| 90 | +import @ui5/webcomponents-fiori/dist/ShellBar.js |
| 91 | +``` |
| 92 | + |
| 93 | +* **ui5-shellbar:** rename "icon" slot to "startButton" ([#901](https://github.com/SAP/ui5-webcomponents/issues/901)) ([5ca3280](https://github.com/SAP/ui5-webcomponents/commit/5ca3280)) |
| 94 | + |
| 95 | +Now, the slot accepts a ui5-button, that would be overstyled to match ui5-shellbar viusal design. |
| 96 | + |
| 97 | +* **ui5-shellbar:** extract animated co-pilot SVG as add-on asset ([#904](https://github.com/SAP/ui5-webcomponents/pull/904)) ([c25e0a7](https://github.com/SAP/ui5-webcomponents/commit/59fead49d7a3222d55270584bb048190dc25e0a7)) |
| 98 | + |
| 99 | +Now, to get the coPilot animated version, you have to import the following module: |
| 100 | +```js |
| 101 | +import @ui5/webcomponents-fiori/dist/features/CoPilotAnimation.js` |
| 102 | +``` |
| 103 | + |
| 104 | +* **ui5-shellbar-item:** "src" property renamed to "name" ([#928](https://github.com/SAP/ui5-webcomponents/pull/928)) ([8e060d1](https://github.com/SAP/ui5-webcomponents/commit/0489673610ce2fd0e96d0a3a1f4e0465d8e060d1)) |
| 105 | + |
| 106 | +The "src" property has been renamed to icon and it accepts icon name (such as "add") instead of icon src (such as "sap-icon://add") |
| 107 | + |
| 108 | +* **ui5-card:** replace "avatar" property with "avatar" slot ([#928](https://github.com/SAP/ui5-webcomponents/issues/928)) ([0489673](https://github.com/SAP/ui5-webcomponents/commit/0489673)) |
| 109 | + |
| 110 | +The "avatar" property has been removed, use the "avatar" slot instead - you can pass an icon(`<ui5-icon>`) or an image(`<img/>`). |
| 111 | + |
| 112 | +Before: |
| 113 | +```html |
| 114 | +<ui5-card avatar="sap-icon://add"></ui5-card> |
| 115 | +``` |
| 116 | + |
| 117 | +After: |
| 118 | +```html |
| 119 | +<ui5-card><ui5-icon name="add" slot="avatar"></ui5-icon></ui5-card>` |
| 120 | +``` |
| 121 | +and respectively: |
| 122 | +```html |
| 123 | +<ui5-card avatar="http://url/to/my/image"></ui5-card>` |
| 124 | +``` |
| 125 | +becomes: |
| 126 | +```html |
| 127 | +<ui5-card><img src="http://url/to/my/image" slot="avatar"/></ui5-card>` |
| 128 | +``` |
| 129 | + |
| 130 | + |
| 131 | + |
6 | 132 | # [1.0.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.0.0-rc.3...v1.0.0-rc.4) (2019-10-11) |
7 | 133 |
|
8 | 134 |
|
|
0 commit comments