@bravura/ui 6.0.0 → 6.0.1

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 (3) hide show
  1. package/CHANGELOG.md +632 -629
  2. package/README.md +57 -56
  3. package/package.json +13 -13
package/README.md CHANGED
@@ -1,56 +1,57 @@
1
- # Bravura UI Components for Angular applications
2
-
3
- This package contains a set of UI components built on top of [Angular Material library and Component Development Kit](https://material.angular.io/). It supplements Angular Material in implementing Bravura UX Design System, which is an extension of the latest [Material Design Specification](https://material.io/design).
4
-
5
- [Storybook on Chromatic](https://master--66d58f6d169fef41a850c874.chromatic.com)
6
-
7
- ## Angular version compatibility
8
-
9
- | BUI versions | Compatible Angular versions |
10
- | ------------ | --------------------------- |
11
- | ^5.0.0 | 18 |
12
- | ^4.0.0 | 17 |
13
- | ^3.0.0 | 15, 16 |
14
- | ^2.0.0 | 14 |
15
- | ^1.15.x | 12, 13 |
16
- | 1 .. 1.14.x | 12 |
17
-
18
- ### MDC-based releases
19
-
20
- From version 3.0 onward, the package `@bravura/ui` is only compatible with `@angular/components` 15.1 and up, which is based on the Offical Material Design Components for web. Please refer to [this document](https://material.angular.io/guide/mdc-migration) for more information.
21
-
22
- To continue to use `@bravura/ui` at the latest version in your Angular projects, you must upgrade both Angular and Angular Material packages to version 15 or later. You must also you run the migration tool to switch from the legacy component implementations to the new MDC-based ones. The legacy components from `@angular/components` are no longer supported.
23
-
24
- ## Setup
25
-
26
- Install the package in your Angular project by using one of the commands below, according to the package manager chosen.
27
-
28
- NPM:
29
-
30
- ```
31
- npm install --save @bravura/ui
32
- ```
33
-
34
- Yarn:
35
-
36
- ```
37
- yarn add @bravura/ui
38
- ```
39
-
40
- Import the `NgModule` from one of the sub-packages where the component is provided. For example:
41
-
42
- ```typescript
43
- @import {RadioPanelModule} from '@bravura/ui/radio-panel'
44
- @NgModule({
45
- declarations: [MyComponent],
46
- imports: [RadioPanelModule]
47
- })
48
- export class MyModule {}
49
-
50
- ```
51
-
52
- ## Theming
53
-
54
- To incorporate components' theming with Angular Material, you need to configure a custom theme, following the [theming guide on the Angular Material document site](https://material.angular.io/guide/theming#custom-themes-with-sass). In the global style SASS partial where the Material theme is configured, add the BUI theme mixin reference to activate theming.
55
-
56
- You may also need to include the CSS of custom font definitions for [Material Icon Font](https://fonts.google.com/icons) into the global stylesheets.
1
+ # Bravura UI Components for Angular applications
2
+
3
+ This package contains a set of UI components built on top of [Angular Material library and Component Development Kit](https://material.angular.io/). It supplements Angular Material in implementing Bravura UX Design System, which is an extension of the latest [Material Design Specification](https://material.io/design).
4
+
5
+ [Storybook on Chromatic](https://master--66d58f6d169fef41a850c874.chromatic.com)
6
+
7
+ ## Angular version compatibility
8
+
9
+ | BUI versions | Compatible Angular versions |
10
+ | ------------ | --------------------------- |
11
+ | ^6.0.0 | 19 |
12
+ | ^5.0.0 | 18 |
13
+ | ^4.0.0 | 17 |
14
+ | ^3.0.0 | 15, 16 |
15
+ | ^2.0.0 | 14 |
16
+ | ^1.15.x | 12, 13 |
17
+ | 1 .. 1.14.x | 12 |
18
+
19
+ ### MDC-based releases
20
+
21
+ From version 3.0 onward, the package `@bravura/ui` is only compatible with `@angular/components` 15.1 and up, which is based on the Offical Material Design Components for web. Please refer to [this document](https://material.angular.io/guide/mdc-migration) for more information.
22
+
23
+ To continue to use `@bravura/ui` at the latest version in your Angular projects, you must upgrade both Angular and Angular Material packages to version 15 or later. You must also you run the migration tool to switch from the legacy component implementations to the new MDC-based ones. The legacy components from `@angular/components` are no longer supported.
24
+
25
+ ## Setup
26
+
27
+ Install the package in your Angular project by using one of the commands below, according to the package manager chosen.
28
+
29
+ NPM:
30
+
31
+ ```
32
+ npm install --save @bravura/ui
33
+ ```
34
+
35
+ Yarn:
36
+
37
+ ```
38
+ yarn add @bravura/ui
39
+ ```
40
+
41
+ Import the `NgModule` from one of the sub-packages where the component is provided. For example:
42
+
43
+ ```typescript
44
+ @import {RadioPanelModule} from '@bravura/ui/radio-panel'
45
+ @NgModule({
46
+ declarations: [MyComponent],
47
+ imports: [RadioPanelModule]
48
+ })
49
+ export class MyModule {}
50
+
51
+ ```
52
+
53
+ ## Theming
54
+
55
+ To incorporate components' theming with Angular Material, you need to configure a custom theme, following the [theming guide on the Angular Material document site](https://material.angular.io/guide/theming#custom-themes-with-sass). In the global style SASS partial where the Material theme is configured, add the BUI theme mixin reference to activate theming.
56
+
57
+ You may also need to include the CSS of custom font definitions for [Material Icon Font](https://fonts.google.com/icons) into the global stylesheets.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@bravura/ui",
3
3
  "description": "Bravura UI Components for Angular applications",
4
- "version": "6.0.0",
4
+ "version": "6.0.1",
5
5
  "keywords": [
6
6
  "Angular",
7
7
  "Angular Material",
@@ -47,10 +47,6 @@
47
47
  "types": "./common/index.d.ts",
48
48
  "default": "./fesm2022/bravura-ui-common.mjs"
49
49
  },
50
- "./decimal-input": {
51
- "types": "./decimal-input/index.d.ts",
52
- "default": "./fesm2022/bravura-ui-decimal-input.mjs"
53
- },
54
50
  "./discrete-input": {
55
51
  "types": "./discrete-input/index.d.ts",
56
52
  "default": "./fesm2022/bravura-ui-discrete-input.mjs"
@@ -63,6 +59,10 @@
63
59
  "types": "./file-upload/index.d.ts",
64
60
  "default": "./fesm2022/bravura-ui-file-upload.mjs"
65
61
  },
62
+ "./decimal-input": {
63
+ "types": "./decimal-input/index.d.ts",
64
+ "default": "./fesm2022/bravura-ui-decimal-input.mjs"
65
+ },
66
66
  "./form-field": {
67
67
  "types": "./form-field/index.d.ts",
68
68
  "default": "./fesm2022/bravura-ui-form-field.mjs"
@@ -75,22 +75,22 @@
75
75
  "types": "./panel/index.d.ts",
76
76
  "default": "./fesm2022/bravura-ui-panel.mjs"
77
77
  },
78
- "./phone-number": {
79
- "types": "./phone-number/index.d.ts",
80
- "default": "./fesm2022/bravura-ui-phone-number.mjs"
81
- },
82
- "./skeletons": {
83
- "types": "./skeletons/index.d.ts",
84
- "default": "./fesm2022/bravura-ui-skeletons.mjs"
85
- },
86
78
  "./radio-panel": {
87
79
  "types": "./radio-panel/index.d.ts",
88
80
  "default": "./fesm2022/bravura-ui-radio-panel.mjs"
89
81
  },
82
+ "./phone-number": {
83
+ "types": "./phone-number/index.d.ts",
84
+ "default": "./fesm2022/bravura-ui-phone-number.mjs"
85
+ },
90
86
  "./selection-panel": {
91
87
  "types": "./selection-panel/index.d.ts",
92
88
  "default": "./fesm2022/bravura-ui-selection-panel.mjs"
93
89
  },
90
+ "./skeletons": {
91
+ "types": "./skeletons/index.d.ts",
92
+ "default": "./fesm2022/bravura-ui-skeletons.mjs"
93
+ },
94
94
  "./stepper": {
95
95
  "types": "./stepper/index.d.ts",
96
96
  "default": "./fesm2022/bravura-ui-stepper.mjs"