Localizing the Inbox component

Learn how to localize the pre built Inbox component

Localization Prop

The localization prop can be used to change the copywriting of the Inbox to a different language for your users or change the wording to suit your product. See the list of available keys, or use the fully typed TS auto complete to find the key you need.

import { Inbox } from '@novu/react';

function Novu() {
  return (
    <Inbox
      applicationIdentifier="YOUR_APPLICATION_IDENTIFIER"
      subscriberId="YOUR_SUBSCRIBER_ID"
      localization={{
        'inbox.status.archived': 'Archived',
        'inbox.status.unread': 'Unread',
        'inbox.status.options.archived': 'Archived',
        'inbox.status.options.unread': 'Unread',
        'inbox.status.options.unreadRead': 'Unread/Read',
        'inbox.status.unreadRead': 'Unread/Read',
        'inbox.title': 'Inbox',
        'notifications.emptyNotice': 'No notifications',
        dynamic: {
          // use the workflowId as a key to localize the workflow name
          'comment-on-post': 'Post comments',
        },
        locale: 'en-US',
      }}
    />
  );
}

Specifying the workflow name using Framework

In addition to specifying a workflow name in the <Inbox /> component, you can also specify the workflow name in your Framework definition. The name property is optional, so if you don’t specify it, the workflowId will be used as the name.

import { workflow } from '@novu/framework';

const weeklyCommentsWorkflow = workflow(
  'comment-on-post',
  async ({ step }) => {
    ...
  });
}, {
  name: 'Post comments', // 👈 name is optional
});

Now, your specified workflow name will be displayed in the <Inbox /> component:

Localized workflow name