@fundamental-ngx/core 0.62.0-rc.70 → 0.62.0-rc.71

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 +24 -99
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @Fundamental-NGX/Core
1
+ # @fundamental-ngx/core
2
2
 
3
3
  [![npm version](https://badge.fury.io/js/%40fundamental-ngx%2Fcore.svg)](//www.npmjs.com/package/@fundamental-ngx/core)
4
4
  ![Build Status](https://github.com/SAP/fundamental-ngx/actions/workflows/create-release.yml/badge.svg?branch=main)
@@ -6,120 +6,45 @@
6
6
  [![Slack](https://img.shields.io/badge/slack-ui--fundamentals-blue.svg?logo=slack)](https://ui-fundamentals.slack.com)
7
7
  [![REUSE status](https://api.reuse.software/badge/github.com/SAP/fundamental-ngx)](https://api.reuse.software/info/github.com/SAP/fundamental-ngx)
8
8
 
9
- ## Content
9
+ ## Description
10
10
 
11
- - [1. Description](#1)
12
- - [2. Requirements](#2)
13
- - [3. Versioning](#3)
14
- - [4. Getting Started](#4)
15
- - [5. Known Issues](#5)
16
- - [6. Support](#6)
17
- - [7. Contributing](#7)
18
- - [8. License](https://github.com/SAP/fundamental-ngx/blob/main/LICENSE.txt)
19
- - [9. Similar Projects](#8)
11
+ `@fundamental-ngx/core` is a set of Angular components built on the SAP Design System. It provides base UI components (button, dialog, card, calendar, table, etc.) that can be customized directly in templates.
20
12
 
21
- ## <a name="1"></a>1. Description
13
+ See the [Component Documentation](https://sap.github.io/fundamental-ngx) for examples and API details.
22
14
 
23
- The `@fundamental-ngx/core` library is a set of [Angular](https://angular.io/) components built using [Fundamental Library Styles](https://sap.github.io/fundamental-styles/).
15
+ ## Requirements
24
16
 
25
- The Fundamental Library for Angular is an SAP Design System Angular component library used to build modern product user experiences with the SAP look and feel.
17
+ Angular 21 or newer. Prior knowledge of Angular is recommended.
26
18
 
27
- See [Component Documentation](https://sap.github.io/fundamental-ngx/#/core/new-component) for examples and API details.
19
+ ## Getting Started
28
20
 
29
- ## <a name="2"></a>2. Requirements
21
+ ```bash
22
+ ng add @fundamental-ngx/core
23
+ ```
30
24
 
31
- To download and use Fundamental Library for Angular, you will first need to install the [node package manager](https://www.npmjs.com/get-npm).
25
+ Import individual components (standalone by default):
32
26
 
33
- Fundamental Library for Angular is intended for use with Angular 15 or newer.
27
+ ```typescript
28
+ import { ButtonComponent } from '@fundamental-ngx/core/button';
29
+ import { DialogModule } from '@fundamental-ngx/core/dialog';
30
+ ```
34
31
 
35
- Prior knowledge of Angular is recommended, to use the fundamental-ngx library.
32
+ ## Versioning
36
33
 
37
- ## <a name="3"></a>3. Versioning
34
+ Check the [Breaking Changes](https://github.com/SAP/fundamental-ngx/wiki#breaking-changes) for upgrade guidance.
38
35
 
39
- Check the [Breaking Changes](https://github.com/SAP/fundamental-ngx/wiki#breaking-changes) for the latest patches changes.
36
+ ## Known Issues
40
37
 
41
- ## <a name="4"></a>4. Getting Started
38
+ See [Issues](https://github.com/SAP/fundamental-ngx/issues).
42
39
 
43
- For an existing Angular CLI application,
44
-
45
- 0. **Video tutorial**
46
- [How to use the Fundamental Core Library](https://www.youtube.com/watch?v=i4VIiuzD2Fg)
47
-
48
- 1. **Install Fundamental-NGX.**
49
- `ng add @fundamental-ngx/core`
50
- For models prior to 0.10 use `fundamental-ngx`
51
-
52
- _If you do not use the Angular CLI or if this command does not work for you, please see the [full installation guide](https://github.com/SAP/fundamental-ngx/wiki/Full-Installation-Guide)._
53
-
54
- 1. **Edit your tsconfig.**
55
- Edit the `target` in your `tsconfig.json` to `es5`. The library is incompatible with later versions.
56
- 1. **Import the modules you want to use.**
57
-
58
- To add the entire library, add the following import to your main application module.
59
-
60
- ```typescript
61
- import { FundamentalNgxCoreModule } from '@fundamental-ngx/core';
62
-
63
- @NgModule({
64
- ...
65
- imports: [FundamentalNgxCoreModule],
66
- })
67
- export class DemoModule { }
68
- ```
69
-
70
- To include an individual Angular Fundamental component in your application, you only need to import the relevant module.
71
-
72
- For example, to use Switchs, add the following import to your main application module.
73
-
74
- ```typescript
75
- import { CheckboxModule } from '@fundamental-ngx/core';
76
- ```
77
-
78
- Version 0.31.0 brings new way of importing individual modules, which is prefered way.
79
-
80
- ```typescript
81
- import { CheckboxModule } from '@fundamental-ngx/core/checkbox';
82
- ```
83
-
84
- For models prior to 0.10 use `fundamental-ngx`
85
-
86
- ```typescript
87
- import { CheckboxModule } from 'fundamental-ngx';
88
-
89
- @NgModule({
90
- ...
91
- imports: [CheckboxModule],
92
- })
93
- export class DemoModule { }
94
- ```
95
-
96
- 1. **Provide the RtlService.**
97
- In your main application module, add `RtlService` to the list of providers. This service is needed to ensure proper right-to-left functionality for
98
- users with their browser set to an RTL language.
99
- 1. **Provide the ContentDensityService.**
100
- In your main application module, you will also need to add `ContentDensityService` to the list of providers if you wish to manage the content density of
101
- you application from a single point.
102
-
103
- 1. **Add the component to your HTML.**
104
-
105
- ```html
106
- <fd-checkbox label="Fundamental Ngx Checkbox"></fd-checkbox>
107
- ```
108
-
109
- ## <a name="5"></a>5. Known Issues
110
-
111
- Please see [Issues](https://github.com/SAP/fundamental-ngx/issues).
112
-
113
- ## <a name="6"></a>6. Support
40
+ ## Support
114
41
 
115
42
  If you encounter an issue, you can [create a ticket](https://github.com/SAP/fundamental-ngx/issues).
116
43
 
117
- ## <a name="7"></a>7. Contributing
118
-
119
- If you want to contribute, please check the [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) documentation for contribution guidelines. Please follow the [Angular commit message guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
44
+ ## Contributing
120
45
 
121
- Check out the [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) guide on building a new component for the library and creating the necessary documentation for your new component.
46
+ See [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) for guidelines and [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) for building new components.
122
47
 
123
- ## <a name="9"></a>8. Similar Projects
48
+ ## License
124
49
 
125
- [Fundamental-react](https://github.com/SAP/fundamental-react) - React implementation of Fundamental Library Styles
50
+ See [LICENSE.txt](https://github.com/SAP/fundamental-ngx/blob/main/LICENSE.txt).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fundamental-ngx/core",
3
- "version": "0.62.0-rc.70",
3
+ "version": "0.62.0-rc.71",
4
4
  "schematics": "./schematics/collection.json",
5
5
  "ng-update": {
6
6
  "migrations": "./schematics/migrations.json"
@@ -22,8 +22,8 @@
22
22
  "@angular/forms": "^21.0.0",
23
23
  "@angular/platform-browser": "^21.0.0",
24
24
  "@angular/router": "^21.0.0",
25
- "@fundamental-ngx/cdk": "0.62.0-rc.70",
26
- "@fundamental-ngx/i18n": "0.62.0-rc.70",
25
+ "@fundamental-ngx/cdk": "0.62.0-rc.71",
26
+ "@fundamental-ngx/i18n": "0.62.0-rc.71",
27
27
  "@sap-theming/theming-base-content": "^11.32.0",
28
28
  "fundamental-styles": "0.41.1",
29
29
  "rxjs": "^7.8.0"