@plone/volto 18.0.0-alpha.10 → 18.0.0-alpha.12

package/src/components/manage/Form/Form.jsx

@@ -13,15 +13,19 @@ import {
 } from '@plone/volto/helpers';
 import aheadSVG from '@plone/volto/icons/ahead.svg';
 import clearSVG from '@plone/volto/icons/clear.svg';
+import upSVG from '@plone/volto/icons/up-key.svg';
+import downSVG from '@plone/volto/icons/down-key.svg';
 import {
   findIndex,
   isEmpty,
+  isEqual,
   keys,
   map,
   mapValues,
   pickBy,
   without,
   cloneDeep,
+  xor,
 } from 'lodash';
 import isBoolean from 'lodash/isBoolean';
 import PropTypes from 'prop-types';
@@ -30,6 +34,7 @@ import { injectIntl } from 'react-intl';
 import { Portal } from 'react-portal';
 import { connect } from 'react-redux';
 import {
+  Accordion,
   Button,
   Container as SemanticContainer,
   Form as UiForm,
@@ -40,7 +45,12 @@ import {
 import { v4 as uuid } from 'uuid';
 import { toast } from 'react-toastify';
 import { BlocksToolbar, UndoToolbar } from '@plone/volto/components';
-import { setSidebarTab } from '@plone/volto/actions';
+import {
+  setMetadataFieldsets,
+  resetMetadataFocus,
+  setSidebarTab,
+  setFormData,
+} from '@plone/volto/actions';
 import { compose } from 'redux';
 import config from '@plone/volto/registry';
 
@@ -69,6 +79,9 @@ class Form extends Component {
       required: PropTypes.arrayOf(PropTypes.string),
     }),
     formData: PropTypes.objectOf(PropTypes.any),
+    globalData: PropTypes.objectOf(PropTypes.any),
+    metadataFieldsets: PropTypes.arrayOf(PropTypes.string),
+    metadataFieldFocus: PropTypes.string,
     pathname: PropTypes.string,
     onSubmit: PropTypes.func,
     onCancel: PropTypes.func,
@@ -93,6 +106,7 @@ class Form extends Component {
     requestError: PropTypes.string,
     allowedBlocks: PropTypes.arrayOf(PropTypes.string),
     showRestricted: PropTypes.bool,
+    global: PropTypes.bool,
   };
 
   /**
@@ -123,6 +137,7 @@ class Form extends Component {
     editable: true,
     requestError: null,
     allowedBlocks: null,
+    global: false,
   };
 
   /**
@@ -137,10 +152,16 @@ class Form extends Component {
       title: uuid(),
       text: uuid(),
     };
-    let { formData } = props;
+    let { formData, schema: originalSchema } = props;
     const blocksFieldname = getBlocksFieldname(formData);
     const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
 
+    const schema = this.removeBlocksLayoutFields(originalSchema);
+
+    this.props.setMetadataFieldsets(
+      schema?.fieldsets ? schema.fieldsets.map((fieldset) => fieldset.id) : [],
+    );
+
     if (!props.isEditForm) {
       // It's a normal (add form), get defaults from schema
       formData = {
@@ -201,6 +222,12 @@ class Form extends Component {
       }
     }
 
+    // Sync state to global state
+    if (this.props.global) {
+      this.props.setFormData(formData);
+    }
+
+    // Set initial state
     this.state = {
       formData,
       initialFormData,
@@ -218,6 +245,7 @@ class Form extends Component {
     this.onTabChange = this.onTabChange.bind(this);
     this.onBlurField = this.onBlurField.bind(this);
     this.onClickInput = this.onClickInput.bind(this);
+    this.onToggleMetadataFieldset = this.onToggleMetadataFieldset.bind(this);
   }
 
   /**
@@ -246,14 +274,44 @@ class Form extends Component {
     }
 
     if (this.props.onChangeFormData) {
-      if (
-        // TODO: use fast-deep-equal
-        JSON.stringify(prevState?.formData) !==
-        JSON.stringify(this.state.formData)
-      ) {
+      if (!isEqual(prevState?.formData, this.state.formData)) {
         this.props.onChangeFormData(this.state.formData);
       }
     }
+    if (
+      this.props.global &&
+      !isEqual(this.props.globalData, this.state.formData)
+    ) {
+      this.setState({
+        formData: this.props.globalData,
+      });
+    }
+
+    if (!isEqual(prevProps.schema, this.props.schema)) {
+      this.props.setMetadataFieldsets(
+        this.removeBlocksLayoutFields(this.props.schema).fieldsets.map(
+          (fieldset) => fieldset.id,
+        ),
+      );
+    }
+
+    if (
+      this.props.metadataFieldFocus !== '' &&
+      !isEqual(prevProps.metadataFieldFocus, this.props.metadataFieldFocus)
+    ) {
+      // Scroll into view
+      document
+        .querySelector(`.field-wrapper-${this.props.metadataFieldFocus}`)
+        .scrollIntoView();
+
+      // Set focus to first input if available
+      document
+        .querySelector(`.field-wrapper-${this.props.metadataFieldFocus} input`)
+        .focus();
+
+      // Reset focus field
+      this.props.resetMetadataFocus();
+    }
   }
 
   /**
@@ -327,15 +385,18 @@ class Form extends Component {
   onChangeField(id, value) {
     this.setState((prevState) => {
       const { errors, formData } = prevState;
+      const newFormData = {
+        ...formData,
+        // We need to catch also when the value equals false this fixes #888
+        [id]: value || (value !== undefined && isBoolean(value)) ? value : null,
+      };
       delete errors[id];
+      if (this.props.global) {
+        this.props.setFormData(newFormData);
+      }
       return {
         errors,
-        formData: {
-          ...formData,
-          // We need to catch also when the value equals false this fixes #888
-          [id]:
-            value || (value !== undefined && isBoolean(value)) ? value : null,
-        },
+        formData: newFormData,
         // Changing the form data re-renders the select widget which causes the
         // focus to get lost. To circumvent this, we set the focus back to
         // the input.
@@ -357,14 +418,13 @@ class Form extends Component {
   onSelectBlock(id, isMultipleSelection, event) {
     let multiSelected = [];
     let selected = id;
+    const formData = this.state.formData;
 
     if (isMultipleSelection) {
       selected = null;
-      const blocksLayoutFieldname = getBlocksLayoutFieldname(
-        this.state.formData,
-      );
+      const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
 
-      const blocks_layout = this.state.formData[blocksLayoutFieldname].items;
+      const blocks_layout = formData[blocksLayoutFieldname].items;
 
       if (event.shiftKey) {
         const anchor =
@@ -424,6 +484,9 @@ class Form extends Component {
       this.setState({
         formData: this.props.formData,
       });
+      if (this.props.global) {
+        this.props.setFormData(this.props.formData);
+      }
     }
     this.props.onCancel(event);
   }
@@ -435,6 +498,8 @@ class Form extends Component {
    * @returns {undefined}
    */
   onSubmit(event) {
+    const formData = this.state.formData;
+
     if (event) {
       event.preventDefault();
     }
@@ -442,7 +507,7 @@ class Form extends Component {
     const errors = this.props.schema
       ? FormValidation.validateFieldsPerFieldset({
           schema: this.props.schema,
-          formData: this.state.formData,
+          formData,
           formatMessage: this.props.intl.formatMessage,
         })
       : {};
@@ -477,12 +542,15 @@ class Form extends Component {
       if (this.props.isEditForm) {
         this.props.onSubmit(this.getOnlyFormModifiedValues());
       } else {
-        this.props.onSubmit(this.state.formData);
+        this.props.onSubmit(formData);
       }
       if (this.props.resetAfterSubmit) {
         this.setState({
           formData: this.props.formData,
         });
+        if (this.props.global) {
+          this.props.setFormData(this.props.formData);
+        }
       }
     }
   }
@@ -497,15 +565,15 @@ class Form extends Component {
    * @returns {undefined}
    */
   getOnlyFormModifiedValues = () => {
+    const formData = this.state.formData;
+
     const fieldsModified = Object.keys(
-      difference(this.state.formData, this.state.initialFormData),
+      difference(formData, this.state.initialFormData),
     );
     return {
-      ...pickBy(this.state.formData, (value, key) =>
-        fieldsModified.includes(key),
-      ),
-      ...(this.state.formData['@static_behaviors'] && {
-        '@static_behaviors': this.state.formData['@static_behaviors'],
+      ...pickBy(formData, (value, key) => fieldsModified.includes(key)),
+      ...(formData['@static_behaviors'] && {
+        '@static_behaviors': formData['@static_behaviors'],
       }),
     };
   };
@@ -537,6 +605,18 @@ class Form extends Component {
     return newSchema;
   };
 
+  /**
+   * Toggle metadata fieldset handler
+   * @method onToggleMetadataFieldset
+   * @param {Object} event Event object.
+   * @param {Object} blockProps Block properties.
+   * @returns {undefined}
+   */
+  onToggleMetadataFieldset(event, blockProps) {
+    const { index } = blockProps;
+    this.props.setMetadataFieldsets(xor(this.props.metadataFieldsets, [index]));
+  }
+
   /**
    * Render method.
    * @method render
@@ -550,8 +630,9 @@ class Form extends Component {
       onSubmit,
       navRoot,
       type,
+      metadataFieldsets,
     } = this.props;
-    const { formData } = this.state;
+    const formData = this.state.formData;
     const schema = this.removeBlocksLayoutFields(originalSchema);
     const Container =
       config.getComponent({ name: 'Container' }).component || SemanticContainer;
@@ -562,17 +643,21 @@ class Form extends Component {
       this.state.isClient && (
         <Container>
           <BlocksToolbar
-            formData={this.state.formData}
+            formData={formData}
             selectedBlock={this.state.selected}
             selectedBlocks={this.state.multiSelected}
-            onChangeBlocks={(newBlockData) =>
+            onChangeBlocks={(newBlockData) => {
+              const newFormData = {
+                ...formData,
+                ...newBlockData,
+              };
               this.setState({
-                formData: {
-                  ...formData,
-                  ...newBlockData,
-                },
-              })
-            }
+                formData: newFormData,
+              });
+              if (this.props.global) {
+                this.props.setFormData(newFormData);
+              }
+            }}
             onSetSelectedBlocks={(blockIds) =>
               this.setState({ multiSelected: blockIds })
             }
@@ -580,22 +665,31 @@ class Form extends Component {
           />
           <UndoToolbar
             state={{
-              formData: this.state.formData,
+              formData,
               selected: this.state.selected,
               multiSelected: this.state.multiSelected,
             }}
             enableHotKeys
-            onUndoRedo={({ state }) => this.setState(state)}
+            onUndoRedo={({ state }) => {
+              if (this.props.global) {
+                this.props.setFormData(state.formData);
+              }
+              return this.setState(state);
+            }}
           />
           <BlocksForm
-            onChangeFormData={(newFormData) =>
+            onChangeFormData={(newData) => {
+              const newFormData = {
+                ...formData,
+                ...newData,
+              };
               this.setState({
-                formData: {
-                  ...formData,
-                  ...newFormData,
-                },
-              })
-            }
+                formData: newFormData,
+              });
+              if (this.props.global) {
+                this.props.setFormData(newFormData);
+              }
+            }}
             onChangeField={this.onChangeField}
             onSelectBlock={this.onSelectBlock}
             properties={formData}
@@ -620,34 +714,54 @@ class Form extends Component {
                 error={keys(this.state.errors).length > 0}
               >
                 {schema &&
-                  map(schema.fieldsets, (item) => [
-                    <Segment
-                      secondary
-                      attached
-                      className={`fieldset-${item.id}`}
-                      key={item.title}
+                  map(schema.fieldsets, (fieldset) => (
+                    <Accordion
+                      fluid
+                      styled
+                      className="form"
+                      key={fieldset.title}
                     >
-                      {item.title}
-                    </Segment>,
-                    <Segment attached key={`fieldset-contents-${item.title}`}>
-                      {map(item.fields, (field, index) => (
-                        <Field
-                          {...schema.properties[field]}
-                          id={field}
-                          fieldSet={item.title.toLowerCase()}
-                          formData={this.state.formData}
-                          focus={this.state.inFocus[field]}
-                          value={this.state.formData?.[field]}
-                          required={schema.required.indexOf(field) !== -1}
-                          onChange={this.onChangeField}
-                          onBlur={this.onBlurField}
-                          onClick={this.onClickInput}
-                          key={field}
-                          error={this.state.errors[field]}
-                        />
-                      ))}
-                    </Segment>,
-                  ])}
+                      <div
+                        key={fieldset.id}
+                        id={`metadataform-fieldset-${fieldset.id}`}
+                      >
+                        <Accordion.Title
+                          active={metadataFieldsets.includes(fieldset.id)}
+                          index={fieldset.id}
+                          onClick={this.onToggleMetadataFieldset}
+                        >
+                          {fieldset.title}
+                          {metadataFieldsets.includes(fieldset.id) ? (
+                            <Icon name={upSVG} size="20px" />
+                          ) : (
+                            <Icon name={downSVG} size="20px" />
+                          )}
+                        </Accordion.Title>
+                        <Accordion.Content
+                          active={metadataFieldsets.includes(fieldset.id)}
+                        >
+                          <Segment className="attached">
+                            {map(fieldset.fields, (field, index) => (
+                              <Field
+                                {...schema.properties[field]}
+                                id={field}
+                                fieldSet={fieldset.title.toLowerCase()}
+                                formData={formData}
+                                focus={this.state.inFocus[field]}
+                                value={formData?.[field]}
+                                required={schema.required.indexOf(field) !== -1}
+                                onChange={this.onChangeField}
+                                onBlur={this.onBlurField}
+                                onClick={this.onClickInput}
+                                key={field}
+                                error={this.state.errors[field]}
+                              />
+                            ))}
+                          </Segment>
+                        </Accordion.Content>
+                      </div>
+                    </Accordion>
+                  ))}
               </UiForm>
             </Portal>
           )}
@@ -698,14 +812,17 @@ class Form extends Component {
                         ...map(item.fields, (field, index) => (
                           <Field
                             {...schema.properties[field]}
-                            isDisabled={!this.props.editable}
                             id={field}
-                            formData={this.state.formData}
+                            formData={formData}
                             fieldSet={item.title.toLowerCase()}
                             focus={this.state.inFocus[field]}
-                            value={this.state.formData?.[field]}
+                            value={formData?.[field]}
                             required={schema.required.indexOf(field) !== -1}
-                            onChange={this.onChangeField}
+                            onChange={
+                              this.props.editable
+                                ? this.onChangeField
+                                : () => {}
+                            }
                             onBlur={this.onBlurField}
                             onClick={this.onClickInput}
                             key={field}
@@ -751,7 +868,7 @@ class Form extends Component {
                     <Field
                       {...schema.properties[field]}
                       id={field}
-                      value={this.state.formData?.[field]}
+                      value={formData?.[field]}
                       required={schema.required.indexOf(field) !== -1}
                       onChange={this.onChangeField}
                       onBlur={this.onBlurField}
@@ -812,5 +929,19 @@ class Form extends Component {
 const FormIntl = injectIntl(Form, { forwardRef: true });
 
 export default compose(
-  connect(null, { setSidebarTab }, null, { forwardRef: true }),
+  connect(
+    (state, props) => ({
+      globalData: state.form?.global,
+      metadataFieldsets: state.sidebar?.metadataFieldsets,
+      metadataFieldFocus: state.sidebar?.metadataFieldFocus,
+    }),
+    {
+      setMetadataFieldsets,
+      setSidebarTab,
+      setFormData,
+      resetMetadataFocus,
+    },
+    null,
+    { forwardRef: true },
+  ),
 )(FormIntl);

package/src/components/manage/Multilingual/TranslationObject.jsx

@@ -124,7 +124,6 @@ const TranslationObject = ({
                     {map(item.fields, (field, index) => (
                       <Field
                         {...schema.properties[field]}
-                        isDisabled={true}
                         id={field}
                         formData={translationObject}
                         focus={false}

package/src/components/theme/App/App.jsx

@@ -242,6 +242,7 @@ export const fetchContent = async ({ store, location }) => {
         id,
         data,
         blocksConfig,
+        content,
       });
       if (!p?.length) {
         throw new Error(

package/src/components/theme/AppExtras/AppExtras.jsx

@@ -8,6 +8,8 @@ const AppExtras = (props) => {
   const { pathname } = props;
   const active = appExtras
     .map((reg) => {
+      const ignored = matchPath(pathname, reg.ignore);
+      if (ignored) return null;
       const match = matchPath(pathname, reg.match);
       return match ? { reg, match } : null;
     })

package/src/components/theme/AppExtras/AppExtras.test.jsx

@@ -46,6 +46,13 @@ beforeAll(() => {
         <div className="something">{JSON.stringify(props.match)}</div>
       )),
     },
+    {
+      match: '/frontpage',
+      ignore: '/frontpage/images',
+      component: jest.fn((props) => (
+        <div className="frontpage-content">{JSON.stringify(props.match)}</div>
+      )),
+    },
   ];
 });
 
@@ -85,4 +92,17 @@ describe('AppExtras', () => {
     const json = component.toJSON();
     expect(json).toMatchSnapshot();
   });
+  it('ignore property works', () => {
+    const componentView = renderer.create(
+      <AppExtras pathname="/frontpage"></AppExtras>,
+    );
+    const componentEdit = renderer.create(
+      <AppExtras pathname="/frontpage/images"></AppExtras>,
+    );
+
+    const jsonView = componentView.toJSON();
+    expect(jsonView).toMatchSnapshot();
+    const jsonEdit = componentEdit.toJSON();
+    expect(jsonEdit).toMatchSnapshot();
+  });
 });

package/src/constants/ActionTypes.js

@@ -82,6 +82,9 @@ export const REVERT_HISTORY = 'REVERT_HISTORY';
 export const REVERT_TRANSACTIONS = 'REVERT_TRANSACTIONS';
 export const SEARCH_CONTENT = 'SEARCH_CONTENT';
 export const SET_SIDEBAR_TAB = 'SET_SIDEBAR_TAB';
+export const SET_METADATA_FIELDSETS = 'SET_METADATA_FIELDSETS';
+export const SET_METADATA_FOCUS = 'SET_METADATA_FOCUS';
+export const RESET_METADATA_FOCUS = 'RESET_METADATA_FOCUS';
 export const TRANSITION_WORKFLOW = 'TRANSITION_WORKFLOW';
 export const UNINSTALL_ADDON = 'UNINSTALL_ADDON';
 export const UPDATE_CONTENT = 'UPDATE_CONTENT';
@@ -141,3 +144,4 @@ export const POST_UPGRADE = 'POST_UPGRADE';
 export const RESET_LOGIN_REQUEST = 'RESET_LOGIN_REQUEST';
 export const GET_SITE = 'GET_SITE';
 export const GET_NAVROOT = 'GET_NAVROOT';
+export const SET_FORM_DATA = 'SET_FORM_DATA';

package/src/reducers/form/form.js

@@ -4,7 +4,11 @@
  * @module reducers/form/form
  */
 
-const initialState = {};
+import { SET_FORM_DATA } from '@plone/volto/constants/ActionTypes';
+
+const initialState = {
+  global: {},
+};
 
 /**
  * Form reducer.
@@ -12,6 +16,14 @@ const initialState = {};
  * @param {Object} state Current state.
  * @returns {Object} New state.
  */
-export default function form(state = initialState) {
-  return state;
+export default function form(state = initialState, action = {}) {
+  switch (action.type) {
+    case SET_FORM_DATA:
+      return {
+        ...state,
+        global: action.data,
+      };
+    default:
+      return state;
+  }
 }

package/src/reducers/form/form.test.js

@@ -1,7 +1,19 @@
 import form from './form';
+import { SET_FORM_DATA } from '@plone/volto/constants/ActionTypes';
 
 describe('Form reducer', () => {
   it('should return the initial state', () => {
-    expect(form()).toEqual({});
+    expect(form()).toEqual({ global: {} });
+  });
+
+  it('should handle SET_FORM_DATA', () => {
+    expect(
+      form(undefined, {
+        type: SET_FORM_DATA,
+        data: { foo: 'bar' },
+      }),
+    ).toEqual({
+      global: { foo: 'bar' },
+    });
   });
 });

package/src/reducers/sidebar/sidebar.js

@@ -3,10 +3,19 @@
  * @module reducers/sidebar/sidebar
  */
 
-import { SET_SIDEBAR_TAB } from '@plone/volto/constants/ActionTypes';
+import { union } from 'lodash';
+
+import {
+  SET_METADATA_FIELDSETS,
+  SET_METADATA_FOCUS,
+  RESET_METADATA_FOCUS,
+  SET_SIDEBAR_TAB,
+} from '@plone/volto/constants/ActionTypes';
 
 const initialState = {
   tab: 0,
+  metadataFieldsets: [],
+  metadataFieldFocus: '',
 };
 
 /**
@@ -18,6 +27,22 @@ const initialState = {
  */
 export default function sidebar(state = initialState, action = {}) {
   switch (action.type) {
+    case SET_METADATA_FIELDSETS:
+      return {
+        ...state,
+        metadataFieldsets: action.fieldsets,
+      };
+    case SET_METADATA_FOCUS:
+      return {
+        ...state,
+        metadataFieldsets: union(state.metadataFieldsets, [action.fieldset]),
+        metadataFieldFocus: action.field,
+      };
+    case RESET_METADATA_FOCUS:
+      return {
+        ...state,
+        metadataFieldFocus: '',
+      };
     case SET_SIDEBAR_TAB:
       return {
         ...state,