Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 3.2
edited by jklein
on 2025/06/02 09:10
Change comment: There is no comment for this version
To version 24.3
edited by jklein
on 2025/06/02 13:53
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,31 +1,26 @@
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();
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 7  
8 - if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) == -1)
8 + if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
9 9   effect = 'toggle';
10 + }
10 10  
11 - // Determine current visibility and toggle state
12 - data.showHideState = !(('showHideState' in data) ? data.showHideState : content.is(':visible'));
12 + var isVisible = content.is(':visible');
13 + var newState = !isVisible;
13 13  
14 - // Determine message and icon
15 - var message = button.attr(data.showHideState ? 'data-hide-message' : 'data-show-message');
16 - var icon = data.showHideState ? '▼ ' : '► ';
15 + // Toggle 'open'-Klasse für Rotation
16 + header.toggleClass('open', newState);
17 17  
18 - // Update button text with icon
19 - button.html(icon + message);
20 -
21 - // Perform the animation
22 - content.stop()[effect](parseInt(button.attr('data-show-duration')));
23 -
24 - return false;
18 + // Ein-/Ausblenden des Inhalts
19 + content.stop()[effect](duration);
25 25   }
26 26  
27 - $(document).ready(function() {
28 - $('.showhidebutton').children('a').on('click', onClick);
22 + $(document).ready(function () {
23 + $('.showhide-header').on('click', onClickHeader);
29 29   });
30 30  });
31 31  
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,22 +1,35 @@
1 +.showhide-header {
2 + border: 1px solid #ccc;
3 + background-color: #f7f7f7;
4 + border-radius: 4px 4px 0 0;
5 + padding: 10px 12px;
6 + cursor: pointer;
7 + user-select: none;
8 +}
9 +
1 1  .showhide-header-flex {
2 2   display: flex;
3 3   justify-content: space-between;
4 4   align-items: center;
5 - background-color: #f9f9f9;
6 - padding: 6px 10px;
7 - border: 1px solid #ddd;
8 - border-radius: 4px 4px 0 0;
9 - font-weight: bold;
10 10  }
11 11  
12 12  .showhide-title {
13 13   flex: 1;
14 14   text-align: left;
19 + font-weight: bold;
15 15  }
16 16  
17 -.showhidebutton a {
18 - text-decoration: none;
19 - cursor: pointer;
20 - font-weight: normal;
22 +.showhide-arrow {
23 + display: inline-block;
24 + transition: transform 0.3s ease;
25 + transform: rotate(0deg);
26 + font-size: 16px;
27 + color: #0645ad;
21 21  }
22 22  
30 +/* Wenn Container 'open' ist → Pfeil dreht sich */
31 +.showhide-header.open .showhide-arrow {
32 + transform: rotate(90deg);
33 +}
34 +
35 +
Content Type
... ... @@ -1,0 +1,1 @@
1 +CSS
Name
... ... @@ -1,1 +1,1 @@
1 -ShowHide Style
1 +APIMacro Style
Parse content
... ... @@ -1,0 +1,1 @@
1 +No
Use this extension
... ... @@ -1,0 +1,1 @@
1 +always
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -11,17 +11,6 @@
11 11  #set($hidemessage = $escapetool.xml($mparams.hidemessage))
12 12  #set($divstyle = $escapetool.xml($mparams.style))
13 13  #set($effect = $escapetool.xml($mparams.effect))
14 -#set($title = $escapetool.xml($mparams.title))
15 -
16 -## Standardtexte setzen
17 -#if(!$showmessage || $showmessage == "")
18 - #set($showmessage = "Anzeigen")
19 -#end
20 -#if(!$hidemessage || $hidemessage == "")
21 - #set($hidemessage = "Verbergen")
22 -#end
23 -
24 -## Effekte setzen
25 25  #if($effect == "appear" || $effect == "fade")
26 26   #set($effect = "fadeToggle")
27 27  #elseif ($effect == "blind" || $effect == "slide")
... ... @@ -28,37 +28,27 @@
28 28   #set($effect = "slideToggle")
29 29  #end
30 30  #set($effectduration = $mathtool.mul(1000,$mparams.effectduration))
31 -
32 -## HTML-Struktur
20 +#set($title = $escapetool.xml($mparams.title))
33 33  (% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
34 34  (((
35 -
36 -(% class="showhide-header" %)
37 -(((
38 38  {{html clean=false}}
39 -<div class="showhide-header-flex">
40 - <div class="showhide-title">$title</div>
41 - <div class="showhidebutton">
42 - <a href="javascript:void(0)"
43 - #if($id && $id!="")id="showhidebuttontext${id}" #end
44 - data-show-duration="$effectduration"
45 - data-show-effect="$effect"
46 - data-show-message="$showmessage"
47 - data-hide-message="$hidemessage">
48 - ► $showmessage
49 - </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">&#9654;</div> ## Unicode ▶
50 50   </div>
51 51  </div>
52 52  {{/html}}
53 -)))
54 -
34 +</div>
35 +{{/html}}
55 55  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
56 -(((
57 -(((
37 +(((
38 +(((
58 58  {{wikimacrocontent /}}
59 -)))
60 60  )))
61 -
62 62  )))
42 +)))
63 63  {{/velocity}}
64 -
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 -Ausklappen
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 -Einklappen
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.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