chore(PPDSC-2369): add extra description

newscorp-ghfb · Aug 24, 2022 · f52b459 · f52b459
1 parent b6a7d8b
commit f52b459
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/site/components/unpack-content/unpack-content.tsx b/site/components/unpack-content/unpack-content.tsx
@@ -59,6 +59,13 @@ const fragmentToOutput = (
 UnpackComponent checks its children and wraps text, text-based components and text-based html tags inside a TextBlock.
 Also, sibling texts are wrapped in single TextBlock
 
+Why we need this: 
+We have few cases, like `description` prop in `ContentBase` component, 
+which initially thought is going to be used with text only but later we start adding other content as InlineMessage and UnorderedList.
+Adding non text based content leads to having non semantic HTML and validateDOMNesting errors  
+since `description` prop uses TextBlock which is html Paragraphs and it can't contain div ( InlineMessage ) or ul ( UnorderedList ) elements.
+
+Example:
 The transformation looks like this:
 <>
   Text