You are here

Home » API reference » Collapsiblock 3.x

README.txt in Collapsiblock 3.x

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
  6. 4.x README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Troubleshooting
 * Maintainers


INTRODUCTION
------------

The Collapsiblock module provides the functionality to make blocks collapsible.

This module is intended for site-builders who are new to Drupal with relatively
simple needs. We will try to accommodate feature requests and options but will
balance those with the need for a simple UI.

  * For a full description of the module visit:
    https://www.drupal.org/project/collapsiblock

  * To submit bug reports and feature suggestions, or to track changes visit:
    https://www.drupal.org/project/issues/collapsiblock


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


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

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


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

  1. Navigate to Administration > Extend and enable the module.
  2. Navigate to Administration > Structure > Block Layout and place a block.
  3. Now when placing blocks there is an additional fieldset on the
     configuration page. Choose the "Block collapse behavior". Save block.
  4. If you want to set global settings for collapsiblock, navigate to
     Administration > Configuration > User Interface > Collapsiblock.

The global settings allow you to:
  1. Choose a default action for all blocks.
  2. Choose whether to save the last state of blocks in a cookie for each user.
  3. Choose whether active links are kept open (useful for menu blocks).


TROUBLESHOOTING
---------------

If your blocks are not behaving as expected, ensure that the template
for your block(s) uses the {{ title_prefix }} and {{ title_suffix }}
elements to wrap the portion of the block that should be used as the
non-collapsing, clickable portion of the block. The JS script will try to
collapse anything outside that wrapper that is in the block except for
contextual links which have their own behaviours.

MAINTAINERS
-----------

  * Max Pogonowski (Darvanen) - https://www.drupal.org/u/darvanen
  * Sonvir Choudhary (sonvir249) - https://www.drupal.org/u/sonvir249

Supporting organization:

  * QED42 - https://www.drupal.org/qed42

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Troubleshooting

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. The Collapsiblock module provides the functionality to make blocks collapsible.

  16. 

  17. This module is intended for site-builders who are new to Drupal with relatively

  18. simple needs. We will try to accommodate feature requests and options but will

  19. balance those with the need for a simple UI.

  20. 

  21.   * For a full description of the module visit:

  22.     https://www.drupal.org/project/collapsiblock

  23. 

  24.   * To submit bug reports and feature suggestions, or to track changes visit:

  25.     https://www.drupal.org/project/issues/collapsiblock

  26. 

  27. 

  28. REQUIREMENTS

  29. ------------

  30. 

  31. This module requires no modules outside of Drupal core.

  32. 

  33. 

  34. INSTALLATION

  35. ------------

  36. 

  37.   * Install the Collapsiblock module as you would normally install a contributed

  38.     Drupal module. Visit https://www.drupal.org/node/1897420 for further

  39.     information.

  40. 

  41. 

  42. CONFIGURATION

  43. -------------

  44. 

  45.   1. Navigate to Administration > Extend and enable the module.

  46.   2. Navigate to Administration > Structure > Block Layout and place a block.

  47.   3. Now when placing blocks there is an additional fieldset on the

  48.      configuration page. Choose the "Block collapse behavior". Save block.

  49.   4. If you want to set global settings for collapsiblock, navigate to

  50.      Administration > Configuration > User Interface > Collapsiblock.

  51. 

  52. The global settings allow you to:

  53.   1. Choose a default action for all blocks.

  54.   2. Choose whether to save the last state of blocks in a cookie for each user.

  55.   3. Choose whether active links are kept open (useful for menu blocks).

  56. 

  57. 

  58. TROUBLESHOOTING

  59. ---------------

  60. 

  61. If your blocks are not behaving as expected, ensure that the template

  62. for your block(s) uses the {{ title_prefix }} and {{ title_suffix }}

  63. elements to wrap the portion of the block that should be used as the

  64. non-collapsing, clickable portion of the block. The JS script will try to

  65. collapse anything outside that wrapper that is in the block except for

  66. contextual links which have their own behaviours.

  67. 

  68. MAINTAINERS

  69. -----------

  70. 

  71.   * Max Pogonowski (Darvanen) - https://www.drupal.org/u/darvanen

  72.   * Sonvir Choudhary (sonvir249) - https://www.drupal.org/u/sonvir249

  73. 

  74. Supporting organization:

  75. 

  76.   * QED42 - https://www.drupal.org/qed42