Display paragraphs as open when item count is low

Works beautifully.
Made a quick spelling change though :)

Great - thanks a lot ...

Thanks guys, this is great. Pushed!

Oh, new features. Needs a port. :-)

Ported the drupal 7 functionality to drupal 8. Needs review.

1. +++ b/config/schema/paragraphs_type.schema.yml
   @@ -66,6 +66,8 @@ field.widget.settings.entity_reference_paragraphs:
   +    default_edit_mode_override:
   
   @@ -82,3 +84,5 @@ field.widget.settings.paragraphs:
   +    default_edit_mode_override:
   
   +++ b/src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php
   @@ -38,6 +38,11 @@ use Symfony\Component\Validator\ConstraintViolationInterface;
   +  const PARAGRAPHS_DEFAULT_EDIT_MODE_OVERRIDE = 1;
   

   This name does not really reflect what it does? It store a int, but it reads as if it should store a bool.

2. +++ b/src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php
   @@ -126,6 +132,26 @@ class InlineParagraphsWidget extends WidgetBase {
   +      '#attributes' => array(
   +        'field-name' => 'edit_mode',
   +      )
   

   This is a bit weird. I understand why it's done, but at least use a data attribute or class or something valid.

The test need to be updated to reflect the latest changes.

Besides that, I think we can improve this. We should at least not change the default behaviour and add a checkbox to opt-in on this feature. Maybe it's best to create a new issue for this?

This is just a proposal.
I've been working on Paragraphs the last months and the maintainers plan was to avoid cluttering the UI with too many options and so on, so why if instead of setting a max/min number of paragraphs we just add a checkbox to enable this feature with a fixed amount of paragraphs in a node?

For example, the patch attached to this comment would just check if there are more than 4 paragraphs to change the edit mode to "open". We would anyway need to add the checkbox in settings. As said, this is just a proposal, just want to avoid cluttering the UI. :)

Maybe changing the default to empty or zero would already do the trick in regards to the default behaviour?

I still think it's strange that a field to override something has a default value. Overriding something should be optional, not default behaviour IMHO.

And we should add _limit to the various names since we are actually storing limits.

1. Added '_limit' to the variables.
2. Changed the default limit to 0.
3. Added tests.

I have re-rolled this for latest 8.x-1.x version.

And it works nice.

We have a new partially related functionality: #2901994: Add edit mode option to expand only paragraph types with paragraph field

So what we want is that this threshold applies to all closed modes as the implementation seems to do.

Here's a quick review:

