#7558: Improve document/form builder responsiveness (#7976)

pixiebrix · Mar 23, 2024 · bc985fb · bc985fb
1 parent dfe97b3
commit bc985fb
Show file tree

Hide file tree

Showing 22 changed files with 345 additions and 857 deletions.
diff --git a/src/__snapshots__/Storyshots.test.js.snap b/src/__snapshots__/Storyshots.test.js.snap
diff --git a/src/components/documentBuilder/edit/DocumentOptions.module.scss b/src/components/documentBuilder/edit/DocumentOptions.module.scss
diff --git a/src/components/documentBuilder/edit/DocumentOptions.test.tsx b/src/components/documentBuilder/edit/DocumentOptions.test.tsx
@@ -145,7 +145,7 @@ describe("DocumentOptions", () => {
     });
   });
 
-  describe("remove element", () => {
+  describe("remove current element", () => {
     test("removes integration dependency", async () => {
       // Integration dependencies included in the form state
       const integrationDependencies: IntegrationDependency[] = [
@@ -189,7 +189,7 @@ describe("DocumentOptions", () => {
 
       const { getFormState } = renderDocumentOptions(formState, "0");
 
-      await userEvent.click(screen.getByText("Remove element"));
+      await userEvent.click(screen.getByText("Remove current element"));
 
       expect(getFormState().integrationDependencies).toStrictEqual([]);
     });

diff --git a/src/components/documentBuilder/edit/DocumentOptions.tsx b/src/components/documentBuilder/edit/DocumentOptions.tsx
@@ -24,12 +24,11 @@ import useAsyncEffect from "use-async-effect";
 import { useSelector } from "react-redux";
 import { selectNodePreviewActiveElement } from "@/pageEditor/slices/editorSelectors";
 import ElementEditor from "@/components/documentBuilder/edit/ElementEditor";
-import { Col, Row } from "react-bootstrap";
-import styles from "@/components/documentBuilder/edit/DocumentOptions.module.scss";
 import ConnectedCollapsibleFieldSection from "@/pageEditor/fields/ConnectedCollapsibleFieldSection";
 import SchemaField from "@/components/fields/schemaFields/SchemaField";
 import { DOCUMENT_SCHEMA } from "@/bricks/renderers/document";
 import { type Schema } from "@/types/schemaTypes";
+import { UncollapsibleFieldSection } from "@/pageEditor/fields/CollapsibleFieldSection";
 
 const DocumentOptions: React.FC<{
   name: string;
@@ -55,18 +54,14 @@ const DocumentOptions: React.FC<{
       {activeElement ? (
         <ElementEditor documentBodyName={documentBodyName} />
       ) : (
-        <Row className={styles.currentFieldRow}>
-          <Col xl="3" className={styles.currentField}>
-            <h6>Nothing selected</h6>
-          </Col>
-          <Col xl>
-            <small className="text-muted">
-              Use the Preview Tab on the right to select an element to edit ⟶
-            </small>
-          </Col>
-        </Row>
+        <UncollapsibleFieldSection title="Document Elements">
+          <p className="small text-muted">
+            Nothing selected. Use the Preview Tab on the right to select an
+            element to edit ⟶
+          </p>
+        </UncollapsibleFieldSection>
       )}
-      <ConnectedCollapsibleFieldSection title={"Advanced: Theme"}>
+      <ConnectedCollapsibleFieldSection title="Advanced: Theme">
         <SchemaField
           name={joinName(documentConfigName, "stylesheets")}
           schema={DOCUMENT_SCHEMA.properties.stylesheets as Schema}

diff --git a/src/components/documentBuilder/edit/ElementEditor.tsx b/src/components/documentBuilder/edit/ElementEditor.tsx
@@ -15,12 +15,9 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import styles from "./DocumentOptions.module.scss";
-
 import { useField } from "formik";
 import React from "react";
 import { type DocumentElement } from "@/components/documentBuilder/documentBuilderTypes";
-import { Col, Row } from "react-bootstrap";
 import RemoveElement from "./RemoveElement";
 import MoveElement from "./MoveElement";
 import elementTypeLabels from "@/components/documentBuilder/elementTypeLabels";
@@ -42,29 +39,27 @@ const ElementEditor: React.FC<ElementEditorProps> = ({ documentBodyName }) => {
   const [{ value: documentElement }] = useField<DocumentElement>(elementName);
   const ElementOptions = useElementOptions(documentElement, elementName);
 
+  const currentElementName: string =
+    getProperty(elementTypeLabels, documentElement.type) ?? "Unknown";
+
   return (
     <>
-      <Row className={styles.currentFieldRow}>
-        <Col xl="3" className={styles.currentField}>
-          <h6>
-            {getProperty(elementTypeLabels, documentElement.type) ??
-              "Unknown element"}
-          </h6>
-        </Col>
-        <Col xl>
+      <ConnectedCollapsibleFieldSection
+        title="Document Elements"
+        initialExpanded
+      >
+        <p className="small text-muted">
+          Use the Preview Tab on the right to select an element to edit ⟶
+        </p>
+        <p>
           <RemoveElement documentBodyName={documentBodyName} />
-        </Col>
-        <Col xl>
-          <small className="text-muted">
-            Use the Preview Tab on the right to select an element to edit ⟶
-          </small>
-        </Col>
-      </Row>
+        </p>
+
+        <h6>Current element: {currentElementName}</h6>
 
-      <div>
         <ElementOptions />
-      </div>
-      <MoveElement documentBodyName={documentBodyName} />
+        <MoveElement documentBodyName={documentBodyName} />
+      </ConnectedCollapsibleFieldSection>
       <ConnectedCollapsibleFieldSection title="Advanced: Layout">
         <CssSpacingField
           name={joinName(elementName, "config", "className")}

diff --git a/src/components/documentBuilder/edit/RemoveElement.tsx b/src/components/documentBuilder/edit/RemoveElement.tsx
@@ -36,7 +36,7 @@ const RemoveElement: React.FC<RemoveElementProps> = ({ documentBodyName }) => {
 
   return (
     <Button onClick={onDelete} variant="danger" size="sm">
-      <FontAwesomeIcon icon={faTrash} /> Remove element
+      <FontAwesomeIcon icon={faTrash} /> Remove current element
     </Button>
   );
 };

diff --git a/src/components/formBuilder/FormBuilder.tsx b/src/components/formBuilder/FormBuilder.tsx
@@ -18,7 +18,8 @@
 import styles from "./FormBuilder.module.scss";
 
 import React, { useState } from "react";
-import FormEditor from "./edit/FormEditor";
+import FormEditor from "@/components/formBuilder/edit/FormEditor";
+import FormIntroFields from "@/components/formBuilder/edit/FormIntroFields";
 import FormPreview from "./preview/FormPreview";
 import { useField } from "formik";
 import { type RJSFSchema } from "@/components/formBuilder/formBuilderTypes";
@@ -34,6 +35,7 @@ const FormBuilder: React.FC<{
   return (
     <div className={styles.root}>
       <div className={styles.column} data-testid="editor">
+        <FormIntroFields name={name} />
         <FormEditor
           name={name}
           activeField={activeField}

diff --git a/src/components/formBuilder/edit/ActiveField.tsx b/src/components/formBuilder/edit/ActiveField.tsx
@@ -0,0 +1,86 @@
+import React from "react";
+import {
+  type SelectStringOption,
+  type SetActiveField,
+} from "@/components/formBuilder/formBuilderTypes";
+import FieldEditor from "./FieldEditor";
+import {
+  moveStringInArray,
+  getNormalizedUiOrder,
+} from "@/components/formBuilder/formBuilderHelpers";
+import { type Schema } from "@/types/schemaTypes";
+import FieldTemplate from "@/components/form/FieldTemplate";
+import LayoutWidget from "@/components/LayoutWidget";
+import { findLast } from "lodash";
+
+export const ActiveField: React.FC<{
+  name: string;
+  activeField: string;
+  setActiveField: SetActiveField;
+  fieldTypes: SelectStringOption[];
+  schema: Schema;
+  uiOrder: string[];
+  propertyKeys: string[];
+  setUiOrder: (uiOrder: string[]) => Promise<void | string[]>;
+}> = ({
+  name,
+  activeField,
+  setActiveField,
+  fieldTypes,
+  schema,
+  uiOrder,
+  propertyKeys,
+  setUiOrder,
+}) => {
+  const moveProperty = async (direction: "up" | "down") => {
+    const nextUiOrder = moveStringInArray(
+      getNormalizedUiOrder(propertyKeys, uiOrder),
+      activeField,
+      direction,
+    );
+    await setUiOrder(nextUiOrder);
+  };
+
+  // The uiOrder field may not be initialized yet
+  const order = uiOrder ?? ["*"];
+  const canMoveUp =
+    order.length > 2
+      ? order[0] !== activeField
+      : propertyKeys[0] !== activeField;
+  const canMoveDown =
+    order.length === propertyKeys.length + 1
+      ? order.at(-2) !== activeField
+      : Array.isArray(order) &&
+        findLast(propertyKeys, (key) => !order.includes(key)) !== activeField;
+
+  return (
+    <>
+      <h6>Current Field</h6>
+
+      {Boolean(schema?.properties?.[activeField]) && (
+        <FieldEditor
+          name={name}
+          propertyName={activeField}
+          setActiveField={setActiveField}
+          fieldTypes={fieldTypes}
+        />
+      )}
+
+      {(canMoveUp || canMoveDown) && (
+        <FieldTemplate
+          name="layoutButtons"
+          label="Field Order"
+          as={LayoutWidget}
+          canMoveUp={canMoveUp}
+          moveUp={async () => {
+            await moveProperty("up");
+          }}
+          canMoveDown={canMoveDown}
+          moveDown={async () => {
+            await moveProperty("down");
+          }}
+        />
+      )}
+    </>
+  );
+};