diff --git a/core/modules/outside_in/js/outside_in.es6.js b/core/modules/outside_in/js/outside_in.es6.js index 66708cea0d..32a5556eca 100644 --- a/core/modules/outside_in/js/outside_in.es6.js +++ b/core/modules/outside_in/js/outside_in.es6.js @@ -9,6 +9,8 @@ const itemsToToggleSelector = '[data-off-canvas-main-canvas], #toolbar-bar, [data-drupal-outsidein="editable"] a, [data-drupal-outsidein="editable"] button'; const contextualItemsSelector = '[data-contextual-id] a, [data-contextual-id] button'; const quickEditItemSelector = '[data-quickedit-entity-id]'; + const excludedLinksSelector = '[data-outside-in-exclude] [data-outside-in-edit]'; + /** * Reacts to contextual links being added. @@ -21,6 +23,10 @@ * @listens event:drupalContextualLinkAdded */ $(document).on('drupalContextualLinkAdded', (event, data) => { + // Remove contextual links that should be excluded. + // @see outside_in_block_view_alter(). + $(excludedLinksSelector).remove(); + // Bind Ajax behaviors to all items showing the class. // @todo Fix contextual links to work with use-ajax links in // https://www.drupal.org/node/2764931. diff --git a/core/modules/outside_in/js/outside_in.js b/core/modules/outside_in/js/outside_in.js index 635196d88f..c7d73056f2 100644 --- a/core/modules/outside_in/js/outside_in.js +++ b/core/modules/outside_in/js/outside_in.js @@ -11,8 +11,11 @@ var itemsToToggleSelector = '[data-off-canvas-main-canvas], #toolbar-bar, [data-drupal-outsidein="editable"] a, [data-drupal-outsidein="editable"] button'; var contextualItemsSelector = '[data-contextual-id] a, [data-contextual-id] button'; var quickEditItemSelector = '[data-quickedit-entity-id]'; + var excludedLinksSelector = '[data-outside-in-exclude] [data-outside-in-edit]'; $(document).on('drupalContextualLinkAdded', function (event, data) { + $(excludedLinksSelector).remove(); + Drupal.attachBehaviors(data.$el[0]); data.$el.find(blockConfigureSelector).on('click.outsidein', function () { diff --git a/core/modules/outside_in/outside_in.module b/core/modules/outside_in/outside_in.module index 6673fa3718..6618e2727b 100644 --- a/core/modules/outside_in/outside_in.module +++ b/core/modules/outside_in/outside_in.module @@ -64,6 +64,14 @@ function outside_in_block_view_alter(array &$build) { $build['#contextual_links']['outside_in'] = [ 'route_parameters' => [], ]; + if (!_outside_in_is_block_editable($build['#plugin_id']) && isset($build['#contextual_links']['block'])) { + // If this block should not be editable set an attribute which will be used + // to remove the link on the client side. + // The individual links are not available here to remove. + // @see outside_in.js + $build['#attributes']['data-outside-in-exclude'] = TRUE; + } + } /** @@ -102,7 +110,9 @@ function outside_in_entity_type_build(array &$entity_types) { function outside_in_preprocess_block(&$variables) { // The main system block does not contain the block contextual links. $variables['#cache']['contexts'][] = 'outside_in_is_applied'; - if ($variables['plugin_id'] !== 'system_main_block' && \Drupal::service('outside_in.manager')->isApplicable()) { + /** @var \Drupal\outside_in\OutsideInManagerInterface $outside_in_manager */ + $outside_in_manager = \Drupal::service('outside_in.manager'); + if (_outside_in_is_block_editable($variables['plugin_id']) && $outside_in_manager->isApplicable()) { // Add class and attributes to all blocks to allow Javascript to target. $variables['attributes']['class'][] = 'outside-in-editable'; $variables['attributes']['data-drupal-outsidein'] = 'editable'; @@ -163,3 +173,20 @@ function outside_in_css_alter(&$css, AttachedAssetsInterface $assets) { $css[$path]['group'] = 200; } } + +/** + * Checks whether a block is editable by this module. + * + * @param string $plugin_id + * The plugin ID for the block to check. + * + * @return bool + * TRUE if the block should have the "Quick Edit" link provided by this + * module. + * + * @internal + */ +function _outside_in_is_block_editable($plugin_id) { + $non_editable_blocks = ['page_title_block', 'system_main_block']; + return !in_array($plugin_id, $non_editable_blocks, TRUE); +} diff --git a/core/modules/outside_in/tests/src/FunctionalJavascript/OutsideInBlockFormTest.php b/core/modules/outside_in/tests/src/FunctionalJavascript/OutsideInBlockFormTest.php index ba865c7a6f..087f6301ab 100644 --- a/core/modules/outside_in/tests/src/FunctionalJavascript/OutsideInBlockFormTest.php +++ b/core/modules/outside_in/tests/src/FunctionalJavascript/OutsideInBlockFormTest.php @@ -498,4 +498,33 @@ protected function isLabelInputVisible() { return $this->getSession()->getPage()->find('css', static::LABEL_INPUT_SELECTOR)->isVisible(); } + /** + * Tests that title block does not have a outside_in contextual link. + */ + public function testBlockExcluded() { + $web_assert = $this->assertSession(); + + $non_excluded_block = $this->placeBlock('system_powered_by_block'); + $excluded_block_plugin_ids = ['page_title_block', 'system_main_block']; + $block_selectors = []; + // Place blocks that should be excluded. + foreach ($excluded_block_plugin_ids as $excluded_block_plugin_id) { + // The block HTML 'id' attribute will be "block-[block_id]". + $block_selectors[] = $this->getBlockSelector($this->placeBlock($excluded_block_plugin_id)); + } + $this->drupalGet('user'); + // Assert that block has been marked as "editable" and contextual that + // should exist does. + $web_assert->elementExists('css', $this->getBlockSelector($non_excluded_block) . "[data-drupal-outsidein=\"editable\"]"); + // Check each block that should be excluded. + foreach ($block_selectors as $block_selector) { + // Assert block itself exists. + $web_assert->elementExists('css', $block_selector); + // Assert that exclude block has not been marked as "editable". + $web_assert->elementNotExists('css', "{$block_selector}[data-drupal-outsidein=\"editable\"]"); + // Assert that contextual that not should exist does not. + $web_assert->elementNotExists('css', "$block_selector [data-outside-in-edit]"); + } + } + }