Ajax Block
This module allows you to configure blocks to load using Ajax. Instead of rendering the block directly, a placeholder is shown, and the block's content is loaded and displayed via Ajax. This can be useful for bypassing caching mechanisms, though it may not be necessary if you are using Drupal's BigPipe module.
Provides the ability to load blocks via Ajax method. One can easily configure new and existing blocks to load via Ajax.
Essentially a placeholder will be dropped in place instead of fully rendering the block. The block content will be pulled from a custom route and then rendered in place via Ajax.
Rendering or display blocks via Ajax is sometimes necessary to get around various levels of caching on a site.
On the other hand, please note that in many cases you won't need this, if you use BigPipe Core Module.
Requirements
No special requirements. Essentially requires Drupal Core blocks.
Install
Install like any other contributed module. Installing through composer is recommended:
Composer
composer require drupal/block_ajax
drush en block_ajax
Usage
- Visit Structure -> Block layout page.
- Edit or create new block.
- New section should appear on block called "Ajax Block".
- Check "Load block via Ajax".
- Configure any other necessary block settings. Save block.
- Place block in region.
- Test page where block was placed, and it should load via Ajax.
Notes
8.x-2.0 and up is completely redesigned and it quite different then previous versions. Latest branch/releases provide interface to load blocks via Ajax and other configurable options.
Previous branches (8.x-1.0 & below), provide a new blockbase class to extend from when building out new/custom blocks. Which in turn, provides Ajax functionality on that block.
Older branches will not be supported anymore, but can be used for the time being.