Merge pull request #784 from brumeregan/master

Adding support for nested component inside Trans

src/Trans.js

@@ -11,6 +11,11 @@ function getChildren(node) {
   return node && node.children ? node.children : node.props && node.props.children;
 }
 
+function hasValidReactChildren(children) {
+  if (Object.prototype.toString.call(children) !== '[object Array]') return false;
+  return children.every(child => React.isValidElement(child));
+}
+
 export function nodesToString(mem, children, index, i18nOptions) {
   if (!children) return '';
   if (Object.prototype.toString.call(children) !== '[object Array]') children = [children];
@@ -98,14 +103,24 @@ function renderNodes(children, targetString, i18n, i18nOptions) {
     if (Object.prototype.toString.call(astNodes) !== '[object Array]') astNodes = [astNodes];
 
     return astNodes.reduce((mem, node, i) => {
+      const translationContent = node.children && node.children[0] && node.children[0].content;
       if (node.type === 'tag') {
         const child = reactNodes[parseInt(node.name, 10)] || {};
         const isElement = React.isValidElement(child);
 
         if (typeof child === 'string') {
           mem.push(child);
         } else if (hasChildren(child)) {
-          const inner = mapAST(getChildren(child), node.children);
+          let inner;
+          if (
+            hasValidReactChildren(getChildren(child)) &&
+            mapAST(getChildren(child), node.children).length === 0
+          ) {
+            // In a case Trans have nested components without translation values
+            inner = getChildren(child);
+          } else {
+            inner = mapAST(getChildren(child), node.children);
+          }
           if (child.dummy) child.children = inner; // needed on preact!
           mem.push(React.cloneElement(child, { ...child.props, key: i }, inner));
         } else if (isNaN(node.name) && i18nOptions.transSupportBasicHtmlNodes) {
@@ -117,15 +132,20 @@ function renderNodes(children, targetString, i18n, i18nOptions) {
             mem.push(React.createElement(node.name, { key: `${node.name}-${i}` }, inner));
           }
         } else if (typeof child === 'object' && !isElement) {
-          const content = node.children[0] ? node.children[0].content : null;
-
+          const content = node.children[0] ? translationContent : null;
           // v1
           // as interpolation was done already we just have a regular content node
           // in the translation AST while having an object in reactNodes
           // -> push the content no need to interpolate again
           if (content) mem.push(content);
         } else {
-          mem.push(child);
+          if (node.children.length === 1 && translationContent) {
+            // If component does not have children, but translation - has
+            // with this in component could be components={[<span class='make-beautiful'/>]} and in translation - 'some text <0>some highlighted message</0>'
+            mem.push(React.cloneElement(child, { ...child.props, key: i }, translationContent));
+          } else {
+            mem.push(child);
+          }
         }
       } else if (node.type === 'text') {
         mem.push(node.content);

test/i18n.js

@@ -33,6 +33,9 @@ i18n.init({
         testTransKey3_plural: 'Result: <1><0>{{numOfItems}}</0></1> items matched.',
         testInvalidHtml: '<hello',
         testInvalidHtml2: '<hello>',
+        testTrans4KeyWithNestedComponent: 'Result should be a list: <0></0>',
+        testTrans5KeyWithNestedComponent: 'Result should be a list: <1></1>',
+        testTrans5KeyWithValue: 'Result should be rendered within tag <0>{{testValue}}</0>',
       },
       other: {
         transTest1: 'Another go <1>there</1>.',

test/trans.render.spec.js

@@ -365,3 +365,88 @@ describe('trans should not break on invalid node from translations - part2', ()
     expect(wrapper.contains(<div>&lt;hello&gt;</div>)).toBe(true);
   });
 });
+
+describe('Trans should render nested components', () => {
+  it('should render dynamic ul as components property', () => {
+    const list = ['li1', 'li2'];
+
+    const TestElement = () => (
+      <Trans
+        i18nKey="testTrans4KeyWithNestedComponent"
+        components={[
+          <ul>
+            {list.map(item => (
+              <li key={item}>{item}</li>
+            ))}
+          </ul>,
+        ]}
+      />
+    );
+    const wrapper = mount(<TestElement />);
+
+    expect(
+      wrapper.contains(
+        <ul>
+          <li>li1</li>
+          <li>li2</li>
+        </ul>,
+      ),
+    ).toBe(true);
+  });
+
+  it('should render dynamic ul as components property when pass as a children', () => {
+    const list = ['li1', 'li2'];
+
+    const TestElement = () => (
+      <Trans i18nKey="testTrans5KeyWithNestedComponent">
+        My list:
+        <ul>
+          {list.map(item => (
+            <li key={item}>{item}</li>
+          ))}
+        </ul>
+      </Trans>
+    );
+    const wrapper = mount(<TestElement />);
+    expect(
+      wrapper.contains(
+        <ul>
+          <li>li1</li>
+          <li>li2</li>
+        </ul>,
+      ),
+    ).toBe(true);
+  });
+});
+
+describe('Trans should use value from translation', () => {
+  it('should use value from translation if no data provided in component', () => {
+    const TestElement = () => (
+      <Trans
+        i18nKey="testTrans5KeyWithValue"
+        values={{
+          testValue: 'dragonfly',
+        }}
+        components={[<span className="awesome-styles" />]}
+      />
+    );
+
+    const wrapper = mount(<TestElement />);
+    expect(wrapper.contains(<span className="awesome-styles">dragonfly</span>)).toBe(true);
+  });
+
+  it('should use value from translation if dummy data provided in component', () => {
+    const TestElement = () => (
+      <Trans
+        i18nKey="testTrans5KeyWithValue"
+        values={{
+          testValue: 'dragonfly',
+        }}
+        components={[<span className="awesome-styles">test string</span>]}
+      />
+    );
+
+    const wrapper = mount(<TestElement />);
+    expect(wrapper.contains(<span className="awesome-styles">dragonfly</span>)).toBe(true);
+  });
+});