Add support for returnObjects: true (#172)

* Add support for returnObjects: true * changeset
Shopify · Sep 8, 2023 · 75ba1dc · 75ba1dc
1 parent 673be57
commit 75ba1dc
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/.changeset/thirty-eels-hang.md b/.changeset/thirty-eels-hang.md
@@ -0,0 +1,5 @@
+---
+'@shopify/i18next-shopify': patch
+---
+
+Allow t() to accept returnObjects: true
diff --git a/src/index.js b/src/index.js
@@ -32,6 +32,11 @@ class ShopifyFormat {
   parse(res, options) {
     // const hadSuccessfulLookup = info && info.resolved && info.resolved.res;
 
+    // returnObjects parameter can cause objects to be resolved, rather than a single string
+    if (typeof res === 'object') {
+      return res;
+    }
+
     // Interpolations
     const matches = res.match(MUSTACHE_FORMAT);
     if (!matches) {

diff --git a/test/shopify_format_with_react_i18next.spec.js b/test/shopify_format_with_react_i18next.spec.js
@@ -44,6 +44,9 @@ describe('shopify format with react-i18next (t)', () => {
                   other: 'This is my {{ordinal}}th car',
                 },
               },
+              nested_level_1: {
+                nested_level_2: 'Nested content',
+              },
             },
           },
         },
@@ -163,6 +166,15 @@ describe('shopify format with react-i18next (t)', () => {
       }),
     ).toBe('This is my 2st car');
   });
+
+  it('handles returnObjects: true', () => {
+    const {result} = renderHook(() => useTranslation('translation'));
+    const {t} = result.current;
+
+    expect(t('nested_level_1', {returnObjects: true})).toStrictEqual({
+      nested_level_2: 'Nested content',
+    });
+  });
 });
 
 describe('with react-i18next (Trans)', () => {