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

package/CHANGELOG.md

@@ -17,6 +17,12 @@ myst:
 
 <!-- towncrier release notes start -->
 
+## 18.0.0-alpha.12 (2024-02-21)
+
+### Feature
+
+- Add accordion to metadata form. @robgietema [#5760](https://github.com/plone/volto/issues/5760)
+
 ## 18.0.0-alpha.11 (2024-02-18)
 
 ### Breaking

package/package.json

@@ -9,7 +9,7 @@
     }
   ],
   "license": "MIT",
-  "version": "18.0.0-alpha.11",
+  "version": "18.0.0-alpha.12",
   "repository": {
     "type": "git",
     "url": "git@github.com:plone/volto.git"
@@ -312,9 +312,9 @@
     "webpack-node-externals": "3.0.0",
     "xmlrpc": "1.3.2",
     "yarnhook": "0.5.1",
-    "@plone/registry": "1.3.0",
-    "@plone/volto-slate": "18.0.0-alpha.6",
-    "@plone/scripts": "3.3.2"
+    "@plone/registry": "1.3.1",
+    "@plone/scripts": "3.3.2",
+    "@plone/volto-slate": "18.0.0-alpha.6"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",

package/src/actions/index.js

@@ -150,7 +150,12 @@ export {
 } from '@plone/volto/actions/workflow/workflow';
 export { getQuerystring } from '@plone/volto/actions/querystring/querystring';
 export { getQueryStringResults } from '@plone/volto/actions/querystringsearch/querystringsearch';
-export { setSidebarTab } from '@plone/volto/actions/sidebar/sidebar';
+export {
+  setMetadataFieldsets,
+  setMetadataFocus,
+  resetMetadataFocus,
+  setSidebarTab,
+} from '@plone/volto/actions/sidebar/sidebar';
 export { setFormData } from '@plone/volto/actions/form/form';
 export {
   deleteLinkTranslation,

package/src/actions/sidebar/sidebar.js

@@ -3,7 +3,51 @@
  * @module actions/sidebar/sidebar
  */
 
-import { SET_SIDEBAR_TAB } from '@plone/volto/constants/ActionTypes';
+import {
+  SET_METADATA_FIELDSETS,
+  SET_METADATA_FOCUS,
+  RESET_METADATA_FOCUS,
+  SET_SIDEBAR_TAB,
+} from '@plone/volto/constants/ActionTypes';
+
+/**
+ * Set metadata fieldsets function.
+ * @function setMetadataFieldsets
+ * @param {Array} fieldsets New fieldsets.
+ * @returns {Object} Set metadata fieldsets action.
+ */
+export function setMetadataFieldsets(fieldsets) {
+  return {
+    type: SET_METADATA_FIELDSETS,
+    fieldsets,
+  };
+}
+
+/**
+ * Set metadata focus function.
+ * @function setMetadataFocus
+ * @param {String} fieldset Fieldset of the field.
+ * @param {String} field Field to set focus too.
+ * @returns {Object} Set metadata focus action.
+ */
+export function setMetadataFocus(fieldset, field) {
+  return {
+    type: SET_METADATA_FOCUS,
+    fieldset,
+    field,
+  };
+}
+
+/**
+ * Resets metadata focus function.
+ * @function resetMetadataFocus
+ * @returns {Object} Set metadata focus action.
+ */
+export function resetMetadataFocus() {
+  return {
+    type: RESET_METADATA_FOCUS,
+  };
+}
 
 /**
  * Set sidebar tab function.

package/src/actions/sidebar/sidebar.test.js

@@ -1,7 +1,47 @@
-import { setSidebarTab } from './sidebar';
-import { SET_SIDEBAR_TAB } from '@plone/volto/constants/ActionTypes';
+import {
+  setMetadataFieldsets,
+  setMetadataFocus,
+  resetMetadataFocus,
+  setSidebarTab,
+} from './sidebar';
+import {
+  SET_METADATA_FIELDSETS,
+  SET_METADATA_FOCUS,
+  RESET_METADATA_FOCUS,
+  SET_SIDEBAR_TAB,
+} from '@plone/volto/constants/ActionTypes';
 
 describe('Sidebar action', () => {
+  describe('setMetadataFieldsets', () => {
+    it('should create an action to set the metadata fieldsets', () => {
+      const fieldsets = ['default'];
+      const action = setMetadataFieldsets(fieldsets);
+
+      expect(action.type).toEqual(SET_METADATA_FIELDSETS);
+      expect(action.fieldsets).toEqual(fieldsets);
+    });
+  });
+
+  describe('setMetadataFocus', () => {
+    it('should create an action to set the metadata focus', () => {
+      const fieldset = ['default'];
+      const field = ['title'];
+      const action = setMetadataFocus(fieldset, field);
+
+      expect(action.type).toEqual(SET_METADATA_FOCUS);
+      expect(action.fieldset).toEqual(fieldset);
+      expect(action.field).toEqual(field);
+    });
+  });
+
+  describe('resetMetadataFocus', () => {
+    it('should create an action to reset the metadata focus', () => {
+      const action = resetMetadataFocus();
+
+      expect(action.type).toEqual(RESET_METADATA_FOCUS);
+    });
+  });
+
   describe('setSidebarTab', () => {
     it('should create an action to set the sidebar', () => {
       const index = 1;

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

@@ -13,6 +13,8 @@ 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,
@@ -23,6 +25,7 @@ import {
   pickBy,
   without,
   cloneDeep,
+  xor,
 } from 'lodash';
 import isBoolean from 'lodash/isBoolean';
 import PropTypes from 'prop-types';
@@ -31,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,
@@ -41,7 +45,12 @@ import {
 import { v4 as uuid } from 'uuid';
 import { toast } from 'react-toastify';
 import { BlocksToolbar, UndoToolbar } from '@plone/volto/components';
-import { setSidebarTab, setFormData } from '@plone/volto/actions';
+import {
+  setMetadataFieldsets,
+  resetMetadataFocus,
+  setSidebarTab,
+  setFormData,
+} from '@plone/volto/actions';
 import { compose } from 'redux';
 import config from '@plone/volto/registry';
 
@@ -71,6 +80,8 @@ class Form extends Component {
     }),
     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,
@@ -141,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 = {
@@ -228,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);
   }
 
   /**
@@ -268,6 +286,32 @@ class Form extends Component {
         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();
+    }
   }
 
   /**
@@ -561,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
@@ -574,6 +630,7 @@ class Form extends Component {
       onSubmit,
       navRoot,
       type,
+      metadataFieldsets,
     } = this.props;
     const formData = this.state.formData;
     const schema = this.removeBlocksLayoutFields(originalSchema);
@@ -657,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={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>,
-                  ])}
+                      <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>
           )}
@@ -855,8 +932,15 @@ export default compose(
   connect(
     (state, props) => ({
       globalData: state.form?.global,
+      metadataFieldsets: state.sidebar?.metadataFieldsets,
+      metadataFieldFocus: state.sidebar?.metadataFieldFocus,
     }),
-    { setSidebarTab, setFormData },
+    {
+      setMetadataFieldsets,
+      setSidebarTab,
+      setFormData,
+      resetMetadataFocus,
+    },
     null,
     { forwardRef: true },
   ),

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';

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,

package/src/reducers/sidebar/sidebar.test.js

@@ -1,13 +1,60 @@
 import sidebar from './sidebar';
-import { SET_SIDEBAR_TAB } from '@plone/volto/constants/ActionTypes';
+import {
+  SET_METADATA_FIELDSETS,
+  SET_METADATA_FOCUS,
+  RESET_METADATA_FOCUS,
+  SET_SIDEBAR_TAB,
+} from '@plone/volto/constants/ActionTypes';
 
 describe('Sidebar reducer', () => {
   it('should return the initial state', () => {
     expect(sidebar()).toEqual({
+      metadataFieldFocus: '',
+      metadataFieldsets: [],
       tab: 0,
     });
   });
 
+  it('should handle SET_METADATA_FIELDSETS', () => {
+    expect(
+      sidebar(undefined, {
+        type: SET_METADATA_FIELDSETS,
+        fieldsets: ['default'],
+      }),
+    ).toEqual({
+      metadataFieldFocus: '',
+      metadataFieldsets: ['default'],
+      tab: 0,
+    });
+  });
+
+  it('should handle SET_METADATA_FOCUS', () => {
+    expect(
+      sidebar(undefined, {
+        type: SET_METADATA_FOCUS,
+        fieldset: 'default',
+        field: 'title',
+      }),
+    ).toEqual({
+      metadataFieldFocus: 'title',
+      metadataFieldsets: ['default'],
+      tab: 0,
+    });
+  });
+
+  it('should handle RESET_METADATA_FOCUS', () => {
+    expect(
+      sidebar(
+        { metadataFieldFocus: 'title' },
+        {
+          type: RESET_METADATA_FOCUS,
+        },
+      ),
+    ).toEqual({
+      metadataFieldFocus: '',
+    });
+  });
+
   it('should handle SET_SIDEBAR_TAB', () => {
     expect(
       sidebar(undefined, {
@@ -15,6 +62,8 @@ describe('Sidebar reducer', () => {
         index: 1,
       }),
     ).toEqual({
+      metadataFieldFocus: '',
+      metadataFieldsets: [],
       tab: 1,
     });
   });

package/types/actions/index.d.ts

@@ -10,7 +10,6 @@ export { listRoles } from "@plone/volto/actions/roles/roles";
 export { getTypes } from "@plone/volto/actions/types/types";
 export { getQuerystring } from "@plone/volto/actions/querystring/querystring";
 export { getQueryStringResults } from "@plone/volto/actions/querystringsearch/querystringsearch";
-export { setSidebarTab } from "@plone/volto/actions/sidebar/sidebar";
 export { setFormData } from "@plone/volto/actions/form/form";
 export { loadLazyLibrary } from "@plone/volto/actions/lazyLibraries/lazyLibraries";
 export { getContextNavigation } from "@plone/volto/actions/contextNavigation/contextNavigation";
@@ -38,6 +37,7 @@ export { createUser, deleteUser, getUser, listUsers, setInitialPassword, resetPa
 export { login, loginRenew, logout, resetLoginRequest } from "@plone/volto/actions/userSession/userSession";
 export { getVocabulary, getVocabularyTokenTitle } from "@plone/volto/actions/vocabularies/vocabularies";
 export { getWorkflow, transitionWorkflow } from "@plone/volto/actions/workflow/workflow";
+export { setMetadataFieldsets, setMetadataFocus, resetMetadataFocus, setSidebarTab } from "@plone/volto/actions/sidebar/sidebar";
 export { deleteLinkTranslation, getTranslationLocator, linkTranslation } from "@plone/volto/actions/translations/translations";
 export { setBlocksClipboard, resetBlocksClipboard } from "@plone/volto/actions/blocksClipboard/blocksClipboard";
 export { changeLanguage, changeLanguageCookies } from "./language/language";

package/types/actions/sidebar/sidebar.d.ts

@@ -1,3 +1,24 @@
+/**
+ * Set metadata fieldsets function.
+ * @function setMetadataFieldsets
+ * @param {Array} fieldsets New fieldsets.
+ * @returns {Object} Set metadata fieldsets action.
+ */
+export function setMetadataFieldsets(fieldsets: any[]): any;
+/**
+ * Set metadata focus function.
+ * @function setMetadataFocus
+ * @param {String} fieldset Fieldset of the field.
+ * @param {String} field Field to set focus too.
+ * @returns {Object} Set metadata focus action.
+ */
+export function setMetadataFocus(fieldset: string, field: string): any;
+/**
+ * Resets metadata focus function.
+ * @function resetMetadataFocus
+ * @returns {Object} Set metadata focus action.
+ */
+export function resetMetadataFocus(): any;
 /**
  * Set sidebar tab function.
  * @function setSidebarTab

package/types/constants/ActionTypes.d.ts

@@ -81,6 +81,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";