fix: description type

ccontrols · Nov 16, 2020 · 95cf813 · 95cf813
1 parent ae1c3aa
commit 95cf813
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/core/store/src/state/context/document.tsx b/core/store/src/state/context/document.tsx
@@ -267,7 +267,9 @@ export const useGetDocumentPath = (): UseGetDocumentPath => {
 /**
  * Returns the descript for a document page. It uses the doc.description property if available, or if there is a component assigned to the document will return the component's name.
  */
-export const useDocDescription = (doc?: Document): string | undefined => {
+export const useDocDescription = (
+  doc?: Document,
+): string | JSX.Element | undefined => {
   const store = useStore();
   if (!doc) {
     return undefined;

diff --git a/core/store/src/state/recoil/document.ts b/core/store/src/state/recoil/document.ts
@@ -297,7 +297,9 @@ export const useGetDocumentPath = (): UseGetDocumentPath => {
 /**
  * Returns the descript for a document page. It uses the doc.description property if available, or if there is a component assigned to the document will return the component's name.
  */
-export const useDocDescription = (doc?: Document): string | undefined => {
+export const useDocDescription = (
+  doc?: Document,
+): string | JSX.Element | undefined => {
   const store = useStore();
   if (!doc) {
     return undefined;