Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

Add localization support for chat message components with enhanced Translation component (#4560)

Copilota937b5742389
diff --git a/web/components/chat/ChatJoinMessage/ChatJoinMessage.tsx b/web/components/chat/ChatJoinMessage/ChatJoinMessage.tsx
index 302f1333df..0125d95da9 100644
--- a/web/components/chat/ChatJoinMessage/ChatJoinMessage.tsx
+++ b/web/components/chat/ChatJoinMessage/ChatJoinMessage.tsx
@@ -1,6 +1,8 @@
import { FC } from 'react';
import dynamic from 'next/dynamic';
import { ModerationBadge } from '../ChatUserBadge/ModerationBadge';
+import { Translation } from '../../ui/Translation/Translation';
+import { Localization } from '../../../types/localization';
import styles from './ChatJoinMessage.module.scss';
@@ -29,13 +31,19 @@ export const ChatJoinMessage: FC<ChatJoinMessageProps> = ({
<span className={styles.icon}>
<UsergroupAddOutlined />
</span>
- <span className={styles.user}>{displayName}</span>
{isAuthorModerator && (
<span className={styles.moderatorBadge}>
<ModerationBadge userColor={userColor} />
</span>
)}
- <span className={styles.joinMessage}>joined the chat.</span>
+ <span className={styles.joinMessage}>
+ <span className={styles.user}>{displayName}</span>
+ <span> </span>
+ <Translation
+ translationKey={Localization.Frontend.Chat.userJoined}
+ defaultText="joined the chat."
+ />
+ </span>
</span>
</div>
);
diff --git a/web/components/chat/ChatModeratorNotification/ChatModeratorNotification.tsx b/web/components/chat/ChatModeratorNotification/ChatModeratorNotification.tsx
index 7d83e29785..4d22ff815d 100644
--- a/web/components/chat/ChatModeratorNotification/ChatModeratorNotification.tsx
+++ b/web/components/chat/ChatModeratorNotification/ChatModeratorNotification.tsx
@@ -1,9 +1,14 @@
+import { Translation } from '../../ui/Translation/Translation';
+import { Localization } from '../../../types/localization';
import styles from './ChatModeratorNotification.module.scss';
import Icon from '../../../assets/images/moderator.svg';
export const ChatModeratorNotification = () => (
<div className={styles.chatModerationNotification}>
<Icon className={styles.icon} />
- You are now a moderator.
+ <Translation
+ translationKey={Localization.Frontend.Chat.moderatorNotification}
+ defaultText="You are now a moderator."
+ />
</div>
);
diff --git a/web/components/chat/ChatNameChangeMessage/ChatNameChangeMessage.tsx b/web/components/chat/ChatNameChangeMessage/ChatNameChangeMessage.tsx
index 152edfc0a4..ac02bb0dc7 100644
--- a/web/components/chat/ChatNameChangeMessage/ChatNameChangeMessage.tsx
+++ b/web/components/chat/ChatNameChangeMessage/ChatNameChangeMessage.tsx
@@ -1,8 +1,8 @@
-// export const ChatSocialMessage: FC<ChatSocialMessageProps> = ({ message }) => {
-
import dynamic from 'next/dynamic';
import { FC } from 'react';
import { NameChangeEvent } from '../../../interfaces/socket-events';
+import { Translation } from '../../ui/Translation/Translation';
+import { Localization } from '../../../types/localization';
import styles from './ChatNameChangeMessage.module.scss';
export interface ChatNameChangeMessageProps {
@@ -27,10 +27,14 @@ export const ChatNameChangeMessage: FC<ChatNameChangeMessageProps> = ({ message
</div>
<div className={styles.nameChangeText}>
<span style={{ color }}>{oldName}</span>
- <span className={styles.plain} id="owncast-name-change-is-now-known-text">
- {' '}
- is now known as{' '}
- </span>
+ <span> </span>
+ <Translation
+ translationKey={Localization.Frontend.Chat.nameChangeText}
+ className={styles.plain}
+ id="owncast-name-change-is-now-known-text"
+ defaultText="is now known as"
+ />
+ <span> </span>
<span style={{ color }}>{displayName}</span>
</div>
</div>
diff --git a/web/components/chat/ChatPartMessage/ChatPartMessage.tsx b/web/components/chat/ChatPartMessage/ChatPartMessage.tsx
index 7dbb37d9dc..52b2e173fa 100644
--- a/web/components/chat/ChatPartMessage/ChatPartMessage.tsx
+++ b/web/components/chat/ChatPartMessage/ChatPartMessage.tsx
@@ -1,6 +1,8 @@
import { FC } from 'react';
import dynamic from 'next/dynamic';
import { ModerationBadge } from '../ChatUserBadge/ModerationBadge';
+import { Translation } from '../../ui/Translation/Translation';
+import { Localization } from '../../../types/localization';
import styles from './ChatPartMessage.module.scss';
@@ -29,13 +31,19 @@ export const ChatPartMessage: FC<ChatPartMessageProps> = ({
<span className={styles.icon}>
<UsergroupDeleteOutlined />
</span>
- <span className={styles.user}>{displayName}</span>
{isAuthorModerator && (
<span className={styles.moderatorBadge}>
<ModerationBadge userColor={userColor} />
</span>
)}
- <span className={styles.partMessage}>left the chat.</span>
+ <span className={styles.partMessage}>
+ <span className={styles.user}>{displayName}</span>
+ <span> </span>
+ <Translation
+ translationKey={Localization.Frontend.Chat.userLeft}
+ defaultText="left the chat."
+ />
+ </span>
</span>
</div>
);
diff --git a/web/components/ui/Translation/Translation.tsx b/web/components/ui/Translation/Translation.tsx
index 9d90f72091..8735e90b54 100644
--- a/web/components/ui/Translation/Translation.tsx
+++ b/web/components/ui/Translation/Translation.tsx
@@ -7,6 +7,7 @@ export interface TranslationProps {
translationKey: LocalizationKey;
vars?: Record<string, any>;
className?: string;
+ id?: string;
defaultText?: string;
count?: number;
}
@@ -15,6 +16,7 @@ export const Translation: FC<TranslationProps> = ({
translationKey,
vars,
className,
+ id,
defaultText,
count,
}) => {
@@ -55,7 +57,9 @@ export const Translation: FC<TranslationProps> = ({
}
}
- return <span className={className} dangerouslySetInnerHTML={{ __html: translatedText }} />;
+ return (
+ <span className={className} id={id} dangerouslySetInnerHTML={{ __html: translatedText }} />
+ );
};
export default Translation;
diff --git a/web/i18n/en/translation.json b/web/i18n/en/translation.json
index a40ebd9804..287a0250ef 100644
--- a/web/i18n/en/translation.json
+++ b/web/i18n/en/translation.json
@@ -118,6 +118,12 @@
"contribute": "Contribute",
"source": "Source"
},
+ "Chat": {
+ "userJoined": "joined the chat.",
+ "userLeft": "left the chat.",
+ "nameChangeText": "is now known as",
+ "moderatorNotification": "You are now a moderator."
+ ,
"FollowModal": {
"description": "By following this stream you'll get notified on the Fediverse when it goes live. Now is a great time to",
"learnFediverse": "learn about the Fediverse",
diff --git a/web/types/localization.ts b/web/types/localization.ts
index 41739f7c6d..7a20778aa6 100644
--- a/web/types/localization.ts
+++ b/web/types/localization.ts
@@ -100,6 +100,14 @@ export const Localization = {
source: 'Frontend.Footer.source',
},
+ // Chat message components
+ Chat: {
+ userJoined: 'Frontend.Chat.userJoined',
+ userLeft: 'Frontend.Chat.userLeft',
+ nameChangeText: 'Frontend.Chat.nameChangeText',
+ moderatorNotification: 'Frontend.Chat.moderatorNotification',
+ },
+
// Follow modal component
FollowModal: {
description: 'Frontend.FollowModal.description',