You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-22Lines changed: 21 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,10 @@
1
-
2
-
<H1>Siren React Inbox</H1>
1
+
# Siren React Inbox
3
2
4
3
## Overview
5
4
6
5
The `@siren/react-inbox` sdk is a comprehensive and customizable React UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the sdk effectively.
7
6
8
-
###1. Installation
7
+
## 1. Installation
9
8
10
9
You can install the react sdk from npm
11
10
@@ -22,8 +21,8 @@ yarn @siren/react-inbox
22
21
23
22
- React v16.8+
24
23
25
-
###2. Configuration
26
-
####2.1 Initialization
24
+
## 2. Configuration
25
+
### 2.1 Initialization
27
26
Initialize the sdk with user token and recipient id. Wrap the provider around your App's root.
28
27
29
28
```js
@@ -37,7 +36,7 @@ const config = {
37
36
<SirenProvider config={config}>{/* Your app components */}</SirenProvider>;
38
37
```
39
38
40
-
####2.2 Configure notification inbox
39
+
### 2.2 Configure notification inbox
41
40
Once the provider is configured, next step is to configure the notification inbox
42
41
43
42
Inbox is a paginated list view for displaying notifications.
@@ -75,8 +74,8 @@ loadMoreComponent | Custom load more component | JSX Element | null |
0 commit comments