Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 24.2
edited by jklein
on 2025/06/02 13:50
Change comment: There is no comment for this version
To version 18.5
edited by jklein
on 2025/06/02 13:43
Change comment: Update document after refactoring.

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,79 @@
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  
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
... ... @@ -4,21 +4,23 @@
4 4   content = header.next('.showhidecontent'),
5 5   effect = header.attr('data-show-effect'),
6 6   duration = parseInt(header.attr('data-show-duration')) || 300,
7 - arrow = header.find('.showhide-arrow');
7 + iconEl = header.find('.showhide-icon');
8 8  
9 + // Sicherheitsprüfung für Effekt
9 9   if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
10 10   effect = 'toggle';
11 11   }
12 12  
14 + // Sichtbarkeitsstatus
13 13   var isVisible = content.is(':visible');
14 14   var newState = !isVisible;
15 15  
16 - // Pfeil wechseln
17 - if (arrow.length) {
18 - arrow.text(newState ? '▼' : '►');
19 - }
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);
20 20  
21 - // Inhalt ein-/ausklappen
23 + // Inhalt ein-/ausblenden
22 22   content.stop()[effect](duration);
23 23   }
24 24  
Name
... ... @@ -1,1 +1,0 @@
1 -APIMacro Script
XWiki.StyleSheetExtension[0]
Code
... ... @@ -2,9 +2,8 @@
2 2   border: 1px solid #ccc;
3 3   background-color: #f7f7f7;
4 4   border-radius: 4px 4px 0 0;
5 - padding: 10px 12px;
6 - cursor: pointer;
7 - user-select: none;
5 + padding: 8px 12px;
6 + margin-bottom: 0;
8 8  }
9 9  
10 10  .showhide-header-flex {
... ... @@ -11,20 +11,45 @@
11 11   display: flex;
12 12   justify-content: space-between;
13 13   align-items: center;
13 + padding: 6px 0px;
14 + 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;
22 +.showhidebutton a {
23 + text-decoration: none;
24 + cursor: pointer;
25 + font-weight: normal;
29 29  }
30 30  
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 +}
Name
... ... @@ -1,1 +1,1 @@
1 -APIMacro Style
1 +ShowHideMacro Style
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -24,10 +24,12 @@
24 24  <div class="showhide-header"
25 25   #if($id && $id!="") id="showhideheader${id}" #end
26 26   data-show-duration="$effectduration"
27 - data-show-effect="$effect">
27 + data-show-effect="$effect"
28 + data-show-message="$showmessage"
29 + data-hide-message="$hidemessage">
28 28   <div class="showhide-header-flex">
29 29   <div class="showhide-title">$title</div>
30 - <div class="showhide-arrow">►</div>
32 + <div class="showhide-icon">►</div>
31 31   </div>
32 32  </div>
33 33  {{/html}}
Macro id
... ... @@ -1,1 +1,1 @@
1 -apimacro
1 +showhide
Macro name
... ... @@ -1,1 +1,1 @@
1 -APIMacro
1 +showhide
XWiki.WikiMacroParameterClass[0]
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 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