Skip to content

Commit 27886e9

Browse files
authored
Merge pull request #692 from novuhq/inbox-docs-update
Inbox docs update
2 parents 3385195 + 83c3ee0 commit 27886e9

21 files changed

+879
-825
lines changed

.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.words": [
3+
"topbar"
4+
]
5+
}

images/inbox/Elements.png

70.6 KB
Loading

images/inbox/Variables Inbox.png

88.1 KB
Loading

inbox/introduction.mdx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
title: 'Introduction'
3-
description: "Learn more about Novu's Inbox Component."
2+
title: 'Overview'
3+
description: "Learn more about Novu's Inbox component."
44
---
55

66
The Inbox component enables a rich context-aware in-app notifications center directly in your application, and with minimal effort.
77

8-
In-App notifications are different from push notifications because the notifications are consumed directly by the user in your app itself, whereas push notifications are shown on the device level. Read more about [push channel and supported providers.](/channels-and-providers/push/overview)
9-
108
Novu provides a pre-built, ready-to-use, and customizable Inbox UI component. It's in React today, and soon will be available in other popular frameworks including Vue, React Native, and full headless.
119

1210
<Frame caption="Fully functional and customizable React Inbox component">

inbox/react/advanced-configuration.mdx

+19-18
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,6 @@ sidebarTitle: 'Advanced Configuration'
44
description: 'Learn how to configure the Inbox component with advanced options'
55
---
66

7-
## Use your own backend and socket URL
8-
9-
By default, Novu's hosted services for API and socket are used. If you want, you can override them and configure your own.
10-
11-
```tsx
12-
import { Inbox } from '@novu/react';
13-
14-
function Novu() {
15-
return (
16-
<Inbox
17-
applicationIdentifier="YOUR_APPLICATION_IDENTIFIER"
18-
subscriberId="YOUR_SUBSCRIBER_ID"
19-
backendUrl="YOUR_BACKEND_URL"
20-
socketUrl="YOUR_SOCKET_URL"
21-
/>
22-
);
23-
}
24-
```
257

268
## HMAC Encryption
279

@@ -67,3 +49,22 @@ const hmacHash = createHmac('sha256', process.env.NOVU_API_KEY)
6749
## Backend SDK Methods
6850

6951
[Backend sdk methods](/sdks/framework/typescript/overview)
52+
53+
## Use your own backend and socket URL
54+
55+
By default, Novu's hosted services for API and socket are used. If you want, you can override them and configure your own.
56+
57+
```tsx
58+
import { Inbox } from '@novu/react';
59+
60+
function Novu() {
61+
return (
62+
<Inbox
63+
applicationIdentifier="YOUR_APPLICATION_IDENTIFIER"
64+
subscriberId="YOUR_SUBSCRIBER_ID"
65+
backendUrl="YOUR_BACKEND_URL"
66+
socketUrl="YOUR_SOCKET_URL"
67+
/>
68+
);
69+
}
70+
```

inbox/react/components.mdx

-303
This file was deleted.

0 commit comments

Comments
 (0)