Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 31.12
edited by jklein
on 2025/06/02 14:53
Change comment: There is no comment for this version
To version 19.1
edited by jklein
on 2025/06/02 13:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,79 @@
1 -{{apimacro title="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  
6 +{{showhide title="PublicAPI" effect="slide" effectduration="0.5"}}
7 +{{code language="PowerShell"}}
8 +Hier steht neuer Code
4 4  Code
5 -
6 6  Code
7 -{{/apimacro}}
11 +Code
12 +{{/code}}
13 +{{/showhide}}
14 +
15 +{{info}}
16 +Using ##id="..."## is still supported and provide the same HTML result but it is no more needed to achieve a working animation.
17 +{{/info}}
18 +
19 +== Without effect ==
20 +
21 +{{showhide showmessage="Show" hidemessage="Hide" style="background-color: #ccc"}}
22 +Here is some hidden content that can become visible
23 +Here is some hidden content that can become visible
24 +Here is some hidden content that can become visible
25 +Here is some hidden content that can become visible
26 +{{/showhide}}
27 +
28 +{{code}}
29 +{{showhide showmessage="Show" hidemessage="Hide" style="background-color: #ccc"}}
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 +Here is some hidden content that can become visible
34 +{{/showhide}}
35 +{{/code}}
36 +
37 +== With a fade in effect ==
38 +
39 +{{showhide showmessage="Show" hidemessage="Hide" effect="fade" effectduration="2" style="background-color: #ccc"}}
40 +Here is some hidden content that can become visible
41 +Here is some hidden content that can become visible
42 +Here is some hidden content that can become visible
43 +Here is some hidden content that can become visible
44 +{{/showhide}}
45 +
46 +{{code}}
47 +{{showhide showmessage="Show" hidemessage="Hide" effect="fade" effectduration="2" style="background-color: #ccc"}}
48 +Here is some hidden content that can become visible
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 +{{/showhide}}
53 +{{/code}}
54 +
55 +{{info}}
56 +Using ##effect="appear"## is still supported and provide the same behavior
57 +{{/info}}
58 +
59 +== With a sliding down effect ==
60 +
61 +{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
62 +Here is some hidden content that can become visible
63 +Here is some hidden content that can become visible
64 +Here is some hidden content that can become visible
65 +Here is some hidden content that can become visible
66 +{{/showhide}}
67 +
68 +{{code}}
69 +{{showhide showmessage="Show" hidemessage="Hide" effect="slide" effectduration="0.5" style="background-color: #ccc"}}
70 +Here is some hidden content that can become visible
71 +Here is some hidden content that can become visible
72 +Here is some hidden content that can become visible
73 +Here is some hidden content that can become visible
74 +{{/showhide}}
75 +{{/code}}
76 +
77 +{{info}}
78 +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.
79 +{{/info}}
XWiki.JavaScriptExtension[0]
Code
... ... @@ -3,19 +3,24 @@
3 3   var header = $(this),
4 4   content = header.next('.showhidecontent'),
5 5   effect = header.attr('data-show-effect'),
6 - duration = parseInt(header.attr('data-show-duration')) || 300;
6 + duration = parseInt(header.attr('data-show-duration')) || 300,
7 + iconEl = header.find('.showhide-icon');
7 7  
9 + // Sicherheitsprüfung für Effekt
8 8   if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
9 9   effect = 'toggle';
10 10   }
11 11  
14 + // Sichtbarkeitsstatus
12 12   var isVisible = content.is(':visible');
13 13   var newState = !isVisible;
14 14  
15 - // Toggle 'open'-Klasse für Rotation
16 - header.toggleClass('open', newState);
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);
17 17  
18 - // Ein-/Ausblenden des Inhalts
23 + // Inhalt ein-/ausblenden
19 19   content.stop()[effect](duration);
20 20   }
21 21  
Name
... ... @@ -1,1 +1,1 @@
1 -APIMacro
1 +APIMacro Script
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,49 +6,54 @@
1 -.showhide-wrapper {
2 - margin: 0;
3 - overflow: hidden;
4 -}
5 -
6 6  .showhide-header {
7 7   border: 1px solid #ccc;
8 8   background-color: #f7f7f7;
9 9   border-radius: 4px 4px 0 0;
10 - padding: 10px 12px;
11 - margin: 30px 0 0;
12 - cursor: pointer;
13 - user-select: none;
5 + padding: 8px 12px;
6 + margin-bottom: 0;
14 14  }
15 15  
16 -.showhidecontent {
17 - border: 1px solid #ccc;
18 - border-top: none;
19 - border-radius: 0 0 4px 4px;
20 - padding: 10px;
21 - background-color: #fff;
22 -}
23 -
24 24  .showhide-header-flex {
25 25   display: flex;
26 26   justify-content: space-between;
27 27   align-items: center;
13 + padding: 6px 0px;
14 + font-weight: bold;
28 28  }
29 29  
30 30  .showhide-title {
31 31   flex: 1;
32 32   text-align: left;
33 - font-weight: bold;
34 34  }
35 35  
36 -.showhide-arrow {
37 - display: inline-block;
38 - transition: transform 0.3s ease;
39 - transform: rotate(0deg);
40 - font-size: 16px;
41 - color: #0645ad;
22 +.showhidebutton a {
23 + text-decoration: none;
24 + cursor: pointer;
25 + font-weight: normal;
42 42  }
43 43  
44 -/* Wenn Container 'open' ist → Pfeil dreht sich */
45 -.showhide-header.open .showhide-arrow {
46 - transform: rotate(90deg);
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;
47 47  }
48 48  
36 +.showhide-header:hover {
37 + background-color: #f0f0f0;
38 + cursor: default;
39 +}
49 49  
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 +}
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,14 +1,14 @@
1 1  {{velocity}}
2 -#set($discard = $xwiki.jsx.use("Macros.APIMacro"))
2 +#set($discard = $xwiki.jsx.use("Macros.ShowHideMacro"))
3 3  #set($mparams = $wikimacro.parameters)
4 4  #if(!$mparams)
5 5   #set($mparams = $xcontext.macro.params)
6 6  #end
7 -
8 -## Parameter vorbereiten
9 9  #if($mparams.id)
10 10   #set($id = $util.convertToAlphaNumeric($mparams.id))
11 11  #end
10 +#set($showmessage = $escapetool.xml($mparams.showmessage))
11 +#set($hidemessage = $escapetool.xml($mparams.hidemessage))
12 12  #set($divstyle = $escapetool.xml($mparams.style))
13 13  #set($effect = $escapetool.xml($mparams.effect))
14 14  #if($effect == "appear" || $effect == "fade")
... ... @@ -18,25 +18,26 @@
18 18  #end
19 19  #set($effectduration = $mathtool.mul(1000,$mparams.effectduration))
20 20  #set($title = $escapetool.xml($mparams.title))
21 -
21 +(% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
22 +(((
22 22  {{html clean=false}}
23 -<div class="showhide-wrapper" #if($divstyle && $divstyle != "") style="$divstyle" #end>
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>
31 - </div>
24 +<div class="showhide-header"
25 + #if($id && $id!="") id="showhideheader${id}" #end
26 + data-show-duration="$effectduration"
27 + data-show-effect="$effect"
28 + data-show-message="$showmessage"
29 + data-hide-message="$hidemessage">
30 + <div class="showhide-header-flex">
31 + <div class="showhide-title">$title</div>
32 + <div class="showhide-icon">►</div>
32 32   </div>
34 +</div>
33 33  {{/html}}
34 -
35 35  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
36 -(((
37 -(((
37 +(((
38 +(((
38 38  {{wikimacrocontent /}}
39 -)))
40 40  )))
41 +)))
42 +)))
41 41  {{/velocity}}
42 -
Macro description
... ... @@ -1,1 +1,1 @@
1 -Makro für PublicAPI-Commands
1 +Show/hide content with animations.
XWiki.WikiMacroParameterClass[3]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +slide
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Scriptaculous Effect
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +effect
XWiki.WikiMacroParameterClass[5]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +0
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Effect duration
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +effectduration
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community