Skip to content

Commit

Permalink
Merge branch 'main' into input-events
Browse files Browse the repository at this point in the history
  • Loading branch information
nikoletavnv committed Apr 18, 2024
2 parents 2a0bf9e + fc8d15a commit 8527bf2
Show file tree
Hide file tree
Showing 160 changed files with 2,272 additions and 783 deletions.
76 changes: 38 additions & 38 deletions .github/workflows/release-rc-auto.yaml
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
name: Release RC version [auto]
# name: Release RC version [auto]

on:
schedule:
- cron: "00 08 * * THU"
# on:
# schedule:
# - cron: "00 08 * * THU"

jobs:
build-and-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
fetch-depth: 0
- uses: actions/setup-node@v4.0.1
with:
node-version: 18
cache: 'yarn'
# jobs:
# build-and-release:
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# with:
# token: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
# fetch-depth: 0
# - uses: actions/setup-node@v4.0.1
# with:
# node-version: 18
# cache: 'yarn'

- name: Install
run: yarn --frozen-lockfile
# - name: Install
# run: yarn --frozen-lockfile

- name: Version Bump
env:
NPM_USERNAME: ${{ secrets.NPM_USER }}
NPM_EMAIL: ${{ secrets.NPM_EMAIL }}
NPM_AUTH_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
GH_TOKEN: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
run: |
npm config set //registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}
git config user.name "${{ secrets.UI5_WEBCOMP_BOT_NAME }}"
git config user.email "${{ secrets.UI5_WEBCOMP_BOT_EMAIL }}"
yarn lerna version --conventional-prerelease --force-publish --yes --exact --create-release github
# - name: Version Bump
# env:
# NPM_USERNAME: ${{ secrets.NPM_USER }}
# NPM_EMAIL: ${{ secrets.NPM_EMAIL }}
# NPM_AUTH_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
# GH_TOKEN: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
# run: |
# npm config set //registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}
# git config user.name "${{ secrets.UI5_WEBCOMP_BOT_NAME }}"
# git config user.email "${{ secrets.UI5_WEBCOMP_BOT_EMAIL }}"
# yarn lerna version --conventional-prerelease --force-publish --yes --exact --create-release github

- name: Build
run: yarn ci:releasebuild
# - name: Build
# run: yarn ci:releasebuild

- name: Publish
env:
NPM_USERNAME: ${{ secrets.NPM_USER }}
NPM_EMAIL: ${{ secrets.NPM_EMAIL }}
NPM_AUTH_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
GH_TOKEN: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
run: yarn lerna publish from-git --yes
# - name: Publish
# env:
# NPM_USERNAME: ${{ secrets.NPM_USER }}
# NPM_EMAIL: ${{ secrets.NPM_EMAIL }}
# NPM_AUTH_TOKEN: ${{ secrets.NPM_RELEASE_AUTH_TOKEN }}
# GH_TOKEN: ${{ secrets.UI5_WEBCOMP_BOT_GH_TOKEN }}
# run: yarn lerna publish from-git --yes
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,57 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# [2.0.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v2.0.0-rc.1...v2.0.0-rc.2) (2024-04-18)


### Bug Fixes

