You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
204 lines
8.1 KiB
204 lines
8.1 KiB
<?php
|
|
|
|
// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
|
|
//
|
|
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
|
|
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
|
|
// $Id$
|
|
|
|
function wikiplugin_fade_info()
|
|
{
|
|
return [
|
|
'name' => tra('Fade'),
|
|
'documentation' => 'PluginFade',
|
|
'description' => tra('Create a link that shows/hides initially hidden content'),
|
|
'prefs' => ['wikiplugin_fade'],
|
|
'body' => tra('Content of the hideable zone (in Wiki syntax)'),
|
|
'filter' => 'wikicontent',
|
|
'format' => 'html',
|
|
'iconname' => 'wizard',
|
|
'introduced' => 3,
|
|
'tags' => [ 'basic' ],
|
|
'params' => [
|
|
'label' => [
|
|
'required' => true,
|
|
'name' => tra('Label'),
|
|
'filter' => 'text',
|
|
'description' => tra('Label for link that shows and hides the content when clicked'),
|
|
'default' => tra('Unspecified label'),
|
|
'since' => '3.0',
|
|
],
|
|
'icon' => [
|
|
'required' => false,
|
|
'name' => tra('Icon'),
|
|
'filter' => 'alpha',
|
|
'description' => tra('Arrow icon showing that content can be hidden or shown.'),
|
|
'default' => '',
|
|
'since' => '7.0',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tra('Yes'), 'value' => 'y'],
|
|
['text' => tra('No'), 'value' => 'n'],
|
|
],
|
|
],
|
|
'show_speed' => [
|
|
'required' => false,
|
|
'name' => tra('Show Speed'),
|
|
'filter' => 'alnum',
|
|
'description' => tr('Speed of animation in milliseconds when showing content (%0200%1 is fast and
|
|
%0600%1 is slow. %01000%1 equals 1 second).', '<code>', '</code>'),
|
|
'default' => 400,
|
|
'since' => '7.0',
|
|
'accepted' => tr(
|
|
'Integer greater than 0 and less than or equal to 1000, or %0 or %1',
|
|
'<code>fast</code>',
|
|
'<code>slow</code>'
|
|
),
|
|
'advanced' => true,
|
|
],
|
|
'hide_speed' => [
|
|
'required' => false,
|
|
'name' => tra('Hide Speed'),
|
|
'filter' => 'alnum',
|
|
'description' => tr('Speed of animation in milliseconds when hiding content (%0200%1 is fast and
|
|
%0600%1 is slow. %01000%1 equals 1 second).', '<code>', '</code>'),
|
|
'default' => 400,
|
|
'since' => '7.0',
|
|
'accepted' => tr(
|
|
'Integer greater than 0 and less than or equal to 1000, or %0 or %1',
|
|
'<code>fast</code>',
|
|
'<code>slow</code>'
|
|
),
|
|
'advanced' => true,
|
|
],
|
|
'bootstrap' => [
|
|
'required' => false,
|
|
'name' => tra('Use Bootstrap'),
|
|
'description' => tra('Use Bootstrap collapsible box'),
|
|
'since' => '16.0',
|
|
'filter' => 'alpha',
|
|
'default' => 'n',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tra('Yes'), 'value' => 'y'],
|
|
['text' => tra('No'), 'value' => 'n']
|
|
]
|
|
],
|
|
'class' => [
|
|
'required' => false,
|
|
'name' => tra('CSS Class'),
|
|
'description' => tra('Apply custom CSS class.'),
|
|
'since' => '16.0',
|
|
'filter' => 'text',
|
|
'default' => '',
|
|
],
|
|
]
|
|
];
|
|
}
|
|
|
|
function wikiplugin_fade($body, $params)
|
|
{
|
|
static $id = 0;
|
|
//set defaults
|
|
$plugininfo = wikiplugin_fade_info();
|
|
foreach ($plugininfo['params'] as $key => $param) {
|
|
$default["$key"] = $param['default'];
|
|
}
|
|
//apply user parameter settings
|
|
$params = array_merge($default, $params);
|
|
//validate speed parameters
|
|
$params['show_speed'] = validate_speed($params['show_speed']);
|
|
$params['hide_speed'] = validate_speed($params['hide_speed']);
|
|
|
|
$unique = 'wpfade-' . ++$id;
|
|
$unique_link = $unique . '-link';
|
|
|
|
if ($params['icon'] == 'y') {
|
|
$span_class = 'wpfade-span-icon';
|
|
$a_class_hidden = '\'wpfade-hidden\'';
|
|
$a_class_shown = '\'wpfade-shown\'';
|
|
$div_class = 'wpfade-div-icon';
|
|
} else {
|
|
$span_class = 'wpfade-span-plain';
|
|
$a_class_hidden = '';
|
|
$a_class_shown = '';
|
|
$div_class = 'wpfade-div-plain';
|
|
}
|
|
|
|
// We specify format html, so parse the contained wiki text
|
|
$body = trim($body);
|
|
$body = TikiLib::lib('parser')->parse_data($body);
|
|
|
|
// Both variants will need $headerlib
|
|
$headerlib = TikiLib::lib('header');
|
|
|
|
if ($params['bootstrap'] == 'y') {
|
|
$unique_outer = $unique . '-outer';
|
|
$unique_inner = $unique . '-inner';
|
|
|
|
// The java script is used to toggle the chevron icon from down to up.
|
|
//
|
|
// It is based on the suggestion by zessz here
|
|
// http://stackoverflow.com/a/18337268/1626109
|
|
// and the working example here
|
|
// http://jsfiddle.net/zessx/R6EAW/12/
|
|
//
|
|
// It might not be necessary to go back to the 'card-header' before
|
|
// going forward to the icon.
|
|
|
|
$jq = "function toggleChevron(e)
|
|
{
|
|
$(e.target)
|
|
.prev('.card-header')
|
|
.find('span.icon')
|
|
.toggleClass('fa-chevron-down fa-chevron-up');
|
|
}
|
|
$('#" . $unique_outer . "').on('hide.bs.collapse', toggleChevron);
|
|
$('#" . $unique_outer . "').on('show.bs.collapse', toggleChevron);" ;
|
|
|
|
$headerlib->add_jq_onready($jq);
|
|
|
|
return "<div id='" . $unique_outer . "' class='card" . ( isset($params['class']) ? ' ' . $params['class'] : '' ) . "'>"
|
|
. "<div class='card-header'>"
|
|
. "<a data-bs-toggle='collapse' href='#" . $unique_inner . "'>" . htmlspecialchars($params['label']) . "<span class='icon icon-menu-extra fas fa-chevron-down fa-fw' style='float:right'></span>" . "</a>"
|
|
. "</div>"
|
|
. "<div id='" . $unique_inner . "' class='panel-collapse collapse'>"
|
|
. "<div class='card-body'>" . $body . "</div>"
|
|
. "</div>"
|
|
. "</div>" ;
|
|
} else {
|
|
$jq = '
|
|
$(document).ready( function() {
|
|
$(\'#' . $unique_link . '\').click(
|
|
function() {
|
|
if ( $(\'#' . $unique . '\').is(":hidden") ) {
|
|
$(\'#' . $unique . '\').show(\'blind\', {}, \'' . $params['show_speed'] . '\');
|
|
$(\'#' . $unique_link . '\').addClass(' . $a_class_shown . ').removeClass(' . $a_class_hidden . ');
|
|
} else {
|
|
$(\'#' . $unique . '\').hide(\'blind\', {}, \'' . $params['hide_speed'] . '\');
|
|
$(\'#' . $unique_link . '\').addClass(' . $a_class_hidden . ').removeClass(' . $a_class_shown . ');
|
|
}
|
|
}
|
|
);
|
|
return false;
|
|
});';
|
|
$headerlib->add_jq_onready($jq);
|
|
//wrapping in an extra div makes animation smoother
|
|
return ( isset($params['class']) ? "<div class='" . $params['class'] . "'>" : "<div>" )
|
|
. "\r\t" . '<span class="' . $span_class . '">' . "\r\t\t"
|
|
. '<a id="' . $unique_link . '" class=' . $a_class_hidden . '>' . "\r\t\t\t" . htmlspecialchars($params['label']) . "\r\t\t"
|
|
. '</a>' . "\r\t" . '</span>' . "\r\t" . '<div id="' . $unique . '" class="' . $div_class . '">' . "\r\t\t\t"
|
|
. $body . "\r\t" . '</div>' . "\r" . '</div>' . "\r";
|
|
}
|
|
}
|
|
|
|
function validate_speed($speed_param)
|
|
{
|
|
if (
|
|
! (($speed_param > 0 && $speed_param <= 1000)
|
|
|| $speed_param == 'fast' || $speed_param == 'slow')
|
|
) {
|
|
$speed_param = 400;
|
|
}
|
|
return $speed_param;
|
|
}
|