chore: deprecate isTranslated prop (#1772)

lingui · Sep 27, 2023 · d6501e3 · d6501e3 · vercel · Sep 27, 2023
1 parent 79e7a03
commit d6501e3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/packages/react/src/TransNoContext.tsx b/packages/react/src/TransNoContext.tsx
@@ -9,6 +9,9 @@ export type TransRenderProps = {
   translation: React.ReactNode
   children: React.ReactNode
   message?: string | null
+  /**
+   * @deprecated isTranslated prop is undocumented and buggy. It'll be removed in v5 release.
+   * */
   isTranslated: boolean
 }
 
@@ -107,6 +110,7 @@ export function TransNoContext(
     id,
     message,
     translation,
+    // TODO vonovak - remove isTranslated prop in v5 release
     isTranslated: id !== translation && message !== translation,
     children: translation, // for type-compatibility with `component` prop
   }

diff --git a/website/docs/ref/react.md b/website/docs/ref/react.md
@@ -94,9 +94,7 @@ i18n.load({
 });
 i18n.activate("en");
 
-const DefaultI18n = ({ isTranslated, children }) => (
-  <span style={{ color: isTranslated ? undefined : "red" }}>{children}</span>
-);
+const DefaultI18n = ({ children }) => <span>{children}</span>;
 
 const App = () => {
   return (