Commit 4f61fc73 authored by volkswagenchick's avatar volkswagenchick Committed by NickWilde

Issue #2921579 by volkswagenchick: Improvements to README

parent c236180b
......@@ -3,6 +3,7 @@ CONTENTS OF THIS FILE
* Introduction
* Requirements
* Recommended Modules
* Installation
* Configuration
* Maintainers
......@@ -11,8 +12,8 @@ CONTENTS OF THIS FILE
INTRODUCTION
------------
Colorbox Inline allows you to open content already on the page within a
colorbox. If you would like to load content via AJAX, you can use colorbox_load.
Colorbox Inline allows the user to open content already on the page within a
colorbox.
REQUIREMENTS
......@@ -22,36 +23,47 @@ Requires the following modules:
* Colorbox (https://drupal.org/project/colorbox)
To create an element which opens the colorbox on click:
Add a the attribute data-colorbox-inline to an element and make it's value a
selector for the content you wish to open.
Eg, <a data-colorbox-inline=".user-login">User Login</a>.
Optional extra configuration you can add:
RECOMMENDED MODULES
-------------------
- `data-width` and `data-height` to the anchor to control the size of the
modal window.
- `data-class` to add a class to the colorbox wrapper.
To load content via AJAX, use:
* colorbox_load - https://www.drupal.org/project/colorbox_load
INSTALLATION
------------
Install as you would normally install a contributed Drupal module. See:
https://drupal.org/documentation/install/modules-themes/modules-8 for further
information.
Install the Colorbox Inline module as you would normally install a contributed Drupal module.
Visit https://www.drupal.org/node/1897420 for further information.
CONFIGURATION
-------------
No special requirements
To create an element which opens the colorbox on select:
Add the attribute data-colorbox-inline to an element and make its value a
selector for the content you wish to open.
Eg, <a data-colorbox-inline=".user-login">User Login</a>.
Optional extra configuration you can add:
- `data-width` and `data-height` to the anchor to control the size of the
modal window.
- `data-class` to add a class to the colorbox wrapper.
MAINTAINERS
-----------
Current maintainers:
* Sam Becker (Sam152) - https://www.drupal.org/user/1485048
* Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031
* Nick Wilde (NickWilde) - https://www.drupal.org/u/nickwilde
Supporting maintenance and support provided by:
* PreviousNext - https://www.drupal.org/previousnext
* CI&T - https://www.drupal.org/cit
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment