Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 2.1
edited by jklein
on 2025/06/02 08:06
Change comment: Install extension [org.xwiki.contrib.showhide:showhide-macro/2.1]
To version 23.1
edited by jklein
on 2025/06/02 13:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Show Hide Macro
1 +APIMacro
Parent
... ... @@ -1,1 +1,1 @@
1 -Macros.WebHome
1 +WebHome
Content
... ... @@ -1,66 +1,7 @@
1 -Wiki macros implementation for simple show/hide of a content with some animations.
2 -This version 2.0 is HTML compatible with the old version, so that existing project could continue styling
3 -with the same kind of CSS rules. However, it is now based on jQuery, and need requireJS, so it requires
4 -XWiki 5.x or more.
1 +{{apimacro}}
2 +Code
5 5  
6 -{{info}}Using ##id="..."## is still supported and provide the same HTML result but it is no more needed to achieve a working animation.{{/info}}
4 +Code
7 7  
8 -== Without effect ==
9 -
10 -{{showhide showmessage="Show" hidemessage="Hide" style="background-color: #ccc"}}
11 -Here is some hidden content that can become visible
12 -Here is some hidden content that can become visible
13 -Here is some hidden content that can become visible
14 -Here is some hidden content that can become visible
15 -{{/showhide}}
16 -
17 -{{code}}
18 -{{showhide showmessage="Show" hidemessage="Hide" style="background-color: #ccc"}}
19 -Here is some hidden content that can become visible
20 -Here is some hidden content that can become visible
21 -Here is some hidden content that can become visible
22 -Here is some hidden content that can become visible
23 -{{/showhide}}
24 -{{/code}}
25 -
26 -== With a fade in effect ==
27 -
28 -{{showhide showmessage="Show" hidemessage="Hide" effect="fade" effectduration="2" style="background-color: #ccc"}}
29 -Here is some hidden content that can become visible
30 -Here is some hidden content that can become visible
31 -Here is some hidden content that can become visible
32 -Here is some hidden content that can become visible
33 -{{/showhide}}
34 -
35 -{{code}}
36 -{{showhide showmessage="Show" hidemessage="Hide" effect="fade" effectduration="2" style="background-color: #ccc"}}
37 -Here is some hidden content that can become visible
38 -Here is some hidden content that can become visible
39 -Here is some hidden content that can become visible
40 -Here is some hidden content that can become visible
41 -{{/showhide}}
42 -{{/code}}
43 -
44 -{{info}}Using ##effect="appear"## is still supported and provide the same behavior{{/info}}
45 -
46 -== With a sliding down effect ==
47 -
48 -{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
49 -Here is some hidden content that can become visible
50 -Here is some hidden content that can become visible
51 -Here is some hidden content that can become visible
52 -Here is some hidden content that can become visible
53 -{{/showhide}}
54 -
55 -{{code}}
56 -{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
57 -Here is some hidden content that can become visible
58 -Here is some hidden content that can become visible
59 -Here is some hidden content that can become visible
60 -Here is some hidden content that can become visible
61 -{{/showhide}}
62 -{{/code}}
63 -
64 -{{info}}This effect is equivalent to ##effect="blind"## in the 1.0 macro, so both ##slide## and ##blind## effect are now using the exact same animation.{{/info}}
65 -
66 -
6 +Code
7 +{{/apimacro}}
XWiki.JavaScriptExtension[0]
Code
... ... @@ -1,16 +1,31 @@
1 1  require(['jquery'], function($) {
2 - function onClick () {
3 - var button = $(this),
4 - content = button.parent().next(),
5 - effect = button.attr('data-show-effect'),
6 - data = button.data();
7 - if($.inArray(effect,['toggle','fadeToggle','slideToggle']) == -1) effect = 'toggle';
8 - data.showHideState = !(('showHideState' in data) ? data.showHideState : content.is(':visible'));
9 - button.html(button.attr(data.showHideState ? 'data-hide-message' : 'data-show-message'));
10 - content.stop()[effect](parseInt(button.attr('data-show-duration')));
11 - return false;
2 + function onClickHeader() {
3 + var header = $(this),
4 + content = header.next('.showhidecontent'),
5 + effect = header.attr('data-show-effect'),
6 + duration = parseInt(header.attr('data-show-duration')) || 300,
7 + iconEl = header.find('.showhide-icon');
8 +
9 + // Sicherheitsprüfung für Effekt
10 + if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
11 + effect = 'toggle';
12 + }
13 +
14 + // Sichtbarkeitsstatus
15 + var isVisible = content.is(':visible');
16 + var newState = !isVisible;
17 +
18 + // Nachricht + Pfeil setzen
19 + var message = newState ? header.attr('data-hide-message') : header.attr('data-show-message');
20 + var icon = newState ? '▼ ' : '► ';
21 + iconEl.html(icon + message);
22 +
23 + // Inhalt ein-/ausblenden
24 + content.stop()[effect](duration);
12 12   }
13 - $(document).ready(function() {
14 - $('.showhidebutton').children('a').on('click', onClick);
26 +
27 + $(document).ready(function () {
28 + $('.showhide-header').on('click', onClickHeader);
15 15   });
16 16  });
31 +
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro Script
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -17,14 +17,20 @@
17 17   #set($effect = "slideToggle")
18 18  #end
19 19  #set($effectduration = $mathtool.mul(1000,$mparams.effectduration))
20 +#set($title = $escapetool.xml($mparams.title))
20 20  (% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
21 21  (((
22 -(% class="showhidebutton" %)
23 -(((
24 24  {{html clean=false}}
25 -<a href="javascript:void(0)" #if($id && $id!="")id="showhidebuttontext${id}" #end data-show-duration="$effectduration" data-show-effect="$effect" data-show-message="$showmessage" data-hide-message="$hidemessage">$mparams.showmessage</a>
24 +<div class="showhide-header"
25 + #if($id && $id!="") id="showhideheader${id}" #end
26 + data-show-duration="$effectduration"
27 + data-show-effect="$effect">
28 + <div class="showhide-header-flex">
29 + <div class="showhide-title">$title</div>
30 + <div class="showhide-arrow">►</div>
31 + </div>
32 +</div>
26 26  {{/html}}
27 -)))
28 28  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
29 29  (((
30 30  (((
Macro id
... ... @@ -1,1 +1,1 @@
1 -showhide
1 +apimacro
Macro name
... ... @@ -1,1 +1,1 @@
1 -showhide
1 +APIMacro
XWiki.WikiMacroParameterClass[0]
Parameter default value
... ... @@ -1,1 +1,0 @@
1 -Show !
Parameter description
... ... @@ -1,1 +1,0 @@
1 -Show Message
Parameter mandatory
... ... @@ -1,1 +1,0 @@
1 -No
Parameter name
... ... @@ -1,1 +1,0 @@
1 -showmessage
XWiki.WikiMacroParameterClass[1]
Parameter default value
... ... @@ -1,1 +1,0 @@
1 -Hide !
Parameter description
... ... @@ -1,1 +1,0 @@
1 -Hide Message
Parameter name
... ... @@ -1,1 +1,0 @@
1 -hidemessage
XWiki.WikiMacroParameterClass[3]
Parameter default value
... ... @@ -1,1 +1,1 @@
1 -toggle
1 +slide
XWiki.WikiMacroParameterClass[6]
Parameter description
... ... @@ -1,1 +1,0 @@
1 -DIV style
Parameter mandatory
... ... @@ -1,1 +1,0 @@
1 -No
Parameter name
... ... @@ -1,1 +1,0 @@
1 -style
XWiki.StyleSheetExtension[0]
Caching policy
... ... @@ -1,0 +1,1 @@
1 +long
Code
... ... @@ -1,0 +1,54 @@
1 +.showhide-header {
2 + border: 1px solid #ccc;
3 + background-color: #f7f7f7;
4 + border-radius: 4px 4px 0 0;
5 + padding: 8px 12px;
6 + margin-bottom: 0;
7 +}
8 +
9 +.showhide-header-flex {
10 + display: flex;
11 + justify-content: space-between;
12 + align-items: center;
13 + padding: 6px 0px;
14 + font-weight: bold;
15 +}
16 +
17 +.showhide-title {
18 + flex: 1;
19 + text-align: left;
20 +}
21 +
22 +.showhidebutton a {
23 + text-decoration: none;
24 + cursor: pointer;
25 + font-weight: normal;
26 +}
27 +
28 +.showhidecontent {
29 + border: 1px solid #ccc;
30 + border-top: none;
31 + border-radius: 0 0 4px 4px;
32 + padding: 10px;
33 + background-color: #fff;
34 +}
35 +
36 +.showhide-header:hover {
37 + background-color: #f0f0f0;
38 + cursor: default;
39 +}
40 +
41 +.showhidebutton a:hover {
42 + text-decoration: underline;
43 +}
44 +
45 +.showhide-icon {
46 + color: #0645ad; /* typisches Link-Blau */
47 + text-decoration: underline;
48 + cursor: pointer;
49 +}
50 +
51 +.showhide-header:hover .showhide-icon {
52 + text-decoration: underline;
53 + color: #0b0080; /* dunkler beim Hover */
54 +}
Content Type
... ... @@ -1,0 +1,1 @@
1 +CSS
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro Style
Parse content
... ... @@ -1,0 +1,1 @@
1 +No
Use this extension
... ... @@ -1,0 +1,1 @@
1 +always
XWiki.WikiMacroParameterClass[7]
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +title
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community