New Plugin: Splash Screen

Initial patch.

Schema update.

Updated with behavior settings and with basic test coverage.

Some follow-ups created until we define the MVP here.

1. #2859541: Splash Screen: Configure the cookie postfix in use
2. #2859544: Splash Screen: Create demo content.
3. #2859545: Splash Screen: JS test.

Use modal behavior for dialog.

Rebased and test is updated a bit.

1. +++ b/config/install/field.field.paragraph.splash_screen.paragraph_splash_screen.yml
   index 0000000..fe56be2
   --- /dev/null
   
   --- /dev/null
   +++ b/config/install/field.storage.paragraph.paragraph_splash_screen.yml
   
   +++ b/config/install/field.storage.paragraph.paragraph_splash_screen.yml
   +++ b/config/install/field.storage.paragraph.paragraph_splash_screen.yml
   @@ -0,0 +1,22 @@
   

   Not sure if we need another field for this. Could we use container?

2. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +
   

   Additional new line.

3. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +          $build['#attributes']['class'][] = 'paragraphs-show-modal';
   

   Maybe we could have more splas-screen oriented class name? Ie paragraphs-splashscreen-enabled or something along those lines?

4. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +    $build['#attached']['drupalSettings'] = [
   +      'use_cookie' => $paragraph->getBehaviorSetting($this->getPluginId(), 'splash_screen_cookie'),
   +    ];
   

   Similarly to the other issue, we probably don't want to have this directly in drupalSettings.

5. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
   

   We need to implement validateConfigurationForm, otherwise we can enable the plugin without proper configuration: see other plugins.

6. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +    $field_definitions = $this->entityFieldManager->getFieldDefinitions('paragraph', $paragraphs_type->id());
   +    $fields = array_filter($field_definitions, function ($definition) {
   +      return $definition instanceof FieldConfigInterface;
   +    });
   +    $options = array_map(function ($definition) {
   +      return $definition->getLabel();
   +    }, $fields);
   

   I think we could use $this->getFieldNameOptions() here

7. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +        '#title' => $this->t('Splash screen field'),
   

   only 'Splash screen'

8. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +          ':link' => Url::fromRoute("entity.{$paragraphs_type->getEntityType()->getBundleOf()}.field_ui_fields", [$paragraphs_type->getEntityTypeId() => $paragraphs_type->id()])->toString(),
   

   Url::fromRoute('entity.paragraph.field_ui_fields', [
   $paragraphs_type->getEntityTypeId() => $paragraphs_type->id()
   ]);

9. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,186 @@
   +    $form['splash_screen'] = [
   

   Maybe splash_screen_disable?

10. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
    @@ -0,0 +1,186 @@
    +      '#title' => $this->t('Disable splash behaviour'),
    

    We went for the american english variant, so it's behavior.

11. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
    @@ -0,0 +1,186 @@
    +      '#description' => $this->t("If checked splash behaviour will be disabled and paragraph's content will be displayed as part of the page content."),
    

    and it's content will be displayed

12. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
    @@ -0,0 +1,186 @@
    +      '#description' => $this->t('Use cookie to save closed state of the splash screen.'),
    

    This could be a bit less technical.

13. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
    @@ -0,0 +1,186 @@
    +  /**
    +   * {@inheritdoc}
    +   */
    +  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    

    I would move this under the configuration form method

14. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
    @@ -0,0 +1,186 @@
    +      return [$this->t('Splash screen: @splash_screen', ['@splash_screen' => 'disabled'])];
    

    Doesn't this make the summary always appear as disabled?

15. +++ b/src/Tests/ParagraphsSplashScreenTest.php
    @@ -0,0 +1,68 @@
    +  public static $modules = [
    +    'paragraphs_collection',
    +    'link',
    

    Maybe I missed something, but to we need link here?

Fixed. For 15. i think link is needed, see https://www.drupal.org/node/2852384

Fixes and updates.

Updated to use separate cookie for each splash screen.

Rebased.

Just this one thing more, apart from that looks ok to me.

+++ b/js/splash-screen.js
@@ -0,0 +1,27 @@
+            $.cookie('paragraph_splash_' + setting.cookie_key, 1, {expires: 7});

7 days might be a bit low. I am ok if we hardcode this for now, but let's increase it to 30 days or something similar.

Increased from 7 to 30 days.

1. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,192 @@
   +      $form['paragraph_splash_screen'] = [
   

   Maybe we should rename this to something like "splash_screen_content"

2. +++ b/src/Plugin/paragraphs/Behavior/ParagraphsSplashScreenPlugin.php
   @@ -0,0 +1,192 @@
   +      '#default_value' => $paragraph->getBehaviorSetting($this->getPluginId(), 'splash_screen_cookie'),
   

   Yes, let's enable this by default

About the label: this actually disables the pop-up behavior. Do we want the setting to control if the content from the modal is also rendered on the page or not?

Let's also add Drupal.announce when opening the modal. See [#2014521]

This needs to be moved to the demo module as per #2864303: Move experimental types and plugins to demo

Moved to the demo module.

Hm, this doesn't seem to work any more for me.

About the "If checked splash screen will be disabled and it's content will be removed from the page content." option: having both disabled splash and content removed doesn't make much sense. IMHO a sensible option would be to offer the possibility to show content on the page even if we have splash screen, so effectively hiding it by default.

Another option which would make sense probably is to have an option where the splash screen is disabled which would result in content showing in the page. If this option would be check the above option should be disabled (this could be a follow up maybe).

@miro_dietiker reminded me that we will have tristate, so we can scratch the last paragraph from #35