Skip to content

Commit

Permalink
Merge github.com:SAP/ui5-webcomponents into dynamic-page-petya
Browse files Browse the repository at this point in the history
  • Loading branch information
PetyaMarkovaBogdanova committed Nov 21, 2023
2 parents 13d66e1 + 1534d89 commit e07c78c
Show file tree
Hide file tree
Showing 620 changed files with 11,089 additions and 3,854 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-latest-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install and Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install and Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy_latest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install and Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-auto-weekly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-custom-tag.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-snapshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-issue-comments.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-storybook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install and Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
cache: 'yarn'

- name: Install Dependencies
Expand Down
223 changes: 223 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You are welcome to contribute code to the UI5 Web Components in order to fix bug
There are three important things to know:

1. You must be aware of the Apache License (which describes contributions) and **accept the Developer Certificate of Origin**.
2. Follow our **[Development Conventions and Guidelines](https://sap.github.io/ui5-webcomponents/playground/contributing/conventions-and-guidelines/)**.
2. Follow our **[Development Conventions and Guidelines](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/docs-contributing-conventions-and-guidelines--docs)**.
3. **Not all proposed contributions can be accepted**. Some features may just fit a third-party add-on better. The code must match the overall direction of the UI5 Web Components and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.

## Developer Certificate of Origin (DCO)
Expand All @@ -21,7 +21,7 @@ Due to legal reasons, contributors will be asked to accept a DCO before they sub
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
1. Create a branch by forking the relevant UI5 Web Components repository and apply your change.
1. Commit and push your change on that branch.
- **Please follow our [Development Conventions and Guidelines](https://sap.github.io/ui5-webcomponents/playground/contributing/conventions-and-guidelines/).**
- **Please follow our [Development Conventions and Guidelines](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/docs-contributing-conventions-and-guidelines--docs).**
1. Create a pull request in the UI5 Web Components repository.
1. Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
1. Wait for our code review and approval, possibly enhancing your change on request.
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ UI5 remains what it is: the best choice for…
UI5 Web Components which makes using them in React even more comfortable. The current version of React (`react 18`) has some
shortcomings when it comes to handling Custom Elements, namely the binding of `boolean` attributes as well as adding event listeners to custom event names like `selection-change`. With the help of UI5 Web Components for React, you can use the UI5 Web Components in React as if they were native React components. In addition to that, this library is also offering TypeScript definitions for all components, some complex layout components built on top of UI5 Web Components as well as Charting Components.

### UI5 Web Components for Angular

[UI5 Web Components for Angular](https://github.com/SAP/ui5-webcomponents-ngx) is a wrapper implementation around
UI5 Web Components which to make it work with Angular without needing to use the `CUSTOM_ELEMENTS_SCHEMA` or `NO_ERRORS_SCHEMA` schemas.
Moreover, all Angular-specific features, such as two-way data binding and Angular Form support, work out of the box.

## How to Use

Expand All @@ -84,9 +89,8 @@ shortcomings when it comes to handling Custom Elements, namely the binding of `b
For more information, see [Importing UI5 Web Components](./docs/1-getting-started/02-importing-components.md) and [Understanding UI5 Web Components APIs](./docs/1-getting-started/03-understanding-components-APIs.md).

## Typescript Support
Since 1.11 we are providing Typescript definitions for all public APIs.
However, the **Typescript support is experimental and subject to change**. If you consume the web components via Typescript, you might have to adjust your code before the Typescript definitions become final and officially supported.
Please, share any kind of feedback about the provided types in GitHub.
TypeScript Support is enabled for both component development and component consumption.
Since version `1.11.0`, we have been providing TypeScript definitions under an experimental flag, and starting from version `1.19.0`, all TypeScript definitions are considered `stable`.

### Is there a CDN I can use?

Expand Down
14 changes: 10 additions & 4 deletions docs/1-getting-started/06-using-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Import the feature file from the respective NPM package:

`import "@ui5/<PACKAGE-NAME>/dist/features/<FEATURE-NAME>.js`

## Component features
## Component features

Currently, only a few components offer additional features:

Expand All @@ -31,22 +31,28 @@ Currently, only a few components offer additional features:
| `localization` | Multiple (`ui5-date-picker`, etc...) | `@ui5/webcomponents-localization/dist/features/calendar/Japanese.js` | Japanese calendar support |
| `localization` | Multiple (`ui5-date-picker`, etc...) | `@ui5/webcomponents-localization/dist/features/calendar/Persian.js` | Persian calendar support |

<b>Note:</b> Features must be imported before all components modules,
so that the feature is enabled before the components' definition.

For example:

```js
import "@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js;";

import "@ui5/webcomponents/dist/Button.js";
import "@ui5/webcomponents/dist/Link.js";
import "@ui5/webcomponents/dist/Input.js";
```

## Framework features
## Framework features

| Package | Affects | Feature Import | Description |
|----------------|---------------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| `base` | Framework | `@ui5/webcomponents-base/dist/features/OpenUI5Support.js` | Integration with the OpenUI5 framework, allowing synchronization and resources re-use |
| `base` | Multiple components within all libraries | `@ui5/webcomponents-base/dist/features/F6Navigation.js` | Support for F6 fast groups navigation |
| `base` | Date related components | `@ui5/webcomponents-base/dist/features/LegacyDateFormats.js` | Support for legacy date formats |
|

Framework-level features must be imported before all components modules,
<b>Note:</b> Framework-level features must be imported before all components modules,
so that the feature is enabled upon framework boot, before the components' definition.

For example:
Expand Down
10 changes: 7 additions & 3 deletions docs/1-getting-started/07-typescript-support.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# TypeScript Support

**Note: TypeScript support is experimental and subject to change**. If you consume the web components via TypeScript, you might have to adjust your code before the TypeScript definitions become final and officially supported.
**TypeScript Support is enabled for both component development and component consumption.**

Since version `1.11.0`, we have been providing TypeScript definitions under an experimental flag, and starting from version `1.19.0`, all TypeScript definitions are considered `stable`.
With TypeScript definitions you will benefit from static code checks, autocompletion, and other expected features as expected in a TypeScript application.


**Note:** In exceptional cases, some of the available TypeScript types may change. In such instances, we will document all changes in a prominent manner within our release change log.

Since `1.11.0` we are providing `TypeScript definitions` (as `.d.ts` files) for all framework's and components' APIs, available to applications, written in TypeScript. Previously, without definitions, the usage of UI5 Web Components in TypeScript application was not optimal as the types have been missing and inferred by the TS compiler as `any`.
Now, when accessing a public API, you will benefit from static code checks, autocompletion, etc. as expected in a TypeScript app.

**Example:** usage of `setLanguage` from `@ui5/webcomponents-base`

Expand Down
4 changes: 2 additions & 2 deletions docs/2-advanced/01-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ There are several configuration settings that affect all UI5 Web Components glob
<a name="theme"></a>

The `theme` setting values above are the technical names of the supported themes:
- The `sap_horizon` is known as `Morning Horizon` and it's the latest theme currently available as a preview version.
- The `sap_horizon` is known as `Morning Horizon` and it's the latest theme and default theme.
- The `sap_horizon_dark` is known as `Evening Horizon`.
- The `sap_horizon_hcb` is known as `High Contrast Black`.
- The `sap_horizon_hcw` is known as `High Contrast White`.
- The `sap_fiori_3` is known as `Quartz Light` and it`s the default theme.
- The `sap_fiori_3` is known as `Quartz Light`.
- The `sap_fiori_3_dark` is known as `Quartz Dark`.
- The `sap_fiori_3_hcb` is known as `Quartz High Contrast Black`.
- The `sap_fiori_3_hcw` is known as `Quartz High Contrast White`.
Expand Down
2 changes: 1 addition & 1 deletion docs/4-frameworks/01-React.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In this tutorial, you will learn how to add UI5 Web Components to your application. You can add UI5 Web Components both to new React applications and to already existing ones.

**Important:** The get the best development experience, we recommend using the [UI5 Web Components for React](https://github.com/SAP/ui5-webcomponents-react) and follow the [UI5 Web Components for React Тutorial](https://developers.sap.com/mission.react-spa.html). UI5 Web Components for React library is a React implementation of UI5 Web Components which overcomes several limitations of React in handling web components in general, explained in the "Additional Info" section below.
**Important:** To get the best development experience, we recommend using the [UI5 Web Components for React](https://github.com/SAP/ui5-webcomponents-react) and follow the [UI5 Web Components for React Тutorial](https://developers.sap.com/mission.react-spa.html). UI5 Web Components for React library is a React implementation of UI5 Web Components which overcomes several limitations of React in handling web components in general, explained in the "Additional Info" section below.

Here are the steps to use pure UI5 Web Components in React:

Expand Down
Loading

0 comments on commit e07c78c

Please sign in to comment.