@fundamental-ngx/ui5-webcomponents-base 0.62.2-rc.8 → 0.62.2-rc.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +49 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,19 +1,27 @@
1
- # ui5-webcomponents-base
1
+ # @fundamental-ngx/ui5-webcomponents-base
2
2
 
3
- Base utilities and types for UI5 Web Components Angular wrappers.
3
+ Base utilities and types shared across all `@fundamental-ngx/ui5-webcomponents-*` packages.
4
4
 
5
5
  ## Overview
6
6
 
7
- This library provides core utilities, TypeScript types, and common functionality used across all UI5 Web Components Angular wrapper libraries. It is typically installed automatically as a peer dependency of other `@fundamental-ngx/ui5-webcomponents-*` packages.
7
+ This library provides the shared infrastructure used by the Angular wrappers for UI5 Web Components. It is installed automatically as a peer dependency of `@fundamental-ngx/ui5-webcomponents`, `@fundamental-ngx/ui5-webcomponents-fiori`, and `@fundamental-ngx/ui5-webcomponents-ai`.
8
8
 
9
- - Common TypeScript types and interfaces
10
- - Shared utilities for UI5 Web Components integration
11
- - Theming support
12
- - Base configuration
9
+ **What's included:**
10
+
11
+ - Re-exported UI5 Web Components type enums (`ValueState`, `CalendarType`, `AnimationMode`, etc.)
12
+ - `UI5WrapperCustomEvent<T, N>` — TypeScript helper for typed custom event payloads from wrapper components
13
+ - Theming API (`provideUi5Theming`, `Ui5ThemingProvider`) for SAP theming integration
14
+ - Language bridge (`provideUi5LanguageBridge`) — syncs Fundamental NGX locale to UI5 Web Components
13
15
 
14
16
  ## Installation
15
17
 
16
- This package is usually installed automatically as a dependency:
18
+ This package is installed automatically as a dependency of the UI5 wrapper libraries:
19
+
20
+ ```bash
21
+ npm install @fundamental-ngx/ui5-webcomponents
22
+ ```
23
+
24
+ If you need it standalone:
17
25
 
18
26
  ```bash
19
27
  npm install @fundamental-ngx/ui5-webcomponents-base
@@ -21,14 +29,44 @@ npm install @fundamental-ngx/ui5-webcomponents-base
21
29
 
22
30
  ## Usage
23
31
 
24
- This package is primarily used internally by other UI5 Web Components packages. You typically don't need to import from it directly unless you're building custom wrappers or need access to shared types.
32
+ ### Typed custom events
33
+
34
+ Use `UI5WrapperCustomEvent<T, N>` to get the strongly-typed payload of a UI5 wrapper output:
25
35
 
26
36
  ```typescript
27
- import { UI5CustomEvent } from '@ui5/webcomponents-base';
37
+ import { UI5WrapperCustomEvent } from '@fundamental-ngx/ui5-webcomponents-base';
38
+ import { ButtonComponent } from '@fundamental-ngx/ui5-webcomponents';
39
+
40
+ // Get the event payload type for the "click" output of ButtonComponent
41
+ type ClickEvent = UI5WrapperCustomEvent<ButtonComponent, 'ui5Click'>;
28
42
  ```
29
43
 
44
+ ### Re-exported UI5 types
45
+
46
+ Common UI5 enums are re-exported so you don't need to import from `@ui5/webcomponents-base` directly:
47
+
48
+ ```typescript
49
+ import { ValueState, CalendarType, AnimationMode } from '@fundamental-ngx/ui5-webcomponents-base';
50
+ ```
51
+
52
+ ### Language bridge
53
+
54
+ The language bridge keeps UI5 Web Components in sync with the Fundamental NGX locale signal. Add it once in your root providers:
55
+
56
+ ```typescript
57
+ // app.config.ts
58
+ import { ApplicationConfig } from '@angular/core';
59
+ import { provideUi5LanguageBridge } from '@fundamental-ngx/ui5-webcomponents-base/i18n';
60
+
61
+ export const appConfig: ApplicationConfig = {
62
+ providers: [provideUi5LanguageBridge()],
63
+ };
64
+ ```
65
+
66
+ After this, changing the `FD_LANGUAGE_SIGNAL` will automatically update the locale used by UI5 Web Components.
67
+
30
68
  ## Resources
31
69
 
32
- - [UI5 Web Components Documentation](https://ui5.github.io/webcomponents/)
70
+ - [UI5 Web Components Documentation](https://sap.github.io/ui5-webcomponents/)
33
71
  - [Fundamental NGX Documentation](https://sap.github.io/fundamental-ngx)
34
72
  - [GitHub Repository](https://github.com/SAP/fundamental-ngx)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fundamental-ngx/ui5-webcomponents-base",
3
- "version": "0.62.2-rc.8",
3
+ "version": "0.62.2-rc.9",
4
4
  "schematics": "./schematics/collection.json",
5
5
  "description": "Official SAP Angular base library for UI5 Web Component wrappers – part of the Fundamental Library for Angular.",
6
6
  "keywords": [
@@ -38,7 +38,7 @@
38
38
  "@angular/forms": "^21.0.0",
39
39
  "@angular/platform-browser": "^21.0.0",
40
40
  "@angular/router": "^21.0.0",
41
- "@fundamental-ngx/i18n": "0.62.2-rc.8",
41
+ "@fundamental-ngx/i18n": "0.62.2-rc.9",
42
42
  "@ui5/webcomponents-base": "^2.21.0",
43
43
  "fundamental-styles": "0.41.5",
44
44
  "rxjs": "^7.8.0"