-
Notifications
You must be signed in to change notification settings - Fork 111
Content for the set up the inbox component page #896
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
0800d9e
Rearrange the core concept section
Aviatorscode2 4e20e14
Merge pull request #893 from novuhq/concept
Aviatorscode2 db9a816
Structure the inbox section
Aviatorscode2 bc03392
Content for the set up the inbox component page
Aviatorscode2 1db389d
Update content/docs/platform/inbox/setup-inbox.mdx
Aviatorscode2 cf8c9d9
Update content/docs/platform/inbox/setup-inbox.mdx
Aviatorscode2 c17ed95
Update content/docs/platform/inbox/setup-inbox.mdx
Aviatorscode2 88bf34c
Update content/docs/platform/inbox/setup-inbox.mdx
Aviatorscode2 4639b76
Update content/docs/platform/inbox/setup-inbox.mdx
Aviatorscode2 3db9914
Update EU region code sample
Aviatorscode2 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "title": "Concepts", | ||
| "icon": "Layers", | ||
| "pages": ["notification-event", "workflows", "subscribers", "topics", "integrations"] | ||
| } | ||
2 changes: 1 addition & 1 deletion
2
.../docs/platform/concepts/notifications.mdx → .../platform/concepts/notification-event.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
content/docs/platform/inbox/advanced-customization/custom-bell.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| title: 'Custom Bell' | ||
| description: "Learn how to integrate Novu <Inbox />, a pre-built notification center component for real-time in-app notifications in your application." | ||
| icon: 'LayoutDashboard' | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'fumadocs-ui/components/card'; | ||
| import { MessageSquare, Palette, Zap } from 'lucide-react'; | ||
|
|
||
| The Inbox component enables a rich context-aware in-app notifications center directly in your application, and with minimal effort. |
10 changes: 10 additions & 0 deletions
10
content/docs/platform/inbox/advanced-customization/custom-notification.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| title: 'Custom Notification' | ||
| description: "Learn how to integrate Novu <Inbox />, a pre-built notification center component for real-time in-app notifications in your application." | ||
| icon: 'LayoutDashboard' | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'fumadocs-ui/components/card'; | ||
| import { MessageSquare, Palette, Zap } from 'lucide-react'; | ||
|
|
||
| The Inbox component enables a rich context-aware in-app notifications center directly in your application, and with minimal effort. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Advanced Customization", | ||
| "icon": "Layers", | ||
| "pages": ["custom-notification", "custom-bell", "render-html-content"], | ||
| "description": "Learn how to customize your inbox with advanced features like custom notifications, templates, and actions." | ||
| } |
12 changes: 12 additions & 0 deletions
12
content/docs/platform/inbox/advanced-customization/render-html-content.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| pageTitle: 'Render HTML Content' | ||
| title: 'Render HTML Content' | ||
| description: 'Learn how to style the pre built Inbox component' | ||
| icon: 'Palette' | ||
| --- | ||
|
|
||
| import { TypeTable } from 'fumadocs-ui/components/type-table'; | ||
|
|
||
| ## Customization Hierarchy | ||
|
|
||
| The Inbox component is built to allow for multiple layers of styling, which allows the specificity required to style the Inbox to meet the requirements of your use case. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| pageTitle: 'Data Object' | ||
| title: 'Data Object' | ||
| description: 'Learn how to style the pre built Inbox component' | ||
| icon: 'Palette' | ||
| --- | ||
|
|
||
| import { TypeTable } from 'fumadocs-ui/components/type-table'; | ||
|
|
||
| ## Customization Hierarchy | ||
|
|
||
| The Inbox component is built to allow for multiple layers of styling, which allows the specificity required to style the Inbox to meet the requirements of your use case. |
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Confiquration", | ||
| "icon": "Layers", | ||
| "pages": ["styling", "tabs", "preferences", "data-object", "snooze", "localization"], | ||
| "description": "Learn how to configure your inbox with styling, tabs, preferences, data objects, snooze functionality, and localization options." | ||
| } |
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| pageTitle: 'Snooze' | ||
| title: 'Snooze' | ||
| description: 'Learn how to style the pre built Inbox component' | ||
| icon: 'Palette' | ||
| --- | ||
|
|
||
| import { TypeTable } from 'fumadocs-ui/components/type-table'; | ||
|
|
||
| ## Customization Hierarchy | ||
|
|
||
| The Inbox component is built to allow for multiple layers of styling, which allows the specificity required to style the Inbox to meet the requirements of your use case. |
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...nt/docs/platform/inbox/react/headless.mdx → content/docs/platform/inbox/headless.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,12 @@ | ||
| { | ||
| "pages": ["overview", "...react"] | ||
| "pages": [ | ||
| "setup-inbox", | ||
| "navigation-and-events", | ||
| "configuration", | ||
| "advanced-customization", | ||
| "prepare-for-production", | ||
| "tenants", | ||
| "headless", | ||
| "migration-guide" | ||
| ] | ||
| } |
2 changes: 1 addition & 1 deletion
2
.../platform/inbox/react/migration-guide.mdx → ...t/docs/platform/inbox/migration-guide.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: 'Navigation and Events' | ||
| description: "Learn how to integrate Novu <Inbox />, a pre-built notification center component for real-time in-app notifications in your application." | ||
| icon: 'LayoutDashboard' | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'fumadocs-ui/components/card'; | ||
| import { MessageSquare, Palette, Zap } from 'lucide-react'; | ||
|
|
||
| The Inbox component enables a rich context-aware in-app notifications center directly in your application, and with minimal effort. | ||
|
|
||
| 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. | ||
|
|
||
| <img src="/images/inbox/[email protected]" alt="Fully functional and customizable React Inbox component" /> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| <Cards> | ||
| <Card | ||
| title="Next.js" | ||
| href="/platform/quickstart/nextjs" | ||
| description="Get started with our pre-built UI component in Next.js" | ||
| /> | ||
| <Card | ||
| title="React" | ||
| href="/platform/quickstart/react" | ||
| description="Get started with our pre-built UI component in React" | ||
| /> | ||
| <Card | ||
| title="Remix" | ||
| href="/platform/quickstart/remix" | ||
| description="Get started with our pre-built UI component in Remix" | ||
| /> | ||
| </Cards> | ||
|
|
||
| ## Design Files | ||
|
|
||
| To aide your design process, we provide a free [Figma file](https://www.figma.com/community/file/1425407348374863860) that contains all of the design assets. Make a copy of the file into your own account to get started with customizing your graphical Inbox elements. |
4 changes: 2 additions & 2 deletions
4
.../docs/platform/inbox/react/production.mdx → ...platform/inbox/prepare-for-production.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| title: 'Set up the Inbox' | ||
| description: 'Learn how to integrate the Novu Inbox component into your application to display real-time notifications for your users.' | ||
| icon: 'Bell' | ||
| --- | ||
|
|
||
| import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; | ||
| import Link from 'next/link'; | ||
|
|
||
| You can add the Novu Inbox component to your application with few lines of code minimal setup. | ||
|
||
|
|
||
| ## Try Inbox in Keyless Mode | ||
Aviatorscode2 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Keyless mode lets you test the look and features of the Inbox component instantly in your application, no setup required. | ||
|
|
||
| <Tabs items = {['Next.js', 'React']}> | ||
| <Tab value="Next.js"> | ||
| ```tsx | ||
| import { Inbox } from '@novu/nextjs'; | ||
|
|
||
| export function Novu() { | ||
| return ( | ||
| <Inbox /> | ||
| ); | ||
| } | ||
| ``` | ||
| </Tab> | ||
| <Tab value="React"> | ||
| ```tsx | ||
| import { Inbox } from '@novu/react'; | ||
|
|
||
| export function Novu() { | ||
| return ( | ||
| <Inbox /> | ||
| ); | ||
| } | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| <div style={{ display: 'flex', justifyContent: 'center' }}> | ||
jainpawan21 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <img src="/images/inbox/Inbox.png" alt="Test" width="400" height="400" /> | ||
| </div> | ||
|
|
||
| ## Use Inbox with real subscribers | ||
|
|
||
| To display real-time notifications for your users, connect the Inbox component to your Novu environment using your `applicationIdentifier` and a `subscriberId`. You can create or manage subscribers from the <a href="https://dashboard.novu.co/auth/sign-up" target="_blank" rel="noopener noreferrer" class="nx-text-primary-600 nx-underline">Novu Dashboard</a>. | ||
Aviatorscode2 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### US Region (Default) | ||
|
|
||
| <Tabs items = {['Next.js', 'React']}> | ||
| <Tab value="Next.js"> | ||
| ```tsx | ||
| import { Inbox } from '@novu/nextjs'; | ||
|
|
||
| export function Novu() { | ||
| return ( | ||
| <Inbox | ||
| applicationIdentifier="APPLICATION_IDENTIFIER" | ||
| subscriber="SUBSCRIBER_ID" | ||
| /> | ||
| ); | ||
| } | ||
| ``` | ||
| </Tab> | ||
| <Tab value="React"> | ||
| ```tsx | ||
| import { Inbox } from '@novu/react'; | ||
|
|
||
| export function Novu() { | ||
| return ( | ||
| <Inbox | ||
| applicationIdentifier="APPLICATION_IDENTIFIER" | ||
| subscriber="SUBSCRIBER_ID" | ||
| /> | ||
| ); | ||
| } | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| <div className="text-sm text-gray-500 text-center mt-2"> | ||
| <Link href="https://dashboard.novu.co/auth/sign-up">Sign in</Link> to get your own API keys | ||
| </div> | ||
|
|
||
| ### EU Region | ||
Aviatorscode2 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If your Novu account is in the EU region, include the `backendUrl` and `socketUrl` props to connect to EU-specific API endpoints: | ||
Aviatorscode2 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <Tabs items = {['EU']}> | ||
jainpawan21 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <Tab value= "EU"> | ||
| ```tsx | ||
| import { Inbox } from '@novu/react'; | ||
|
|
||
| export function Novu() { | ||
| return ( | ||
| <Inbox | ||
| subscriber="SUBSCRIBER_ID" | ||
| applicationIdentifier="APPLICATION_IDENTIFIER" | ||
| backendUrl="https://eu.api.novu.co" | ||
| socketUrl="https://eu.ws.novu.co" | ||
| /> | ||
| ); | ||
| } | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
jainpawan21 marked this conversation as resolved.
Show resolved
Hide resolved
|
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Aviatorscode2
Please remove the changes from this PR which is not related to inbox architecture