* **u5-dialog:** soft keyboard is correctly opened on iOS devices ([#8583](https://github.com/SAP/ui5-webcomponents/issues/8583)) ([6cf1d74](https://github.com/SAP/ui5-webcomponents/commit/6cf1d746e59352430d0d086cf0814dc7ce7fdb9c))
* **ui5-calendar, ui5-daterange-picker:** align range selection styling with vd specification ([#8585](https://github.com/SAP/ui5-webcomponents/issues/8585)) ([d4f0e0e](https://github.com/SAP/ui5-webcomponents/commit/d4f0e0e93bc9dcd9c4261b2c3eed37cf4f85435f))
* **ui5-menu-item:** apply scoping to internal `Icon` ([#8751](https://github.com/SAP/ui5-webcomponents/issues/8751)) ([ce55755](https://github.com/SAP/ui5-webcomponents/commit/ce55755c05a5588759d751da9749dbde0bbba722))
* **ui5-popover:** fix popover going out of the viewport ([#8735](https://github.com/SAP/ui5-webcomponents/issues/8735)) ([bca8f2a](https://github.com/SAP/ui5-webcomponents/commit/bca8f2a3ff15d002ce778bf85e1d2dd8da789059))
* **ui5-progress-indicator:** hidden value design ([#8545](https://github.com/SAP/ui5-webcomponents/issues/8545)) ([bf094d3](https://github.com/SAP/ui5-webcomponents/commit/bf094d3df92311d7d051b10aff8167b832e84d26))
* **ui5-responsive-popover:** fix dialog initial focus ([#8774](https://github.com/SAP/ui5-webcomponents/issues/8774)) ([27b522f](https://github.com/SAP/ui5-webcomponents/commit/27b522f145d21be814cc5f02ee74674c8e3db745))
* **ui5-shellbar:** aligned specs ([#8694](https://github.com/SAP/ui5-webcomponents/issues/8694)) ([c5ec720](https://github.com/SAP/ui5-webcomponents/commit/c5ec720c8fd362b6fe2f502d473bec5fc4071b38))
* **ui5-shellbar:** assistant icon color fixed ([#8713](https://github.com/SAP/ui5-webcomponents/issues/8713)) ([e501ac8](https://github.com/SAP/ui5-webcomponents/commit/e501ac8147bb979319a6e055ba98458650884112))
* **ui5-side-navigation:** import overflow icon ([#8736](https://github.com/SAP/ui5-webcomponents/issues/8736)) ([8bc1bb4](https://github.com/SAP/ui5-webcomponents/commit/8bc1bb4698e71c66e1fb59508e115b9e612912fb))
* **ui5-side-navigation:** replace items and fixedItems union type with SideNavigationItemBase ([#8740](https://github.com/SAP/ui5-webcomponents/issues/8740)) ([b589486](https://github.com/SAP/ui5-webcomponents/commit/b58948676049565410592700b1796475f1ea94fa))
* **ui5-split-button:** add correct opacity when disabled ([#8738](https://github.com/SAP/ui5-webcomponents/issues/8738)) ([399144e](https://github.com/SAP/ui5-webcomponents/commit/399144e8b186dd61d2eb23ed42e5050335e5ecd7)), closes [#8615](https://github.com/SAP/ui5-webcomponents/issues/8615)
* **ui5-tabcontainer:** prevent endless resizing when moving after last overflow item ([#8725](https://github.com/SAP/ui5-webcomponents/issues/8725)) ([c33ba40](https://github.com/SAP/ui5-webcomponents/commit/c33ba404c559109a2dfe2166722f03f2c5c6b691))
* **ui5-tabcontainer:** replace default slot union type with interface ([#8734](https://github.com/SAP/ui5-webcomponents/issues/8734)) ([ac6b44f](https://github.com/SAP/ui5-webcomponents/commit/ac6b44f9eaeb1604f1bbd4ae6f37e6dec817c1ef))


### Code Refactoring

* **ui5-multi-combobox:** rename property allowCustomValues to noValidation ([#8765](https://github.com/SAP/ui5-webcomponents/issues/8765)) ([bb27acb](https://github.com/SAP/ui5-webcomponents/commit/bb27acbc2f8321219d99c7732d8536a00ae38272))
* **ui5-textarea:** rename property growingMaxLines to growingMaxRows ([#8756](https://github.com/SAP/ui5-webcomponents/issues/8756)) ([3fd33ab](https://github.com/SAP/ui5-webcomponents/commit/3fd33aba0164e0a5c06bd44d057157a1dd54b522)), closes [#8461](https://github.com/SAP/ui5-webcomponents/issues/8461)


### Features

* **ui5-avatar-group:** update focus handling ([#8550](https://github.com/SAP/ui5-webcomponents/issues/8550)) ([0bb5c9d](https://github.com/SAP/ui5-webcomponents/commit/0bb5c9d8632092d875fa6333d817475aa73f1e71)), closes [#8320](https://github.com/SAP/ui5-webcomponents/issues/8320)
* **ui5-barcode-scanner-dialog:** add support for close and open events ([#8753](https://github.com/SAP/ui5-webcomponents/issues/8753)) ([1ae2142](https://github.com/SAP/ui5-webcomponents/commit/1ae2142aa6ba2c587126e49422724658686d2344)), closes [#8695](https://github.com/SAP/ui5-webcomponents/issues/8695)
* **ui5-date-*:** adapt date and time controls to timezone feature ([#8610](https://github.com/SAP/ui5-webcomponents/issues/8610)) ([1acae01](https://github.com/SAP/ui5-webcomponents/commit/1acae010eb81f4d50368587b66c8840bdf886d04)), closes [#8461](https://github.com/SAP/ui5-webcomponents/issues/8461)
* **ui5-li:** add support for F2 key ([#8619](https://github.com/SAP/ui5-webcomponents/issues/8619)) ([24c3807](https://github.com/SAP/ui5-webcomponents/commit/24c380758f88b3f66dce46e2f57297634b42a85a)), closes [#7736](https://github.com/SAP/ui5-webcomponents/issues/7736)
* **ui5-link:** introduce `tooltip` property ([#8670](https://github.com/SAP/ui5-webcomponents/issues/8670)) ([ef64000](https://github.com/SAP/ui5-webcomponents/commit/ef640006e466a9a3e01bb9d241c3a3fc2962d8d0))
* **ui5-message-strip:** introduce custom colors ([#8757](https://github.com/SAP/ui5-webcomponents/issues/8757)) ([d30f424](https://github.com/SAP/ui5-webcomponents/commit/d30f4240df5922888854d027dfcff732b5316ccc))


### BREAKING CHANGES

* **ui5-multi-combobox:** The `allowCustomValues` property have been renamed to `noValidation`.
If you have previously used the `allowCustomValues` property
`<ui5-multi-combobox allow-custom-values></ui5-multi-combobox>`
Now use noValidation instead:
`<ui5-multi-combobox no-validation></ui5-multi-combobox>`

Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
* **ui5-textarea:** The `growingMaxLines` property have been renamed to `growingMaxRows`.





# [2.0.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v2.0.0-rc.0...v2.0.0-rc.1) (2024-04-11)


Expand Down
1 change: 1 addition & 0 deletions docs/2-advanced/07-accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ The mapping of the accessibility APIs to ARIA attributes is described in the fol
| `checked` | `aria-checked` | Defines whether the component is checked. |
| `level`, `headerLevel` | `aria-level` | Defines the heading level of a title. Available options are: "H6" to "H1". |
| `interactive` | `tabindex` | Defines if the component is interactive (focusable and pressable). |
| `tooltip` | `title` | Defines the tooltip of the component.

### accessibleName

Expand Down
54 changes: 27 additions & 27 deletions docs/5-development/05-testing-UI5-Web-Components.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Testing UI5 Web Components

**Note:** All examples in this tutorial are taken from the demo UI5 Web Component (`ui5-demo`), generated by the package initialization script.
**Note:** All examples in this tutorial are taken from the demo UI5 Web Component (`ui5-demo`), generated by the package initialization script.
For more information on creating a new package with a demo web component inside, click [here](./01-custom-UI5-Web-Components-Packages.md).

## 1. Prerequisites

The test framework of choice for UI5 Web Components is [WebdriverIO](https://webdriver.io/) or WDIO for short.
It has a straightforward API - [https://webdriver.io/docs/api.html](https://webdriver.io/docs/api.html), and has excellent support for Web Components.

The browser of choice for test execution is [Google Chrome](https://www.google.com/chrome/), respectively the WebDriver used is [ChromeDriver](https://chromedriver.chromium.org/).
The browser of choice for test execution is [Google Chrome](https://www.google.com/chrome/), respectively the WebDriver used is [ChromeDriver](https://chromedriver.chromium.org/).

#### Managing ChromeDriver

Expand All @@ -18,24 +18,24 @@ You can install it with `npm`:
- `npm i --save-dev chromedriver`

or with `yarn`:
- `yarn add -D chromedriver`
- `yarn add -D chromedriver`

Google Chrome and ChromeDriver need to be the same version to work together. Whenever you update Google Chrome on
your system (or it updates automatically, if allowed), you are expected to also update ChromeDriver to the respective version.

## 2. Running the tests

## 2.1 Test configuration
## 2.1 Test configuration

The configuration for WDIO can be found in the `config/` directory under `wdio.conf.js`.

As explained [here](./01-custom-UI5-Web-Components-Packages.md) in the section about the `config/` directory, you can
As explained [here](./01-custom-UI5-Web-Components-Packages.md) in the section about the `config/` directory, you can
customize, or even completely replace the default configuration.

However, before doing so, please note the following two benefits of working with the default configuration, provided by UI5 Web Components:
- Hooks, synchronizing the execution of all relevant WDIO commands (e.g. `click`, `url`, `$`, `$$`) with the rendering of the framework to
- Hooks, synchronizing the execution of all relevant WDIO commands (e.g. `click`, `url`, `$`, `$$`) with the rendering of the framework to
ensure consistency when reading or changing the state of the components.
- Additional API methods: `setProperty`, `setAttribute`, `removeAttribute`, `hasClass`.
- Additional API methods: `setProperty`, `setAttribute`, `removeAttribute`, `hasClass`.

So our recommendation would be to modify it, if necessary, but not completely replace it.

Expand Down Expand Up @@ -76,7 +76,7 @@ describe("ui5-demo rendering", async () => {
assert.ok(innerContent, "content rendered");
});
});
```
```

Key points:
- Load the test page with the `browser.url` command. You can do this once for each test suite or for each individual test.
Expand All @@ -89,7 +89,7 @@ Key points:

For WDIO capabilities, see:
- Official API: [https://webdriver.io/docs/api.html](https://webdriver.io/docs/api.html).
- Additional commands provided in our standard WDIO configuration: `setProperty`, `setAttribute`, `removeAttribute`, `hasClass`.
- Additional commands provided in our standard WDIO configuration: `setProperty`, `setAttribute`, `removeAttribute`, `hasClass`.

**Note:** The standard WDIO configuration we provide automatically synchronizes all test commands' execution with the framework rendering cycle.
Therefore, in the example above, the `shadow$` command will internally wait for all rendering to be over before being executed. The
Expand All @@ -102,19 +102,19 @@ Debugging with WDIO is really simple. Just follow these 3 steps:
1. Change the WDIO configuration file `config/wdio.conf.js` to disable `headless` mode for Google Chrome as follows:

From:

```js
module.exports = require("@ui5/webcomponents-tools/components-package/wdio.js");
```

to:

```js
const result = require("@ui5/webcomponents-tools/components-package/wdio.js");
result.config.capabilities[0]["goog:chromeOptions"].args = ['--disable-gpu']; // From: ['--disable-gpu', '--headless']
module.exports = result;
```

If you happen to debug often, it's recommended to keep the file in this format and just comment out the middle line when you're done debugging.

2. Set a breakpoint with `browser.debug` somewhere in your test:
Expand All @@ -126,29 +126,29 @@ Debugging with WDIO is really simple. Just follow these 3 steps:
assert.ok(innerContent, "content rendered");
});
```

For more on `debug`, see [https://webdriver.io/docs/api/browser/debug.html](https://webdriver.io/docs/api/browser/debug.html).

3. Run the single test spec and wait for the browser to open and pause on your breakpoint:

- Run the dev server, if you haven't already:
`yarn start`
or

`yarn start`

or

`npm run start`.

- Run the single test spec:
`yarn test test/specs/Demo.spec.js`
or

`yarn test test/specs/Demo.spec.js`

or

`npm run test test/specs/Demo.spec.js`.
Google Chrome will then open in a new window, controlled by WDIO via the ChromeDriver, and your test will pause on your
breakpoint of choice. Proceed to debug normally.

Google Chrome will then open in a new window, controlled by WDIO via the ChromeDriver, and your test will pause on your
breakpoint of choice. Proceed to debug normally.

## 5. Best practices for writing tests

Expand Down Expand Up @@ -176,7 +176,7 @@ Use:
Preferred:
```js
assert.ok(await browser.$(<SELECTOR>).isExisting())
```
```

instead of:

Expand Down
51 changes: 50 additions & 1 deletion docs/Migrating to version 2.0 guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# UI5 Web Components 2.0 migration guide

This documentation will assist you in seamlessly transitioning from UI5 Web Components v1.x to the latest version, UI5 Web Components 2.0.

## General and Framework


Expand Down Expand Up @@ -230,6 +232,19 @@ Now use `selectionMode` and `Single`, `Multiple` instead:
<ui5-list selection-mode="Multiple">
```

### ui5-multi-combobox

| Changed item | Old | New |
|------------------------------|------------|---------------|
| Property | `allowCustomValues` | `noValidation` |

- The `allowCustomValues` property has been renamed to `noValidation`.
If you have previously used the `allowCustomValues` property
`<ui5-multi-combobox allow-custom-values></ui5-multi-combobox>`
Now use noValidation instead:
`<ui5-multi-combobox no-validation></ui5-multi-combobox>`


### ui5-option

| Changed item | Old | New |
Expand Down Expand Up @@ -365,6 +380,13 @@ Now use:
someTabSeparator.getDomRefInStrip();
```

### ui5-textarea

| Changed item | Old | New |
|--------------|-----------|---------------------------------------------------------------------|
| Property | `growingMaxLines` | `growingMaxRows` |

- The `growingMaxLines` property has been renamed to `growingMaxRows`.

### ui5-tree

Expand Down Expand Up @@ -398,6 +420,33 @@ Now, import the `ui5-bar` from `main`:
import "@ui5/webcomponents/dist/Bar.js";
```

### ui5-barcode-scanner-dialog

| Changed item | Old | New |
|---------------|-----------|-----------------|
| Public method | `show()` | `open` property |
| Public method | `close()` | `open` property |

- The `show` and `close` public methods have been removed. Use the public property `open` instead.

For example, if you used:

```js
d.show();
...
d.close();
```

use:

```js
d.open = true;
...
d.open = false;
```

instead.

### ui5-illustrated-message

| Changed item | Old | New |
Expand Down Expand Up @@ -464,4 +513,4 @@ import type UploadCollectionItem from "@ui5/webcomponents-fiori/dist/UploadColle
| Icon | `add-polygone` | `add-polygon` |

- Removed `soccor` icon. Use `soccer` instead.
- Removed `add-polygone` icon. Use `add-polygon` instead.
- Removed `add-polygone` icon. Use `add-polygon` instead.
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"packages/website",
"packages/create-package"
],
"version": "2.0.0-rc.1",
"version": "2.0.0-rc.2",
"command": {
"publish": {
"allowBranch": "*",
Expand Down
Loading

0 comments on commit 8527bf2

Please sign in to comment.