Skip to content
Snippets Groups Projects
README.md 1.57 KiB
Newer Older

Contents of this file
---------------------

 * About this module
 * Use cases
 * Demo
 * Installation
 * Notes
 * Known Issues/Limitations


About this Module
-----------------

Provides a field that allows a content entity to create and configure custom 
block instances.


Use Cases
---------

- Add blocks to a node's sidebar.
- Add blocks to paragraph.
- Create a carousel of content and configurable blocks.


Demo
----

> Evaluate this project online using [simplytest.me](https://simplytest.me/project/block_field).
 
 
Installation
------------

1. Copy/upload the `block_field.module` to the modules directory of your 
   Drupal installation.

2. Enable the 'Block field' module in 'Extend'. (/admin/modules)

3. Add the 'Block (plugin)' field to any content entity


Notes
-----

Nicolas Haase's avatar
Nicolas Haase committed
This module directly references the underlying block plugin ID of any content block 
from the 'Custom Block Library' with configuration for them. As a result, each block 
placement is stored only in the given field, as content of that content entity, 
rather than using Drupal's configuration management system.
Nicolas Haase's avatar
Nicolas Haase committed
No new blocks or instances are created anywhere else in the system and 
no exportable configuration is generated.
Known Issues/Limitations
------------------------

- Context aware plugins are not currently supported. This includes ctools 
  entity view blocks.
  See: \Drupal\block_field\BlockFieldManager::getBlockDefinitions


Jacob Rockowitz's avatar
Jacob Rockowitz committed
- Write additional test for block field plugin ids setting.
Author/Maintainer
-----------------

- [Jacob Rockowitz](http://drupal.org/user/371407)