Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 23.2
edited by jklein
on 2025/06/02 13:49
Change comment: There is no comment for this version
To version 4.1
edited by jklein
on 2025/06/02 09:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -APIMacro
1 +Show Hide Macro
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Macros.WebHome
Content
... ... @@ -1,7 +1,76 @@
1 -{{apimacro}}
2 -Code
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.
3 3  
4 -Code
6 +{{showhide}}
7 +Inhalt
8 +Inhalt
9 +Inhalt
10 +{{/showhide}}
5 5  
6 -Code
7 -{{/apimacro}}
12 +{{info}}
13 +Using ##id="..."## is still supported and provide the same HTML result but it is no more needed to achieve a working animation.
14 +{{/info}}
15 +
16 +== Without effect ==
17 +
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 +
25 +{{code}}
26 +{{showhide showmessage="Show" hidemessage="Hide" style="background-color: #ccc"}}
27 +Here is some hidden content that can become visible
28 +Here is some hidden content that can become visible
29 +Here is some hidden content that can become visible
30 +Here is some hidden content that can become visible
31 +{{/showhide}}
32 +{{/code}}
33 +
34 +== With a fade in effect ==
35 +
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 +
43 +{{code}}
44 +{{showhide showmessage="Show" hidemessage="Hide" effect="fade" effectduration="2" style="background-color: #ccc"}}
45 +Here is some hidden content that can become visible
46 +Here is some hidden content that can become visible
47 +Here is some hidden content that can become visible
48 +Here is some hidden content that can become visible
49 +{{/showhide}}
50 +{{/code}}
51 +
52 +{{info}}
53 +Using ##effect="appear"## is still supported and provide the same behavior
54 +{{/info}}
55 +
56 +== With a sliding down effect ==
57 +
58 +{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
59 +Here is some hidden content that can become visible
60 +Here is some hidden content that can become visible
61 +Here is some hidden content that can become visible
62 +Here is some hidden content that can become visible
63 +{{/showhide}}
64 +
65 +{{code}}
66 +{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
67 +Here is some hidden content that can become visible
68 +Here is some hidden content that can become visible
69 +Here is some hidden content that can become visible
70 +Here is some hidden content that can become visible
71 +{{/showhide}}
72 +{{/code}}
73 +
74 +{{info}}
75 +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.
76 +{{/info}}
XWiki.JavaScriptExtension[0]
Code
... ... @@ -1,29 +1,31 @@
1 1  require(['jquery'], function($) {
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 - arrow = header.find('.showhide-arrow');
2 + function onClick () {
3 + var button = $(this),
4 + content = button.parent().next(),
5 + effect = button.attr('data-show-effect'),
6 + data = button.data();
8 8  
9 - if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
8 + if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) == -1)
10 10   effect = 'toggle';
11 - }
12 12  
13 - var isVisible = content.is(':visible');
14 - var newState = !isVisible;
11 + // Determine current visibility and toggle state
12 + data.showHideState = !(('showHideState' in data) ? data.showHideState : content.is(':visible'));
15 15  
16 - // Pfeil wechseln
17 - if (arrow.length) {
18 - arrow.text(newState ? '▼' : '►');
19 - }
14 + // Determine message and icon
15 + var message = button.attr(data.showHideState ? 'data-hide-message' : 'data-show-message');
16 + var icon = data.showHideState ? '▼ ' : '► ';
20 20  
21 - // Inhalt ein-/ausklappen
22 - content.stop()[effect](duration);
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;
23 23   }
24 24  
25 - $(document).ready(function () {
26 - $('.showhide-header').on('click', onClickHeader);
27 + $(document).ready(function() {
28 + $('.showhidebutton').children('a').on('click', onClick);
27 27   });
28 28  });
29 29  
Name
... ... @@ -1,1 +1,0 @@
1 -APIMacro Script
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,30 +10,22 @@
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 -
10 10  .showhide-header-flex {
11 11   display: flex;
12 12   justify-content: space-between;
13 13   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;
14 14  }
15 15  
16 16  .showhide-title {
17 17   flex: 1;
18 18   text-align: left;
19 - font-weight: bold;
20 20  }
21 21  
22 -.showhide-arrow {
23 - font-size: 16px;
24 - font-weight: bold;
25 - color: #0645ad;
26 - text-align: right;
27 - min-width: 20px;
28 - transition: transform 0.2s ease;
17 +.showhidebutton a {
18 + text-decoration: none;
19 + cursor: pointer;
20 + font-weight: normal;
29 29  }
30 30  
Content Type
... ... @@ -1,1 +1,0 @@
1 -CSS
Name
... ... @@ -1,1 +1,1 @@
1 -APIMacro Style
1 +ShowHide Style
Parse content
... ... @@ -1,1 +1,0 @@
1 -No
Use this extension
... ... @@ -1,1 +1,0 @@
1 -always
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -11,6 +11,17 @@
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
14 14  #if($effect == "appear" || $effect == "fade")
15 15   #set($effect = "fadeToggle")
16 16  #elseif ($effect == "blind" || $effect == "slide")
... ... @@ -17,25 +17,37 @@
17 17   #set($effect = "slideToggle")
18 18  #end
19 19  #set($effectduration = $mathtool.mul(1000,$mparams.effectduration))
20 -#set($title = $escapetool.xml($mparams.title))
31 +
32 +## HTML-Struktur
21 21  (% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
22 22  (((
35 +
36 +(% class="showhide-header" %)
37 +(((
23 23  {{html clean=false}}
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>
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>
31 31   </div>
32 32  </div>
33 33  {{/html}}
53 +)))
54 +
34 34  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
35 -(((
36 -(((
56 +(((
57 +(((
37 37  {{wikimacrocontent /}}
59 +)))
38 38  )))
61 +
39 39  )))
40 -)))
41 41  {{/velocity}}
64 +
Macro id
... ... @@ -1,1 +1,1 @@
1 -apimacro
1 +showhide
Macro name
... ... @@ -1,1 +1,1 @@
1 -APIMacro
1 +showhide
XWiki.WikiMacroParameterClass[3]
Parameter default value
... ... @@ -1,1 +1,1 @@
1 -slide
1 +toggle
XWiki.WikiMacroParameterClass[7]
Parameter mandatory
... ... @@ -1,1 +1,0 @@
1 -No
Parameter name
... ... @@ -1,1 +1,0 @@
1 -title
XWiki.WikiMacroParameterClass[0]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +Ausklappen
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Show Message
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +showmessage
XWiki.WikiMacroParameterClass[1]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +Einklappen
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Hide Message
Parameter name
... ... @@ -1,0 +1,1 @@
1 +hidemessage
XWiki.WikiMacroParameterClass[6]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +DIV style
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +style
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community