Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 9.9
edited by jklein
on 2025/06/02 09:58
Change comment: There is no comment for this version
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,76 +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 -{{showhide title="PublicAPI" effect="slide" effectduration="0.5"}}
7 -Inhalt
8 -Inhalt
9 -Inhalt
10 -{{/showhide}}
4 +Code
11 11  
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}}
6 +Code
7 +{{/apimacro}}
XWiki.JavaScriptExtension[0]
Code
... ... @@ -1,26 +1,31 @@
1 1  require(['jquery'], function($) {
2 - function onClick () {
3 - var button = $(this),
4 - content = button.closest('.showhide-header').next('.showhidecontent'),
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 + iconEl = header.find('.showhide-icon');
7 7  
8 - if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) == -1)
9 + // Sicherheitsprüfung für Effekt
10 + if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
9 9   effect = 'toggle';
12 + }
10 10  
11 - data.showHideState = !(('showHideState' in data) ? data.showHideState : content.is(':visible'));
14 + // Sichtbarkeitsstatus
15 + var isVisible = content.is(':visible');
16 + var newState = !isVisible;
12 12  
13 - var message = button.attr(data.showHideState ? 'data-hide-message' : 'data-show-message');
14 - var icon = data.showHideState ? '▼ ' : '► ';
15 - button.html(icon + message);
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);
16 16  
17 - content.stop()[effect](parseInt(button.attr('data-show-duration')));
18 -
19 - return false;
23 + // Inhalt ein-/ausblenden
24 + content.stop()[effect](duration);
20 20   }
21 21  
22 - $(document).ready(function() {
23 - $('.showhide-header).on('click', onClick);
27 + $(document).ready(function () {
28 + $('.showhide-header').on('click', onClickHeader);
24 24   });
25 25  });
26 26  
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro Script
XWiki.StyleSheetExtension[0]
Code
... ... @@ -41,3 +41,14 @@
41 41  .showhidebutton a:hover {
42 42   text-decoration: underline;
43 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 -ShowHideMacro Style
1 +APIMacro Style
Use this extension
... ... @@ -1,1 +1,1 @@
1 -currentPage
1 +always
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -24,12 +24,10 @@
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"
28 - data-show-message="$showmessage"
29 - data-hide-message="$hidemessage">
27 + data-show-effect="$effect">
30 30   <div class="showhide-header-flex">
31 31   <div class="showhide-title">$title</div>
32 - <div class="showhide-icon">► $showmessage</div>
30 + <div class="showhide-arrow">►</div>
33 33   </div>
34 34  </div>
35 35  {{/html}}
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[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
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community