Commit 38906d62 authored by Emil Johnsson's avatar Emil Johnsson Committed by Emil Johnsson
Browse files

Issue #3112521 by hmendes, ricksta, marcusvsouza, ankithashetty, Webbeh,...

Issue #3112521 by hmendes, ricksta, marcusvsouza, ankithashetty, Webbeh, Manthan.Chauhan, dandeleon03, volkswagenchick, johnzzon: Update README.md (apply Drupal best practices)
parent e32e8f3a
Loading
Loading
Loading
Loading
+57 −15
Original line number Diff line number Diff line
Layout Builder Modal
--------------------
CONTENTS OF THIS FILE
---------------------

### About this module
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Demo

Layout Builder provides you with the tools to create a modern authoring experience.

It was intially implemented as a site building tool for you to layout the page template of a content type but it can also be used as a authoring tool for specific content on unique nodes.
INTRODUCTION
------------

Drupal is known for its abilities to provide the author with a structured format for their content. This spirit carries over to the Layout Builder solution. To provide the user with a flexibel way to create content and position them within a layout you should leverage Layout Builder's ability to use blocks as content carriers.
Layout Builder provides you with the tools to create a modern authoring
experience.

Let’s say you want to provide the user with the ability to write text segments and position them in a different layouts within a specific page you should then create a custom block consisting of a text area and make it available in Layout Builder.
It was initially implemented as a site building tool for you to layout the page
template of a content type, but it can also be used as an authoring tool for
specific content on unique nodes.

The interface for the user to write content within this custom block would be through the off-canvas dialog which is the standard solution selected by the Layout Builder developers. The off-canvas dialog is very narrow and not an optimal user experience for this scenario, so to provide the author with a better interface this module let’s you use a modal dialog instead.
Drupal is known for its abilities to provide the author with a structured format
for their content. This spirit carries over to the Layout Builder solution.
To provide the user with a flexible way to create content and position them
within a layout you should leverage Layout Builder's ability to use blocks as
content carriers.

### Demo
Let's say you want to provide the user with the ability to write text segments
and position them in a different layouts within a specific page, you should then
create a custom block consisting of a text area and make it available in Layout
Builder.

[Watch a demo](https://www.youtube.com/watch?v=1cZuQAevJeY) of the Layout Builder Modal module.
The interface for the user to write content within this custom block would be
through the off-canvas dialog which is the standard solution selected by the
Layout Builder developers. The off-canvas dialog is very narrow and not an
optimal user experience for this scenario, so to provide the author with a
better interface this module lets you use a modal dialog instead.

### Installation

Install as you would normally install a contributed Drupal module.
REQUIREMENTS
------------

### Configuration
This module requires the following core dependencies:

1. Add the 'administer layout builder modal' permission to the roles who should be able to configure the module.
 * Drupal 8 >= 8.70
 * Drupal 8 core module Layout Builder

2. You can now configure the module at `admin/config/user-interface/layout-builder-modal`.
This module requires no additional modules.


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/node/1897420/ for further information.


CONFIGURATION
-------------

    1. Add the 'administer layout builder modal' permission to the roles who
       should be able to configure the module.
    2. You can now configure the module at:
       `admin/config/user-interface/layout-builder-modal`.


DEMO
----

[Watch a demo](https://www.youtube.com/watch?v=1cZuQAevJeY) of the Layout
Builder Modal module.