BE: Add 'collapse' feature to magichead

dsasser commented 1 year ago

Description

Add a new field widget for Entity Reference Hierarchy which includes the 'collapse' functionality at all times (currently it is only present once the node is saved). This should be contributed back to the Entity Reference Hierarchy Drupal module, which we are leveraging for magichead.

User story

AS A PW engineer I WANT to get modules prepped for adding a collapse button to the Edit view SO THAT Editors can have a better Edit mode experience.

Engineering notes / background

In #14534 we identified a path to get the 'collapse' functionality for magichead by leveraging an existing Paragraphs field widget. See engineering notes from the spike.

Analytics considerations

Quality / testing notes

Acceptance criteria

NOTE: do not merge this ticket alone – it will degrade the Editor experience until the follow-on ticket is done. (feature branch)

[ ] A new field widget is created, leveraging the existing Paragraphs (stable) code.
[ ] The field widget is contributed back to the Entity Reference Hierarchy module.
[ ] New field widget offers 'collapse' without saving the node.
[ ] Assess the possibility of adding a 'collapse/expand all' button, which is natively available in the Paragraphs (stable) widget.
[ ] Magichead is configured to use the new field widget.
[ ] Unblock this ticket

jilladams commented 1 year ago

This ticket has been deprioritized in Sprint 94, in order to focus on National Events Calendar breadcrumbs / IA.

Signed off from DaveC in slack DM: https://dsva.slack.com/archives/C03ES2LMNTH/p1696463452632779

jilladams commented 1 year ago

Risk note from planning:

We rely on 2 modules here: Paragraphs and Entity Reference Hierarchy module.
The relationship between them makes this Magichead implementation a little fragile: if one module or the other makes a breaking change, we need the 2nd module to respond, or we will need to contribute fixes
If we wanted to make Magichead less fragile: we could potentially get FE folks involved and make a React component that does this properly in the CMS front-end

CAIA has created 3 Benefits taxonomy terms so far, all with flat heirarchy / not exercising Magichead.

Laura's feedback: this was built to solve an a11y need. Based on convo in planning, we might be better of waiting on more CAIA feedback before we spend more time on smaller fixes.

dsasser commented 1 year ago

End of Sprint update for Sprint 97, 11/21/23

Did not get to this as planned, due to the D10 testing and Event Email CTA work taking a while longer than expected, and assisting with https://github.com/department-of-veterans-affairs/va.gov-cms/issues/15632 to troubleshoot the image derivatives.

department-of-veterans-affairs / va.gov-cms