Fixes #218: Allow rendering description from schema for all fields.

src/components/fields/SchemaField.js

@@ -12,6 +12,7 @@ import NumberField from "./NumberField";
 import ObjectField from "./ObjectField";
 import StringField from "./StringField";
 import UnsupportedField from "./UnsupportedField";
+import DescriptionField from "./DescriptionField";
 
 const REQUIRED_FIELD_SYMBOL = "*";
 const COMPONENT_TYPES = {
@@ -73,6 +74,7 @@ function Wrapper({
     classNames,
     errorSchema,
     label,
+    description,
     hidden,
     help,
     required,
@@ -95,6 +97,7 @@ function Wrapper({
   return (
     <div className={classList}>
       {displayLabel && label ? getLabel(label, required, id) : null}
+      {description ? <DescriptionField id={`${id}__description`} description={description} /> : null}
       {children}
       {isError ? <ErrorList errors={errors} /> : <div/>}
       {renderHelp(help)}
@@ -108,6 +111,7 @@ if (process.env.NODE_ENV !== "production") {
     id: PropTypes.string,
     classNames: PropTypes.string,
     label: PropTypes.string,
+    description: PropTypes.string,
     hidden: PropTypes.bool,
     help: PropTypes.oneOfType([
       PropTypes.string,
@@ -156,6 +160,7 @@ function SchemaField(props) {
   return (
     <Wrapper
       label={props.schema.title || schema.title || name}
+      description={props.schema.description || schema.description}
       errorSchema={errorSchema}
       hidden={uiSchema["ui:widget"] === "hidden"}
       help={uiSchema["ui:help"]}

test/SchemaField_test.js

@@ -137,4 +137,47 @@ describe("SchemaField", () => {
         .to.have.length.of(1);
     });
   });
+
+  describe("description support", () => {
+    const schema = {
+      type: "object",
+      properties: {
+        foo: {type: "string", description:"A Foo field"},
+        bar: {type: "string"}
+      }
+    };
+
+    it("should render description if available from the schema", () => {
+      const {node} = createFormComponent({schema});
+      expect(node.querySelectorAll("div#root_foo__description"))
+        .to.have.length.of(1);
+    });
+
+    it("should render description if available from a referenced schema", () => {
+      // Overriding.
+      const schemaWithReference = {
+        type: "object",
+        properties: {
+          foo: {$ref: "#/definitions/foo"},
+          bar: {type: "string"}
+        },
+        definitions: {
+          foo: {
+            type: "string",
+            description: "A Foo field"
+          }
+        }
+      };
+      const {node} = createFormComponent({schema: schemaWithReference});
+      const matches = node.querySelectorAll("div#root_foo__description");
+      expect(matches).to.have.length.of(1);
+      expect(matches[0].textContent).to.equal("A Foo field");
+    });
+
+    it("should not render description if not available from schema", () => {
+      const {node} = createFormComponent({schema});
+      expect(node.querySelectorAll("div#root_bar__description"))
+        .to.have.length.of(0);
+    });
+  });
 });