Skip to content

Update icons.mdx #924

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.

Sign up for GitHub

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 1 commit into from
Aug 8, 2025
Merged

Update icons.mdx #924

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions content/docs/platform/inbox/configuration/icons.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
pageTitle: 'Customize Icons in the Inbox'
title: 'Icons'
description: 'Learn how to configure avatar images in the In-App step editor and override the default icons in the Inbox UI using the appearance prop.'
description: 'Learn how to configure avatar images in the in-app step editor and override the default icons in the Inbox UI using the appearance prop.'
icon: 'Sparkle'
---

Every icon in the Inbox component UI can be customized, allowing you to align its appearance with your application's branding and design system.

## Change or remove a in-app notification avatar

In the **in-app step** of your workflow editor, you can customize the avatar shown beside a notification by providing an **Avatar URL**. This can be:
In the in-app step of your workflow editor, you can customize the avatar shown beside a notification by providing an Avatar URL. This can be:

- A **static URL**: For example, to show a brand or team icon.
- A **dynamic value**: Using templating syntax like `{{subscriber.avatar}}` or `{{payload.avatarUrl}}`, which resolves to values from your subscriber context or trigger payload.
- Any default avatars provided in the editor
- **A static URL**: For example, to show a brand or team icon.
- **A dynamic value**: Using templating syntax like `{{subscriber.avatar}}` or `{{payload.avatarUrl}}`, which resolves to values from your subscriber context or trigger payload.
- Any default avatars provided in the editor.

![In-app avatar](/images/inbox/inbox-avatar.gif)

## Customize default icons in the Inbox component UI

You can replace all the default icons in the Inbox UI with custom icons from your preferred library, such as [react-icons](https://react-icons.github.io/react-icons/) or [Material Icons](https://mui.com/material-ui/material-icons/)., to match your visual style using the' icons' key in the `appearance` prop.
You can replace all the default icons in the Inbox UI with custom icons from your preferred library, such as [react-icons](https://react-icons.github.io/react-icons/) or [Material Icons](https://mui.com/material-ui/material-icons/), to match your visual style using the' icons' key in the `appearance` prop.

For each icon you want to customize, provide a function that returns your custom icon as a React component.
For each icon that you want to customize, provide a function that returns your custom icon as a React component.

```tsx
import { Inbox } from '@novu/react';
Expand All @@ -46,11 +46,11 @@ export function Novu() {
}
```

### List of customizable icons
## List of customizable icons

Use these keys in the `appearance.icons` property to customize specific icons in the Inbox component:

| Icon Key | Description |
| Icon key | Description |
| -------------------- | ---------------------------------------------------- |
| `arrowDown` | Down arrow used in drop-downs and expandable sections |
| `arrowDropDown` | Drop-down arrow in menus and selectors |
Expand Down
Loading