Changes for page APIMacro

Summary

• Page properties (3 modified, 0 added, 0 removed)
• Objects (3 modified, 3 added, 0 removed)
  • XWiki.JavaScriptExtension[0]
  • XWiki.StyleSheetExtension[0]
  • XWiki.WikiMacroClass[0]
  • XWiki.WikiMacroParameterClass[0]
  • XWiki.WikiMacroParameterClass[1]
  • XWiki.WikiMacroParameterClass[6]

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-APIMacro
	1	+Show Hide Macro

Parent

...	...	@@ -1,1 +1,1 @@
1		-WebHome
	1	+Macros.WebHome

Content

...	...	@@ -1,7 +1,76 @@
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
4		-Code
	6	+{{showhide title="PublicAPI" effect="slide" effectduration="0.5"}}
	7	+Inhalt
	8	+Inhalt
	9	+Inhalt
	10	+{{/showhide}}
5	5
6		-Code
7		-{{/apimacro}}
	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}}

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,0 @@
1		-APIMacro

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,25 +11,34 @@
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		- display: inline-block;
24		- transition: transform 0.3s ease;
25		- transform: rotate(0deg);
26		- font-size: 16px;
27		- color: #0645ad;
	22	+.showhidebutton a {
	23	+ text-decoration: none;
	24	+ cursor: pointer;
	25	+ font-weight: normal;
28	28	}
29	29
30		-/* Wenn Container 'open' ist → Pfeil dreht sich */
31		-.showhide-header.open .showhide-arrow {
32		- 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;
33	33	}
34	34
	36	+.showhide-header:hover {
	37	+ background-color: #f0f0f0;
	38	+ cursor: default;
	39	+}
35	35
	41	+.showhidebutton a:hover {
	42	+ text-decoration: underline;
	43	+}

Name

...	...	@@ -1,1 +1,1 @@
1		-APIMacro Style
	1	+ShowHideMacro Style

Use this extension

...	...	@@ -1,1 +1,1 @@
1		-always
	1	+currentPage

XWiki.WikiMacroClass[0]

Macro code

...	...	@@ -24,15 +24,15 @@
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">&#9654;</div> ## Unicode ▶
	32	+ <div class="showhide-icon">► $showmessage</div>
31	31	</div>
32	32	</div>
33	33	{{/html}}
34		-</div>
35		-{{/html}}
36	36	(% class="showhidecontent" #if($id && $id!="")id="showhidecontent${id}" #end#if($xcontext.action != 'edit') style="display: none;"#end %)
37	37	(((
38	38	(((

Macro id

...	...	@@ -1,1 +1,1 @@
1		-apimacro
	1	+showhide

Macro name

...	...	@@ -1,1 +1,1 @@
1		-APIMacro
	1	+showhide

XWiki.WikiMacroParameterClass[0]

Parameter default value

...	...	@@ -1,0 +1,1 @@
	1	+Ausklappen

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 default value

...	...	@@ -1,0 +1,1 @@
	1	+Einklappen

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