Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heimrichhannot/contao-modal
A solid contao modal layer framework.
https://github.com/heimrichhannot/contao-modal
Last synced: about 1 month ago
JSON representation
A solid contao modal layer framework.
- Host: GitHub
- URL: https://github.com/heimrichhannot/contao-modal
- Owner: heimrichhannot
- Created: 2016-05-18T08:18:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-02-14T16:14:39.000Z (almost 3 years ago)
- Last Synced: 2024-09-18T18:12:46.882Z (3 months ago)
- Language: PHP
- Size: 126 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Modal - A solid contao modal window framework
Modal provides modal elements within modal archives. It works best together with *'heimrichhannot/contao-teaser'* and its teaser content elements.
## Features
- Url alias support with backlinks (browser history)
- extendable for other modal frameworks/libraries
- custom header/footer
- content elements within modal body
- inserttags
- works together with `contao-disclaimer`
- Bootstrap 3 and 4 support
- [Contao Components](https://github.com/heimrichhannot/contao-components) support
## Setup
Install: `composer require heimrichhannot/contao-modal`
We recommend to disable the not used modal framework component in page layout.
### Insertags
Insert-Tag | Description | Arguments
---------- | ----------- | ---------
`{{modal_url::*::*::*}}` | Returns the modal url (usage: `Hier klicken`) | 1: modal id/alias, 2: jump to page id/alias, 3: auto_item id or alias
`{{modal_link::*::*::*::*}}` | Returns the modal link | 1: modal id/alias, 2: jump to page id/alias, 3: link text & title, 4: auto_item id or alias
`{{modal_link_open::*::*::*}}` | Returns the modal link's opening tag (``). | 1: modal id/alias, 2: jump to page id/alias, 3: auto_item id or alias
`{{modal_link_close::*}}` | Returns the modal link's closing tag (``) -> Requires associated {{modal_link_open}} tag. | 1: modal id/alias
### Hooks
Name | Arguments | Expected return value | Description
---------- | ---------- | ---------- | ---------
generateModalUrl | $arrRow, $strParams, $strUrl | $strUrl | Modify the modal url.
generateModal | $objTemplate, $objModel, $objConfig, $objModal | void | Modify the modal output.
getModalContentElement | $strContent, $objElement, $objTemplate, $objModel, $objConfig, $objModal | $strContent | Modify the modal within content element.
### Register custom modules to make usage of modal
If you want to register you list modules for example to make usage of the modal framework, you should enable by adding your module to the `$GLOBALS['MODAL_MODULES']`
```
config.php
/**
* Modal module configuration
*/
$GLOBALS['MODAL_MODULES']['mymodule_list'] = array
(
'invokePalette' => 'customTpl;', // The modal palette will be invoked after the field customTpl; as example
);
```
Than you have to implement the links within you list module. The following example is taken from the newslist implementation within the modal framework:
```
public function parseArticlesHook(&$objTemplate, $arrArticle, $objModule)
{
if (!$objModule->useModal || $arrArticle['source'] != 'default') {
return false;
}
$objJumpTo = \PageModel::findPublishedById($objTemplate->archive->jumpTo);
if ($objJumpTo === null || !$objJumpTo->linkModal) {
return false;
}
$objModal = ModalModel::findPublishedByIdOrAlias($objJumpTo->modal);
if ($objModal === null) {
return false;
}
$objJumpTo = \PageModel::findWithDetails($objJumpTo->id);
$arrConfig = ModalController::getModalConfig($objModal->current(), $objJumpTo->layout);
$blnAjax = true;
$blnRedirect = true;
$objTemplate->link = ModalController::generateModalUrl($arrArticle, $objTemplate->archive->jumpTo, $blnAjax, $blnRedirect);
$objTemplate->linkHeadline = ModalController::convertLinkToModalLink($objTemplate->linkHeadline, $objTemplate->link, $arrConfig, $blnRedirect);
$objTemplate->more = ModalController::convertLinkToModalLink($objTemplate->more, $objTemplate->link, $arrConfig, $blnRedirect);
}
```
As you can see, we attach to the parseArticles HOOK and adjust all links with `ModalController::generateModalUrl()` or `ModalController::convertLinkToModalLink()` functions.
**To access the Reader entities it is necessary to link the redirect page with a modal. Add a new modal first, attach the reader modules as content element and select "link Modal" within the redirect page in the site structure and assign the previously created modal to the page.**
### Add custom modal framework
To extend modal with your own framework, you have add the following:
#### Add your own modal config
You have to register your custom modal within '$GLOBALS['TL_MODALS']'.
```
// my_module/config/config.php
/**
* Modal types
*/
$GLOBALS['TL_MODALS']['my_custom_modal'] = array
(
'header' => true,
'footer' => true,
'template' => 'modal_my_custom_modal',
'link' => array(
'attributes' => array(
'data-toggle' => 'modal',
),
),
'js' => array
(
'system/modules/my_module/assets/js/jquery.my_custom_modal.js',
),
);
```
#### Add your modal template
The modal template contains the complete markup of your modal framework. Add as much as possible.
```
// my_module/templates/modals/modal_my_custom_modal.html5
```
#### Add your modal link template
The modal link template is required by inserttags (e.g {{modal_link::*}} to provide the correct trigger markup.
```
// my_module/templates/modals/modallink_my_custom_modal.html5
target; ?>= $this->linkAttributes; ?>>= $this->link; ?>
```
#### Add your modal javascript logic
The modal windows are delivered asynchronous by the ModalController. You have to implement the toggle, close and ajax loading by your own.
```
// my_module/assets/js/jquery.my_custom_modal.js
(function ($) {
var ModalBs3 = {
init: function () {
this.bindToggle();
this.bindClose();
$(document).ajaxComplete($.proxy(this.ajaxComplete, this));
},
ajaxComplete: function () {
this.bindClose();
},
bindToggle: function () {
$('[data-toggle=modal]').on('click', function () {
var $el = $(this),
url = $el.attr('href');
if (!url) {
return false;
}
$.ajax({
url: url,
dataType: 'json',
error: function(jqXHR, textStatus, errorThrown) {
if (jqXHR.status == 301) {
location.href = jqXHR.responseJSON.result.data.url;
closeModal(jqXHR.responseJSON, $form);
return;
}
},
success: function (response, textStatus, jqXHR) {
if (typeof response == 'undefined') {
return;
}
if (response.result.html && response.result.data.id) {
var $modal = $(response.result.html);
$('body').find('.modal').remove();
$modal.appendTo('body').modal('show');
if(typeof response.result.data.url !== 'undefined')
{
history.pushState(null, null, response.result.data.url);
}
}
}
});
return false;
});
},
bindClose: function () {
$('.modal').on('hide.bs.modal', function (e) {
var $this = $(this);
// stop embedded videos like youtube
$this.find('iframe').each(function () {
var $this = $(this);
// reset the src will stop the video
$this.attr('src', $this.attr('src').replace('autoplay=1', 'autoplay=0'));
});
// stop embedded audio/video
$this.find('audio, video').each(function () {
this.pause();
});
history.pushState(null, null, $this.data('back'));
// window.location.replace($this.data('back'));
});
}
}
$(function () {
ModalBs3.init()
});
})(jQuery);
```