@@ -7,36 +7,34 @@ The `@cap-js/notifications` package is a [CDS plugin](https://cap.cloud.sap/docs
7
7
### Table of Contents
8
8
9
9
- [ Setup] ( #setup )
10
- - [ Usage] ( #usage )
11
- - [ Update Notification Configuration] ( #update-notification-configuration )
12
- - [ Notification Types Path] ( #notification-types-path )
13
- - [ Notification Type Prefix] ( #notification-type-prefix )
14
- - [ Add Notification Types] ( #add-notification-types )
15
10
- [ Add code to send notifications] ( #add-code-to-send-notifications )
16
11
- [ Simple Notification with title] ( #simple-notification-with-title )
17
12
- [ Simple Notification with title and description] ( #simple-notification-with-title-and-description )
18
- - [ Custom Notifications] ( #custom-notifications )
13
+ - [ Add Notification Types] ( #add-notification-types )
14
+ - [ Custom Notifications] ( #custom-notifications )
19
15
- [ With standard parameters] ( #with-standard-parameters )
20
16
- [ Passing the whole notification object] ( #passing-the-whole-notification-object )
21
17
- [ Sample Application with notifications] ( #sample-application-with-notifications )
22
18
- [ In Local Environment] ( #in-local-environment )
23
19
- [ In Production Environment] ( #in-production-environment )
24
20
- [ Notification Destination] ( #notification-destination )
25
21
- [ Integrate with SAP Build Work Zone] ( #integrate-with-sap-build-work-zone )
22
+ - [ Advanced Usage] ( #advanced-usage )
23
+ - [ Update Notification Configuration] ( #update-notification-configuration )
24
+ - [ Notification Types Path] ( #notification-types-path )
25
+ - [ Notification Type Prefix] ( #notification-type-prefix )
26
26
- [ Contributing] ( #contributing )
27
- - [ Code of Conduct] ( #code-of-conduct )
27
+ - [ Code of Conduct] ( #code-of-conduct )
28
28
- [ Licensing] ( #licensing )
29
29
30
30
## Setup
31
31
32
32
To enable notifications, simply add this self-configuring plugin package to your project:
33
33
34
34
``` sh
35
- cds add notifications
35
+ npm add @cap-js/ notifications
36
36
```
37
37
38
- <img width =" 1300 " alt =" cds add notifications " style =" border-radius :0.5rem " src =" _assets/cdsAddNotifications.gif " >
39
-
40
38
## Usage
41
39
42
40
In this guide, we use the [ Incidents Management reference sample app] ( https://github.com/cap-js/incidents-app ) as the base, to publish notifications.
@@ -45,7 +43,7 @@ In this guide, we use the [Incidents Management reference sample app](https://gi
45
43
46
44
` cds add notifications ` will add default configurations for notifications in the ` package.json ` file.
47
45
48
- < img width = " 1300 " alt = " Default Notification config " style = " border-radius : 0.5 rem " src = " _assets/packageJsonConfig.gif " >
46
+
49
47
50
48
#### Notification Types Path
51
49
0 commit comments