247 lines
9.5 KiB
XML
247 lines
9.5 KiB
XML
|
<!--
|
||
|
|
~ Copyright (C) 2023 Xibo Signage Ltd
|
||
|
|
~
|
||
|
|
~ Xibo - Digital Signage - https://xibosignage.com
|
||
|
|
~
|
||
|
|
~ This file is part of Xibo.
|
||
|
|
~
|
||
|
|
~ Xibo is free software: you can redistribute it and/or modify
|
||
|
|
~ it under the terms of the GNU Affero General Public License as published by
|
||
|
|
~ the Free Software Foundation, either version 3 of the License, or
|
||
|
|
~ any later version.
|
||
|
|
~
|
||
|
|
~ Xibo is distributed in the hope that it will be useful,
|
||
|
|
~ but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
~ GNU Affero General Public License for more details.
|
||
|
|
~
|
||
|
|
~ You should have received a copy of the GNU Affero General Public License
|
||
|
|
~ along with Xibo. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
-->
|
||
|
|
<module>
|
||
|
|
<id>core-countdown-custom</id>
|
||
|
|
<name>Countdown - Custom</name>
|
||
|
|
<author>Core</author>
|
||
|
|
<description>A module for displaying a custom Countdown timer</description>
|
||
|
|
<icon>fa fa-hourglass-o</icon>
|
||
|
|
<class></class>
|
||
|
|
<showIn>none</showIn>
|
||
|
|
<type>countdown-custom</type>
|
||
|
|
<group id="countdown" icon="fa fa-hourglass-o">Countdown</group>
|
||
|
|
<dataType></dataType>
|
||
|
|
<schemaVersion>2</schemaVersion>
|
||
|
|
<assignable>1</assignable>
|
||
|
|
<regionSpecific>1</regionSpecific>
|
||
|
|
<renderAs>html</renderAs>
|
||
|
|
<defaultDuration>60</defaultDuration>
|
||
|
|
<thumbnail>countdown-custom-thumb</thumbnail>
|
||
|
|
<startWidth>400</startWidth>
|
||
|
|
<startHeight>150</startHeight>
|
||
|
|
<settings></settings>
|
||
|
|
<properties>
|
||
|
|
<property id="countdownType" type="dropdown" mode="single">
|
||
|
|
<title>Countdown Type</title>
|
||
|
|
<helpText>Please select the type of countdown.</helpText>
|
||
|
|
<default>1</default>
|
||
|
|
<options>
|
||
|
|
<option name="1">Widget Duration</option>
|
||
|
|
<option name="2">Custom Duration</option>
|
||
|
|
<option name="3">Use Date</option>
|
||
|
|
</options>
|
||
|
|
</property>
|
||
|
|
<property id="countdownDuration" type="number">
|
||
|
|
<title>Countdown Duration</title>
|
||
|
|
<helpText>The duration in seconds.</helpText>
|
||
|
|
<default></default>
|
||
|
|
<visibility>
|
||
|
|
<test type="or">
|
||
|
|
<condition field="countdownType" type="eq">2</condition>
|
||
|
|
</test>
|
||
|
|
</visibility>
|
||
|
|
<rule>
|
||
|
|
<test type="or" message="Please enter a positive countdown duration">
|
||
|
|
<condition type="gt">0</condition>
|
||
|
|
<condition field="countdownType" type="neq">2</condition>
|
||
|
|
</test>
|
||
|
|
</rule>
|
||
|
|
</property>
|
||
|
|
<property id="countdownDate" type="date" format="DD/MM/YYYY HH:mm:ss" variant="dateTime">
|
||
|
|
<title>Countdown Date</title>
|
||
|
|
<helpText>Select the target date and time.</helpText>
|
||
|
|
<default>10/10/2010 10:10:10</default>
|
||
|
|
<visibility>
|
||
|
|
<test type="or">
|
||
|
|
<condition field="countdownType" type="eq">3</condition>
|
||
|
|
</test>
|
||
|
|
</visibility>
|
||
|
|
<rule>
|
||
|
|
<test>
|
||
|
|
<condition type="required"></condition>
|
||
|
|
</test>
|
||
|
|
</rule>
|
||
|
|
</property>
|
||
|
|
<property id="countdownWarningDuration" type="number">
|
||
|
|
<title>Warning Duration</title>
|
||
|
|
<helpText>The countdown will show in a warning mode from the end duration entered.</helpText>
|
||
|
|
<default></default>
|
||
|
|
<visibility>
|
||
|
|
<test type="or">
|
||
|
|
<condition field="countdownType" type="eq">1</condition>
|
||
|
|
<condition field="countdownType" type="eq">2</condition>
|
||
|
|
</test>
|
||
|
|
</visibility>
|
||
|
|
<rule onStatus="false">
|
||
|
|
<test type="or" message="Warning duration needs to be lower than the countdown main duration.">
|
||
|
|
<condition type="eq"></condition>
|
||
|
|
<condition field="countdownType" type="neq">2</condition>
|
||
|
|
<condition field="countdownDuration" type="lt"></condition>
|
||
|
|
</test>
|
||
|
|
<test type="or" message="Warning duration needs to be lower than the widget duration.">
|
||
|
|
<condition field="countdownType" type="neq">1</condition>
|
||
|
|
<condition field="duration" type="lt"></condition>
|
||
|
|
<condition type="eq"></condition>
|
||
|
|
</test>
|
||
|
|
<test type="or" message="Please enter a positive warning duration">
|
||
|
|
<condition type="gt">0</condition>
|
||
|
|
<condition type="eq"></condition>
|
||
|
|
</test>
|
||
|
|
</rule>
|
||
|
|
</property>
|
||
|
|
<property id="countdownWarningDate" type="date" format="DD/MM/YYYY HH:mm:ss" variant="dateTime">
|
||
|
|
<title>Warning Date</title>
|
||
|
|
<helpText>The countdown will show in a warning mode from the warning date entered.</helpText>
|
||
|
|
<default></default>
|
||
|
|
<visibility>
|
||
|
|
<test type="or">
|
||
|
|
<condition field="countdownType" type="eq">3</condition>
|
||
|
|
</test>
|
||
|
|
</visibility>
|
||
|
|
<rule>
|
||
|
|
<test type="or" message="Warning date needs to be before countdown date.">
|
||
|
|
<condition field="countdownType" type="neq">3</condition>
|
||
|
|
<condition field="countdownDate" type="lt"></condition>
|
||
|
|
<condition type="eq"></condition>
|
||
|
|
</test>
|
||
|
|
</rule>
|
||
|
|
</property>
|
||
|
|
<property id="customTemplate" type="hidden">
|
||
|
|
<default>1</default>
|
||
|
|
</property>
|
||
|
|
<property id="moduleType" type="hidden">
|
||
|
|
<default>countdown</default>
|
||
|
|
</property>
|
||
|
|
<property id="widgetDesignWidth" type="number">
|
||
|
|
<title>Original Width</title>
|
||
|
|
<helpText>This is the intended width of the template and is used to scale the Widget within its region when the template is applied.</helpText>
|
||
|
|
</property>
|
||
|
|
<property id="widgetDesignHeight" type="number">
|
||
|
|
<title>Original Height</title>
|
||
|
|
<helpText>This is the intended height of the template and is used to scale the Widget within its region when the template is applied.</helpText>
|
||
|
|
</property>
|
||
|
|
<property id="mainTemplate" type="code" allowLibraryRefs="true" parseTranslations="true" variant="html">
|
||
|
|
<title>mainTemplate</title>
|
||
|
|
</property>
|
||
|
|
<property id="styleSheet" type="code" allowLibraryRefs="true" variant="css">
|
||
|
|
<title>styleSheet</title>
|
||
|
|
</property>
|
||
|
|
<property id="alignmentH" type="dropdown" mode="single">
|
||
|
|
<title>Horizontal Align</title>
|
||
|
|
<helpText>How should this widget be horizontally aligned?</helpText>
|
||
|
|
<default>center</default>
|
||
|
|
<options>
|
||
|
|
<option name="left">Left</option>
|
||
|
|
<option name="center">Centre</option>
|
||
|
|
<option name="right">Right</option>
|
||
|
|
</options>
|
||
|
|
</property>
|
||
|
|
<property id="alignmentV" type="dropdown" mode="single">
|
||
|
|
<title>Vertical Align</title>
|
||
|
|
<helpText>How should this widget be vertically aligned?</helpText>
|
||
|
|
<default>middle</default>
|
||
|
|
<options>
|
||
|
|
<option name="top">Top</option>
|
||
|
|
<option name="middle">Middle</option>
|
||
|
|
<option name="bottom">Bottom</option>
|
||
|
|
</options>
|
||
|
|
</property>
|
||
|
|
</properties>
|
||
|
|
<preview></preview>
|
||
|
|
<stencil>
|
||
|
|
<hbs></hbs>
|
||
|
|
<twig><![CDATA[
|
||
|
|
<div class="countdown-container">
|
||
|
|
{{mainTemplate|raw}}
|
||
|
|
</div>
|
||
|
|
]]></twig>
|
||
|
|
<style><![CDATA[
|
||
|
|
{{styleSheet|raw}}
|
||
|
|
]]></style>
|
||
|
|
</stencil>
|
||
|
|
<onRender><![CDATA[
|
||
|
|
// Make replacements on render for all templates
|
||
|
|
var $countdownContainer = $('.countdown-container', target);
|
||
|
|
|
||
|
|
// Get countdown container html
|
||
|
|
var countdownHTML = $countdownContainer.html();
|
||
|
|
|
||
|
|
// Move countdown container to content
|
||
|
|
$countdownContainer.appendTo($('#content'));
|
||
|
|
|
||
|
|
// Make replacements
|
||
|
|
var text = countdownHTML;
|
||
|
|
var regex = /\[.*?\]/g;
|
||
|
|
countdownHTML = text.replace(regex, function (match) {
|
||
|
|
var replacement = '';
|
||
|
|
var matchParsed = match.replace('[', '').replace(']', '');
|
||
|
|
|
||
|
|
// Replace tags
|
||
|
|
switch (matchParsed) {
|
||
|
|
case 'ss':
|
||
|
|
replacement = '<span class="seconds"></span>';
|
||
|
|
break;
|
||
|
|
case 'ssa':
|
||
|
|
replacement = '<span class="secondsAll"></span>';
|
||
|
|
break;
|
||
|
|
case 'mm':
|
||
|
|
replacement = '<span class="minutes"></span>';
|
||
|
|
break;
|
||
|
|
case 'mma':
|
||
|
|
replacement = '<span class="minutesAll"></span>';
|
||
|
|
break;
|
||
|
|
case 'hh':
|
||
|
|
replacement = '<span class="hours"></span>';
|
||
|
|
break;
|
||
|
|
case 'hha':
|
||
|
|
replacement = '<span class="hoursAll"></span>';
|
||
|
|
break;
|
||
|
|
case 'DD':
|
||
|
|
replacement = '<span class="days"></span>';
|
||
|
|
break;
|
||
|
|
case 'WW':
|
||
|
|
replacement = '<span class="weeks"></span>';
|
||
|
|
break;
|
||
|
|
case 'MM':
|
||
|
|
replacement = '<span class="months"></span>';
|
||
|
|
break;
|
||
|
|
case 'YY':
|
||
|
|
replacement = '<span class="years"></span>';
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
replacement = 'NULL';
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
return replacement;
|
||
|
|
});
|
||
|
|
|
||
|
|
// Attach html back to container
|
||
|
|
$countdownContainer.html(countdownHTML);
|
||
|
|
|
||
|
|
// Scale the layout
|
||
|
|
$(target).xiboLayoutScaler(properties);
|
||
|
|
|
||
|
|
// Render the countdown
|
||
|
|
var $contentContainer = $(target).find('#content');
|
||
|
|
$contentContainer.xiboCountdownRender(properties, $contentContainer.html());
|
||
|
|
]]></onRender>
|
||
|
|
</module>
|