Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions content/docs/platform/inbox/react/components/inbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,31 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

By default, the `<Inbox />` renders a bell button, that opens a popover on click. The popover contains the notifications list and the user preferences.

## Try it without keys (Keyless Mode)

Experience Novu Inbox instantly without any prior setup. With Keyless mode, you can integrate and test the component directly in your application. This is perfect for exploring features and triggering test notifications.

```tsx
import React from 'react';
import { Inbox } from '@novu/react';
// If you're using a router like React Router, you might need this for navigation
// import { useNavigate } from 'react-router';

export function NotificationCenter() {
// const navigate = useNavigate(); // Uncomment if using routerPush

return (
<Inbox />
// To enable navigation within notifications later, you can add:
// routerPush={(path: string) => navigate(path)}
);
}
```

<Callout type="info" title="Ready for the Full Experience?">
Keyless mode is designed for quick exploration. To save your configuration, identify users, and unlock all of Novu's powerful features, you'll need to sign up for a free account and configure your environment. <a href="https://dashboard.novu.co/auth/sign-up" target="_blank" rel="noopener noreferrer" class="nx-text-primary-600 nx-underline">Sign up on Novu Cloud</a>
</Callout>

## Basic Usage

```tsx
Expand Down Expand Up @@ -131,7 +156,7 @@ When a user snoozes a notification, it is temporarily removed from the active li

### Snoozing a notification

All dates and times are interpreted in the users local timezone. Users can snooze a notification directly from the <Method href="/platform/inbox/react/components/inbox">{`<Inbox />`}</Method> using one of the following options:
All dates and times are interpreted in the user's local timezone. Users can snooze a notification directly from the <Method href="/platform/inbox/react/components/inbox">{`<Inbox />`}</Method> using one of the following options:

- Preset options:
- An hour from now
Expand Down Expand Up @@ -177,7 +202,7 @@ This logic is built into the component and does not require any additional confi

### Using custom tabs

If youre using custom tabs in the <Method href="/platform/inbox/react/components/inbox">{`<Inbox />`}</Method> component, you can configure a dedicated "Snoozed" or "Reminders" tab by adding a `snoozed: true` filter to your tabs configuration. This helps users navigate more easily and focus on the reminders theyve scheduled.
If you're using custom tabs in the <Method href="/platform/inbox/react/components/inbox">{`<Inbox />`}</Method> component, you can configure a dedicated "Snoozed" or "Reminders" tab by adding a `snoozed: true` filter to your tabs configuration. This helps users navigate more easily and focus on the reminders they've scheduled.

```tsx
import { Inbox } from '@novu/nextjs';
Expand Down
Loading