An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
/**
* @file i18n.ts
* @input Uses the TranslatorFn type
* @output Exports reactionDescription
* @position Localized names for the Comments family's default reactions
*
* SYNC: When modified, update these files to stay in sync:
* - /packages/lab/src/Comments/types.ts (DEFAULT_COMMENT_REACTIONS)
* - /packages/core/locales/en.json (@astryx.comments.reaction*)
*/
import type {TranslatorFn} from '@astryxdesign/core/i18n';
import type {CommentReactionOption} from './types';
/* Catalog keys for the names of DEFAULT_COMMENT_REACTIONS, by reaction key. */
const DEFAULT_REACTION_NAME_KEYS: Readonly<Record<string, string>> = {
like: '@astryx.comments.reactionLike',
love: '@astryx.comments.reactionLove',
laugh: '@astryx.comments.reactionLaugh',
wow: '@astryx.comments.reactionWow',
sad: '@astryx.comments.reactionSad',
celebrate: '@astryx.comments.reactionCelebrate',
};
/**
* A reaction's human-readable name: the host's `description`, else the
* localized name of a default reaction, else its glyph.
*/
export function reactionDescription(
t: TranslatorFn,
reaction: Pick<CommentReactionOption, 'key' | 'label' | 'description'>,
): string {
if (reaction.description != null && reaction.description !== '') {
return reaction.description;
}
const key = DEFAULT_REACTION_NAME_KEYS[reaction.key];
return key != null ? t(key) : reaction.label;
}