stream-chat-react-native-core/src/a11y/hooks/useA11yLabel.ts

The official React Native and Expo components for Stream Chat, a service for building chat applications

import { useContext } from 'react';

import { useAccessibilityContext } from '../../contexts/accessibilityContext/AccessibilityContext';
import { TranslationContext } from '../../contexts/translationContext/TranslationContext';

/**
 * Returns the translated `a11y/...` label when the AccessibilityContext is enabled,
 * or `undefined` when disabled. Components pass the result straight to
 * `accessibilityLabel` so the i18n lookup is skipped on hot list paths in the
 * default disabled-state.
 *
 * Example:
 *   const labelParams = useMemo(() => ({ name }), [name]);
 *   const label = useA11yLabel('a11y/Avatar of {{name}}', labelParams);
 *   <Image accessibilityLabel={label} />
 */
export const useA11yLabel = (key: string, params?: Record<string, unknown>): string | undefined => {
  const { enabled } = useAccessibilityContext();
  const { t } = useContext(TranslationContext);
  if (!enabled || !key) return undefined;
  return t(key, params);
};