1. +++ b/src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php
   @@ -128,8 +134,28 @@ class InlineParagraphsWidget extends WidgetBase {
   +      '#description' => $this->t('Number of items considered to live paragraphs open e.g if host has 1 paragraph item. Live that paragraph open.'),
   

   live = leave?

2. +++ b/src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php
   @@ -215,6 +241,7 @@ class InlineParagraphsWidget extends WidgetBase {
   +    $summary[] = $this->t('Number of items to display as "Open" : @mode_limit', ['@mode_limit' => $this->getSetting('default_edit_mode_override_limit')]);
   

   A very long text for a summary.

3. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -49,6 +49,11 @@ class ParagraphsWidget extends WidgetBase {
   +  const PARAGRAPHS_DEFAULT_EDIT_MODE_OVERRIDE_LIMIT = 0;
   

   I don't think we need a const for undefined / default.

4. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -179,6 +188,23 @@ class ParagraphsWidget extends WidgetBase {
   +      '#title' => $this->t('Edit mode override limit'),
   

   Maybe "closed mode threshold" would be easier to understand. But it would change the logic.

5. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -179,6 +188,23 @@ class ParagraphsWidget extends WidgetBase {
   +      '#max' => 99,
   

   I don't think that 99 is a real technical limit or specifically makes sense. Can we not just skip the limit?

Looking forward to get this in soon as this seems to improve the UX in many cases. :-)

Changed the previous patch, so that it works with the newest state of the branch, including the previously introduced related setting "Closed, show nested".

1. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -186,6 +187,19 @@ class ParagraphsWidget extends WidgetBase {
   +      '#title' => $this->t('Closed mode threshold'),
   +      '#default_value' => $this->getSetting('closed_mode_threshold'),
   +      '#description' => $this->t('Number of items considered to leave paragraphs open e.g the threshold is 3, if a paragraph has 3 items or less, leave it open.'),
   +      '#min' => 0,
   

   By changing the concept to a threshold, the exact value should then already switch to closed.

   Maybe it's just the description that's outdated.

2. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -311,6 +325,9 @@ class ParagraphsWidget extends WidgetBase {
   +    if ($this->getSetting('edit_mode') == 'closed' || $this->getSetting('edit_mode') == 'closed_expand_nested') {
   +      $summary[] = $this->t('Closed mode threshold: @mode_limit', ['@mode_limit' => $this->getSetting('closed_mode_threshold')]);
   +    }
   

   I guess we should only show this if it's non-zero?

3. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -352,6 +369,7 @@ class ParagraphsWidget extends WidgetBase {
        $closed_mode_setting = isset($widget_state['closed_mode']) ? $widget_state['closed_mode'] : $this->getSetting('closed_mode');
        $autocollapse_setting = isset($widget_state['autocollapse']) ? $widget_state['autocollapse'] : $this->getSetting('autocollapse');
   +    $closed_mode_threshold_setting = isset($widget_state['closed_mode_threshold']) ? $widget_state['closed_mode_threshold'] : $this->getSetting('closed_mode_threshold');
    
   

   We need some settings in $widget_state as we also need them on submit callbacks, but I don't think that's true for the threshold setiting, so this can probably just directly use the setting?

4. +++ b/src/Plugin/Field/FieldWidget/ParagraphsWidget.php
   @@ -369,15 +387,28 @@ class ParagraphsWidget extends WidgetBase {
   +          // Force the paragraph to be open, if it contains less than or equal
   +          // items as the threshold.
   +          if ($widget_state['items_count'] <= $closed_mode_threshold_setting) {
   

   ok, not just the description, this should be < then IMHO.

   Also, this now has to duplicate the condition in two places.

   I think we can actually make that part of the first if condition, basicaly:

   
   if (open || items_count_check) {
   ...
   }
   elseif (closed)
   
   

   Then it should be a pretty minimal change, you could even skip the $closed_mode_threshold_setting variable as we only need it once.

5. +++ b/tests/src/Functional/ParagraphsExperimentalWidgetButtonsTest.php
   @@ -349,6 +349,149 @@ class ParagraphsExperimentalWidgetButtonsTest extends BrowserTestBase {
   +    // Check that the paragraphs field uses the experimental widget on the
   +    // container_paragraph paragraph type.
   +    $this->drupalGet('admin/structure/paragraphs_type/container_paragraph/form-display');
   +    $option = $this->assertSession()->optionExists('fields[field_paragraphs][type]', 'paragraphs');
   +    $this->assertTrue($option->isSelected());
   +
   +    // Check if the edit mode is set to "Closed".
   +    $this->assertSession()->pageTextContains('Edit mode: Closed');
   

   this doesn't seem really necessary, the widget check is basically just testing our test helper method and the edit mode summary is already tested elsewhere.

6. +++ b/tests/src/Functional/ParagraphsExperimentalWidgetButtonsTest.php
   @@ -349,6 +349,149 @@ class ParagraphsExperimentalWidgetButtonsTest extends BrowserTestBase {
   +    $this->drupalGet('admin/structure/types/manage/paragraphed_test/form-display');
   +    $option = $this->assertSession()->optionExists('fields[field_paragraphs][type]', 'paragraphs');
   +    $this->assertTrue($option->isSelected());
   +
   +    // Check if the edit mode is set to "Closed" and the threshold to 0.
   +    $this->assertSession()->pageTextContains('Edit mode: Closed');
   +    $this->assertSession()->pageTextContains('Closed mode threshold: 0');
   

   this would then go away, so we'd need a negative check and can limit it to the minimum, checking the summary on that page.

PS: I guess the previous patch changed so much that an interdiff was not useful, but don't forget to post one for these changes.

Changed everything you mentioned.

Tested this locally, works like a charm.

I was quickly confused about the setting when i have set it to 6 and edited a node with 10 Paragraphs and was confused the items were closed... But it seems the label / description made sense and i'm just used too much to the old behavior.

Looks good, lets get this in.

Awesome, so many contributors here! Thx everyone involved. This is in now!