Merge pull request #447 from open-rpc/feat/add-uischema-contentdesciptors-hidden

feat: add uiSchema to hide contentDescriptors

Author: shanejonas

src/Documentation.test.tsx

@@ -4,7 +4,7 @@ import Documentation from "./Documentation";
 
 it("renders without crashing", () => {
   const div = document.createElement("div");
-  ReactDOM.render(<Documentation schema={{} as any}/>, div);
+  ReactDOM.render(<Documentation schema={{} as any} />, div);
   ReactDOM.unmountComponentAtNode(div);
 });
 
@@ -13,3 +13,22 @@ it("renders without crashing with no schema", () => {
   ReactDOM.render(<Documentation />, div);
   ReactDOM.unmountComponentAtNode(div);
 });
+
+it("render contentDescriptors", () => {
+  const div = document.createElement("div");
+  ReactDOM.render(<Documentation
+    schema={{ components: { contentDescriptors: { Foo: { name: "foo", schema: true } } } } as any}
+  />, div);
+  expect(div.innerHTML.includes("ContentDescriptors")).toBe(true);
+  ReactDOM.unmountComponentAtNode(div);
+});
+
+it("doesnt render contentDescriptors if uiSchema contentDescriptors hidden is passed", () => {
+  const div = document.createElement("div");
+  ReactDOM.render(<Documentation
+    schema={{ components: { contentDescriptors: { Foo: { name: "foo", schema: true } } } } as any}
+    uiSchema={{ contentDescriptors: { "ui:hidden": true } }}
+  />, div);
+  expect(div.innerHTML.includes("ContentDescriptors")).toBe(false);
+  ReactDOM.unmountComponentAtNode(div);
+});

src/Documentation.tsx

@@ -21,6 +21,7 @@ export default class Documentation extends React.Component<IProps> {
     if (!schema) {
       return null;
     }
+    const shouldShowContentDescriptors = !(uiSchema && uiSchema.contentDescriptors && uiSchema.contentDescriptors["ui:hidden"] === true);
     return (
       <>
         <Info schema={schema} />
@@ -31,7 +32,9 @@ export default class Documentation extends React.Component<IProps> {
           reactJsonOptions={reactJsonOptions}
           methodPlugins={this.props.methodPlugins}
         />
-        <ContentDescriptors schema={schema} uiSchema={uiSchema}></ContentDescriptors>
+        {shouldShowContentDescriptors &&
+          <ContentDescriptors schema={schema} uiSchema={uiSchema}></ContentDescriptors>
+        }
       </>
     );
   }