Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07
From version 8.1
edited by jklein
on 2025/06/02 09:40
Change comment: There is no comment for this version
To version 24.1
edited by jklein
on 2025/06/02 13:49
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,29 @@
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 + arrow = header.find('.showhide-arrow');
7 7  
8 - if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) == -1)
9 + if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
9 9   effect = 'toggle';
11 + }
10 10  
11 - data.showHideState = !(('showHideState' in data) ? data.showHideState : content.is(':visible'));
13 + var isVisible = content.is(':visible');
14 + 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);
16 + // Pfeil wechseln
17 + if (arrow.length) {
18 + arrow.text(newState ? '▼' : '►');
19 + }
16 16  
17 - content.stop()[effect](parseInt(button.attr('data-show-duration')));
18 -
19 - return false;
21 + // Inhalt ein-/ausklappen
22 + content.stop()[effect](duration);
20 20   }
21 21  
22 - $(document).ready(function() {
23 - $('.showhidebutton').children('a').on('click', onClick);
25 + $(document).ready(function () {
26 + $('.showhide-header').on('click', onClickHeader);
24 24   });
25 25  });
26 26  
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro Script
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,19 +1,30 @@
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 - padding: 6px 10px;
6 - font-weight: bold;
7 7  }
8 8  
9 9  .showhide-title {
10 10   flex: 1;
11 11   text-align: left;
19 + font-weight: bold;
12 12  }
13 13  
14 -.showhidebutton a {
15 - text-decoration: none;
16 - cursor: pointer;
17 - font-weight: normal;
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;
18 18  }
19 19  
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
... ... @@ -20,24 +20,17 @@
20 20  #set($title = $escapetool.xml($mparams.title))
21 21  (% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
22 22  (((
23 -(% class="showhide-header" %)
24 -(((
25 25  {{html clean=false}}
26 -<div class="showhide-header-flex">
27 - <div class="showhide-title">$title</div>
28 - <div class="showhidebutton">
29 - <a href="javascript:void(0)"
30 - #if($id && $id!="")id="showhidebuttontext${id}" #end
31 - data-show-duration="$effectduration"
32 - data-show-effect="$effect"
33 - data-show-message="$showmessage"
34 - data-hide-message="$hidemessage">
35 - ► $showmessage
36 - </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">►</div>
37 37   </div>
38 38  </div>
39 39  {{/html}}
40 -)))
41 41  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
42 42  (((
43 43  (((
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
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community