Changes for page APIMacro

Last modified by jklein on 2025/06/24 11:07

From version 17.1
edited by jklein
on 2025/06/02 12:29
Change comment: Zurück zur Version 14.4
To version 38.7
edited by jklein
on 2025/06/03 07:23
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,79 +1,15 @@
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 +{{aagon.floatingbox/}}
5 5  
6 -{{showhide title="PublicAPI" effect="slide" effectduration="0.5"}}
7 -{{code language="PowerShell"}}
8 -Hier steht neuer Code
3 +{{apimacro title="Text"}}
4 +Text
5 +Text
6 +Text
7 +{{/apimacro}}
8 +
9 +{{apimacro title="Code"}}
9 9  Code
10 -Code
11 -Code
12 -{{/code}}
13 -{{/showhide}}
11 +{{/apimacro}}
14 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}}
13 +{{apimacro title="APIMacro"}}
14 +
15 +{{/apimacro}}
XWiki.JavaScriptExtension[0]
Code
... ... @@ -3,9 +3,7 @@
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,
7 - arrowEl = header.find('.showhide-arrow'),
8 - iconEl = header.find('.showhide-icon');
6 + duration = parseInt(header.attr('data-show-duration')) || 300;
9 9  
10 10   if ($.inArray(effect, ['toggle', 'fadeToggle', 'slideToggle']) === -1) {
11 11   effect = 'toggle';
... ... @@ -14,19 +14,10 @@
14 14   var isVisible = content.is(':visible');
15 15   var newState = !isVisible;
16 16  
17 - // Pfeil aktualisieren
18 - if (arrowEl.length) {
19 - arrowEl.text(newState ? '▼' : '►');
20 - }
15 + // Toggle 'open'-Klasse für Rotation
16 + header.toggleClass('open', newState);
21 21  
22 - // Nachricht rechts aktualisieren (optional)
23 - if (iconEl.length) {
24 - var message = newState
25 - ? header.attr('data-hide-message')
26 - : header.attr('data-show-message');
27 - iconEl.text(message);
28 - }
29 -
18 + // Ein-/Ausblenden des Inhalts
30 30   content.stop()[effect](duration);
31 31   }
32 32  
Name
... ... @@ -1,0 +1,1 @@
1 +APIMacro
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,32 +1,18 @@
1 1  .showhide-header {
2 + overflow: hidden;
2 2   border: 1px solid #ccc;
3 3   background-color: #f7f7f7;
4 4   border-radius: 4px 4px 0 0;
5 - padding: 8px 12px;
6 - margin-bottom: 0;
7 -}
8 -
9 -.showhide-header-flex {
10 - display: flex;
11 - justify-content: space-between;
12 - align-items: center;
13 - padding: 6px 0px;
14 - font-weight: bold;
15 -}
16 -
17 -.showhide-title {
18 - flex: 1;
19 - text-align: left;
20 -}
21 -
22 -.showhidebutton a {
23 - text-decoration: none;
6 + margin: 6px 0 0;
7 + padding: 10px 12px;
24 24   cursor: pointer;
25 - font-weight: normal;
9 + user-select: none;
26 26  }
27 27  
28 28  .showhidecontent {
29 29   border: 1px solid #ccc;
14 + overflow: hidden;
15 + margin-bottom: 20px;
30 30   border-top: none;
31 31   border-radius: 0 0 4px 4px;
32 32   padding: 10px;
... ... @@ -33,22 +33,29 @@
33 33   background-color: #fff;
34 34  }
35 35  
36 -.showhide-header:hover {
37 - background-color: #f0f0f0;
38 - cursor: default;
22 +.showhide-header-flex {
23 + display: flex;
24 + justify-content: space-between;
25 + align-items: center;
39 39  }
40 40  
41 -.showhidebutton a:hover {
42 - text-decoration: underline;
28 +.showhide-title {
29 + flex: 1;
30 + text-align: left;
31 + font-weight: bold;
43 43  }
44 44  
45 -.showhide-icon {
46 - color: #0645ad; /* typisches Link-Blau */
47 - text-decoration: underline;
48 - cursor: pointer;
34 +.showhide-arrow {
35 + display: inline-block;
36 + transition: transform 0.3s ease;
37 + transform: rotate(0deg);
38 + font-size: 16px;
39 + color: #0645ad;
49 49  }
50 50  
51 -.showhide-header:hover .showhide-icon {
52 - text-decoration: underline;
53 - color: #0b0080; /* dunkler beim Hover */
42 +/* Wenn Container 'open' ist → Pfeil dreht sich */
43 +.showhide-header.open .showhide-arrow {
44 + transform: rotate(90deg);
54 54  }
46 +
47 +
Name
... ... @@ -1,1 +1,1 @@
1 -ShowHideMacro Style
1 +APIMacro Style
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,14 +1,14 @@
1 1  {{velocity}}
2 -#set($discard = $xwiki.jsx.use("Macros.ShowHideMacro"))
2 +#set($discard = $xwiki.jsx.use("Macros.APIMacro"))
3 3  #set($mparams = $wikimacro.parameters)
4 4  #if(!$mparams)
5 5   #set($mparams = $xcontext.macro.params)
6 6  #end
7 +
8 +## Parameter vorbereiten
7 7  #if($mparams.id)
8 8   #set($id = $util.convertToAlphaNumeric($mparams.id))
9 9  #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")
... ... @@ -17,30 +17,31 @@
17 17   #set($effect = "slideToggle")
18 18  #end
19 19  #set($effectduration = $mathtool.mul(1000,$mparams.effectduration))
20 -#set($title = $escapetool.xml($mparams.title))
21 -(% #if($divstyle && $divstyle!="") style="${divstyle}" #end %)
22 -(((
20 +#set($rawTitle = $mparams.title)
21 +#if($rawTitle && $rawTitle != "")
22 + #set($wikiSyntaxTitle = "= $rawTitle =")
23 + #set($titleRendered = $xwiki.renderText($wikiSyntaxTitle, $doc.syntaxId))
24 +#else
25 + #set($titleRendered = "")
26 +#end
27 +
23 23  {{html clean=false}}
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">
32 + data-show-effect="$effect">
30 30   <div class="showhide-header-flex">
31 - <div class="showhide-title">
32 - <span class="showhide-arrow">►</span> $title
33 - </div>
34 - <div class="showhide-icon">$showmessage</div>
34 + <div class="showhide-title">$!titleRendered</div>
35 + <div class="showhide-arrow">&#9654;</div> ## Unicode ▶
35 35   </div>
36 - </div>
37 37  </div>
38 38  {{/html}}
39 +
39 39  (% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
40 -(((
41 -(((
41 +(((
42 +(((
42 42  {{wikimacrocontent /}}
44 +)))
43 43  )))
44 -)))
45 -)))
46 46  {{/velocity}}
47 +
Macro description
... ... @@ -1,1 +1,1 @@
1 -Show/hide content with animations.
1 +Makro für PublicAPI-Commands
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,0 @@
1 -slide
Parameter description
... ... @@ -1,1 +1,0 @@
1 -Scriptaculous Effect
Parameter mandatory
... ... @@ -1,1 +1,0 @@
1 -No
Parameter name
... ... @@ -1,1 +1,0 @@
1 -effect
XWiki.WikiMacroParameterClass[5]
Parameter default value
... ... @@ -1,1 +1,0 @@
1 -0
Parameter description
... ... @@ -1,1 +1,0 @@
1 -Effect duration
Parameter mandatory
... ... @@ -1,1 +1,0 @@
1 -No
Parameter name
... ... @@ -1,1 +1,0 @@
1 -effectduration
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