Release 1.x.x acceptance criteria

[mfendeksilverstripe]

Release 1.x.x acceptance criteria

We are aiming to get this module to a stable 1.x.x release state. This issue covers the acceptance criteria for that.

This module is valuable as it provides expanded options for Elemental inline editor, specifically a much needed GridField replacement. Note that this does not provide all capabilities that GridField used to have but it does cover quite a significant chunk of it.

What we're currently looking it as item management of models nested under content blocks but in the future the capability of this module can be enhanced further.

Notable features:

• has_many relation support for item management (created, read, update, delete)
• sorting

Ideally, we can put together a roadmap for this module with the aim to have a stable release by September 1st 2024.

Must have AC

These requirements are mandatory.

• Modal UI > Store relation data #31 (this is MVP)
• Allow validation #11 (this is MVP)
• Better status UI #16
• More versatile FileModal #12
• Modal UI > Labels #30
• Allow ManyAnyField to be sorted #10
• Complete PHPUnit test coverage #9

Nice to have AC

These requirements are optional for the initial release but should be delivered in future minor versions.

• Image and text preview #34
• Throw hard exception when invalid fields are provided #24
• Document how to create a custom Modal #17
• Don't show a drop down when there's only one option #23
• Implement CanView restriction #19
• Read only view #18
• Hardened security model #14
• Complete Jest test coverage #8
• Modal UI > Tabulated CMS fields #29
• Make the AnyField rendering customisable #15
• Complete Behat test coverage #7

Notes

• [done] before starting implementation check if we should rebuild this on top of LinkField v4 as the current implementation is built on top of LinkField v3
• the decision was made to keep the current implementation based on LinkField v3 as we want to get stable release out without overcommitting on the effort - once this module becomes officially supported we can create a new major version based on LinkField v4

[mfendeksilverstripe]

FYI: @maxime-rainville

[maxime-rainville]

In my mind the following "must have" are more in the "nice to have" category:

• Document how to create a custom Modal #17
• Make the AnyField rendering customisable #15

Some of the cards that were still open, were actually completed already, so I close those.

[mfendeksilverstripe]

Next steps: we need to make sure this module works with LinkField 4 and ideally make the validation work the same way as LinkField.