@madj2k/fe-frontend-kit 2.0.25 → 2.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.js CHANGED
@@ -4,6 +4,7 @@ export { Madj2kBetterResizeEvent } from './tools/better-resize-event';
4
4
  export { Madj2kOwlThumbnail } from './tools/owl-thumbnail';
5
5
  export { Madj2kResizeEnd } from './tools/resize-end';
6
6
  export { Madj2kScrolling } from './tools/scrolling';
7
+ export { Madj2kSimpleFadeSlider } from './tools/simple-fade-slider';
7
8
  export { Madj2kToggledOverlay } from './tools/toggled-overlay';
8
9
 
9
10
  // Menus
package/index.scss CHANGED
@@ -10,4 +10,5 @@
10
10
  @forward 'tools/owl-thumbnail/index';
11
11
  @forward 'tools/resize-end/index';
12
12
  @forward 'tools/scrolling/index';
13
+ @forward 'tools/simple-fade-slider/index';
13
14
  @forward 'tools/toggled-overlay/index';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@madj2k/fe-frontend-kit",
3
- "version": "2.0.25",
3
+ "version": "2.0.26",
4
4
  "description": "Shared frontend utilities, menus and mixins for projects",
5
5
  "main": "index.js",
6
6
  "style": "index.scss",
package/readme.md CHANGED
@@ -26,6 +26,179 @@ Or import individual mixins:
26
26
  ### Menu components (JS and SCSS):
27
27
  Each menu component can be used separately.
28
28
 
29
+ ### JS components (JS and SCSS):
30
+ Each JS component can be used separately.
31
+
32
+
33
+ # Flyout-Navigation
34
+ ## Usage
35
+ Integrate the CSS- and JS-file into your project. Make sure jQuery is included.
36
+ Then init the menu with
37
+ ```
38
+ import { Madj2kFlyoutMenu } from '@madj2k/fe-frontend-kit/menus/flyout-menu';
39
+ document.querySelectorAll('.js-flyout-toggle').forEach((el) => {
40
+ new Madj2kFlyoutMenu(el, { animationDuration: 800 });
41
+ });
42
+ ```
43
+ Optional for automatically closing of the flyout menu resizing the browser window:
44
+ ```
45
+ import { Madj2kBetterResizeEvent } from '@madj2k/fe-frontend-kit/tools/better-resize-event';
46
+ document.addEventListener('madj2k-better-resize-event', () => {
47
+ document.dispatchEvent(new CustomEvent('madj2k-flyoutmenu-close'));
48
+ });
49
+ ```
50
+
51
+ CSS:
52
+ ```
53
+ @use '@madj2k/fe-frontend-kit/menus/flyout-menu' as *;
54
+ ```
55
+
56
+ ## Basic HTML
57
+ ```
58
+ <div class="siteheader" id="siteheader">
59
+
60
+ [...]
61
+
62
+ <nav>
63
+ <button class="js-flyout-toggle"
64
+ aria-label="Open menu"
65
+ aria-controls="nav-mobile"
66
+ aria-haspopup="true"
67
+ aria-expanded="false">
68
+ <span class="icon-bars"></span>
69
+ </button>
70
+ <div class="flyout js-flyout"
71
+ id="nav-mobile"
72
+ data-position-ref="siteheader">
73
+ <div class="flyout-container js-flyout-container">
74
+ <div class="nav-mobile-inner js-flyout-inner">
75
+ CONTENT HERE
76
+ </div>
77
+ </div>
78
+ </div>
79
+ </nav>
80
+ </div>
81
+ ```
82
+ IMPORTANT: If the siteheader is positioned with ```position:fixed```, you have to switch that to ```position:absolute``` when the menu is opened.
83
+ Otherwise in the opened menu the scrolling won't work.
84
+ ```
85
+ .flyout-open {
86
+ .siteheader {
87
+ position:absolute;
88
+ }
89
+ }
90
+ ```
91
+ ## Special: blur/gray effect for background
92
+ * In order to achieve a blur/gray-effect for the background we add the following DIV to the main-content section:
93
+ ```
94
+ <div class="background-blur"></div>
95
+ ```
96
+ Then we deactivate the fullHeight of the flyout menu and make the blurry background clickable
97
+ ```
98
+ import { Madj2kFlyoutdownMenu } from '@madj2k/fe-frontend-kit/menus/flyout-menu';
99
+ document.querySelectorAll('.js-flyout-toggle').forEach((el) => {
100
+ new Madj2kFlyoutMenu(el, { fullHeight: false });
101
+ });
102
+ document.querySelector('.js-background-blur').addEventListener('click', function() {
103
+ document.dispatchEvent(new CustomEvent('madj2k-flyoutmenu-close'));
104
+ });
105
+ ```
106
+ * And we need this additional CSS:
107
+ ```
108
+ /**
109
+ * background-blur for opened flyout
110
+ */
111
+ .background-blur {
112
+ position:fixed;
113
+ top:0;
114
+ left:0;
115
+ width: 100%;
116
+ height: 100%;
117
+ backdrop-filter: blur(1px) grayscale(100%);
118
+ background-color: rgba(255, 255, 255, 0.7);
119
+ transition: opacity 0.3s ease-in-out;
120
+ opacity:0;
121
+ z-index:-1;
122
+ }
123
+
124
+ .flyout-open,
125
+ .flyout-closing {
126
+ .background-blur {
127
+ z-index:90;
128
+ }
129
+ }
130
+
131
+ .flyout-open{
132
+ .background-blur {
133
+ opacity:1;
134
+ }
135
+ }
136
+
137
+
138
+ ```
139
+
140
+ # Pulldown-Navigation
141
+ ## Usage
142
+ Integrate the CSS- and JS-file into your project. Make sure jQuery is included.
143
+ Then init the menu with
144
+ ```
145
+ import { Madj2kPulldownMenu } from '@madj2k/fe-frontend-kit/menus/pulldown-menu';
146
+ document.querySelectorAll('.js-pulldown-toggle').forEach((el) => {
147
+ new Madj2kPulldownMenu(el);
148
+ });
149
+ ```
150
+ Optional for automatically closing of the flyout menu resizing the browser window:
151
+ ```
152
+ import { Madj2kBetterResizeEvent } from '@madj2k/fe-frontend-kit/tools/better-resize-event';
153
+ document.addEventListener('madj2k-better-resize-event', () => {
154
+ document.dispatchEvent(new CustomEvent('madj2k-pulldownmenu-close'));
155
+ });
156
+ ```
157
+
158
+ CSS:
159
+ ```
160
+ @use '@madj2k/fe-frontend-kit/menus/pulldown-menu' as *;
161
+ ```
162
+
163
+ ## Basic HTML
164
+ ```
165
+ <div class="siteheader">
166
+
167
+ [...]
168
+
169
+ <nav class="pulldown-wrap js-pulldown-wrap">
170
+ <button class="pulldown-toggle js-pulldown-toggle"
171
+ aria-label="Open Menu"
172
+ aria-controls="nav-language"
173
+ aria-haspopup="true"
174
+ aria-expanded="false">
175
+ <span>Menu-Item Level 1</span>
176
+ </button>
177
+
178
+ <div class="pulldown js-pulldown" id="nav-language">
179
+ <div class="pulldown-inner">
180
+ <ul>
181
+ <!-- used to have the right padding-top of the pulldown -->
182
+ <li class="pulldown-hide">
183
+ <a href="#" tabIndex="-1"><span>Menu-Item Level 1</span></a>
184
+ </li>
185
+ <li>
186
+ <a href="#"><span>Menu-Item I Level 2</span></a>
187
+ </li>
188
+ <li>
189
+ <a href="#"><span>Menu-Item II Level 2</span></a>
190
+ </li>
191
+ <li>
192
+ ...
193
+ </li>
194
+ </ul>
195
+ </div>
196
+ </div>
197
+ </nav>
198
+ </div>
199
+ ```
200
+
201
+
29
202
  # JS: Banner
30
203
  A lightweight class to show a full-page overlay (banner, popup, hint or cookie layer),
31
204
  with opening and closing animation and optional cookie persistence.
@@ -218,170 +391,36 @@ HTML:
218
391
  </div>
219
392
  ```
220
393
 
221
- # Flyout-Navigation
222
- ## Usage
223
- Integrate the CSS- and JS-file into your project. Make sure jQuery is included.
224
- Then init the menu with
225
- ```
226
- import { Madj2kFlyoutMenu } from '@madj2k/fe-frontend-kit/menus/flyout-menu';
227
- document.querySelectorAll('.js-flyout-toggle').forEach((el) => {
228
- new Madj2kFlyoutMenu(el, { animationDuration: 800 });
229
- });
230
- ```
231
- Optional for automatically closing of the flyout menu resizing the browser window:
232
- ```
233
- import { Madj2kBetterResizeEvent } from '@madj2k/fe-frontend-kit/tools/better-resize-event';
234
- document.addEventListener('madj2k-better-resize-event', () => {
235
- document.dispatchEvent(new CustomEvent('madj2k-flyoutmenu-close'));
236
- });
237
- ```
238
-
239
- CSS:
240
- ```
241
- @use '@madj2k/fe-frontend-kit/menus/flyout-menu' as *;
242
- ```
243
-
244
- ## Basic HTML
245
- ```
246
- <div class="siteheader" id="siteheader">
247
-
248
- [...]
249
-
250
- <nav>
251
- <button class="js-flyout-toggle"
252
- aria-label="Open menu"
253
- aria-controls="nav-mobile"
254
- aria-haspopup="true"
255
- aria-expanded="false">
256
- <span class="icon-bars"></span>
257
- </button>
258
- <div class="flyout js-flyout"
259
- id="nav-mobile"
260
- data-position-ref="siteheader">
261
- <div class="flyout-container js-flyout-container">
262
- <div class="nav-mobile-inner js-flyout-inner">
263
- CONTENT HERE
264
- </div>
265
- </div>
266
- </div>
267
- </nav>
268
- </div>
269
- ```
270
- IMPORTANT: If the siteheader is positioned with ```position:fixed```, you have to switch that to ```position:absolute``` when the menu is opened.
271
- Otherwise in the opened menu the scrolling won't work.
272
- ```
273
- .flyout-open {
274
- .siteheader {
275
- position:absolute;
276
- }
277
- }
278
- ```
279
- ## Special: blur/gray effect for background
280
- * In order to achieve a blur/gray-effect for the background we add the following DIV to the main-content section:
281
- ```
282
- <div class="background-blur"></div>
283
- ```
284
- Then we deactivate the fullHeight of the flyout menu and make the blurry background clickable
285
- ```
286
- import { Madj2kFlyoutdownMenu } from '@madj2k/fe-frontend-kit/menus/flyout-menu';
287
- document.querySelectorAll('.js-flyout-toggle').forEach((el) => {
288
- new Madj2kFlyoutMenu(el, { fullHeight: false });
289
- });
290
- document.querySelector('.js-background-blur').addEventListener('click', function() {
291
- document.dispatchEvent(new CustomEvent('madj2k-flyoutmenu-close'));
292
- });
293
- ```
294
- * And we need this additional CSS:
295
- ```
296
- /**
297
- * background-blur for opened flyout
298
- */
299
- .background-blur {
300
- position:fixed;
301
- top:0;
302
- left:0;
303
- width: 100%;
304
- height: 100%;
305
- backdrop-filter: blur(1px) grayscale(100%);
306
- background-color: rgba(255, 255, 255, 0.7);
307
- transition: opacity 0.3s ease-in-out;
308
- opacity:0;
309
- z-index:-1;
310
- }
311
-
312
- .flyout-open,
313
- .flyout-closing {
314
- .background-blur {
315
- z-index:90;
316
- }
317
- }
318
-
319
- .flyout-open{
320
- .background-blur {
321
- opacity:1;
322
- }
323
- }
324
-
325
-
326
- ```
394
+ # JS: Simple Fade Slider
395
+ A lightweight fade slider using opacity and z-index.
396
+ - Purely DOM based (no keyframes required)
397
+ - Automatic looping through an arbitrary number of slides
398
+ - Fully accessible with aria-hidden management
399
+ - Configurable via options
400
+ - Designed for CMS contexts with dynamic content
327
401
 
328
- # Pulldown-Navigation
329
- ## Usage
330
- Integrate the CSS- and JS-file into your project. Make sure jQuery is included.
331
- Then init the menu with
332
- ```
333
- import { Madj2kPulldownMenu } from '@madj2k/fe-frontend-kit/menus/pulldown-menu';
334
- document.querySelectorAll('.js-pulldown-toggle').forEach((el) => {
335
- new Madj2kPulldownMenu(el);
336
- });
337
- ```
338
- Optional for automatically closing of the flyout menu resizing the browser window:
402
+ Init with available options:
339
403
  ```
340
- import { Madj2kBetterResizeEvent } from '@madj2k/fe-frontend-kit/tools/better-resize-event';
341
- document.addEventListener('madj2k-better-resize-event', () => {
342
- document.dispatchEvent(new CustomEvent('madj2k-pulldownmenu-close'));
404
+ import { Madj2kSimpleFadeSlider } from '@madj2k/fe-frontend-kit/tools/simple-fade-slider';
405
+ const fadeSlider = new Madj2kSimpleFadeSlider('.js-fade-slider', {
406
+ duration: 8,
407
+ classSlide: 'fade-slider-item',
408
+ classVisible: 'is-visible',
409
+ debug: true
343
410
  });
344
411
  ```
345
412
 
346
- CSS:
347
- ```
348
- @use '@madj2k/fe-frontend-kit/menus/pulldown-menu' as *;
349
- ```
350
-
351
- ## Basic HTML
413
+ HTML:
352
414
  ```
353
- <div class="siteheader">
354
-
355
- [...]
356
-
357
- <nav class="pulldown-wrap js-pulldown-wrap">
358
- <button class="pulldown-toggle js-pulldown-toggle"
359
- aria-label="Open Menu"
360
- aria-controls="nav-language"
361
- aria-haspopup="true"
362
- aria-expanded="false">
363
- <span>Menu-Item Level 1</span>
364
- </button>
365
-
366
- <div class="pulldown js-pulldown" id="nav-language">
367
- <div class="pulldown-inner">
368
- <ul>
369
- <!-- used to have the right padding-top of the pulldown -->
370
- <li class="pulldown-hide">
371
- <a href="#" tabIndex="-1"><span>Menu-Item Level 1</span></a>
372
- </li>
373
- <li>
374
- <a href="#"><span>Menu-Item I Level 2</span></a>
375
- </li>
376
- <li>
377
- <a href="#"><span>Menu-Item II Level 2</span></a>
378
- </li>
379
- <li>
380
- ...
381
- </li>
382
- </ul>
383
- </div>
384
- </div>
385
- </nav>
386
- </div>
415
+ <section class="fade-slider js-fade-slider" aria-label="Image gallery">
416
+ <div class="fade-slider-item">
417
+ <img src="img1.jpg" alt="Description 1">
418
+ </div>
419
+ <div class="fade-slider-item">
420
+ <img src="img2.jpg" alt="Description 2">
421
+ </div>
422
+ <div class="fade-slider-item">
423
+ <img src="img3.jpg" alt="Description 3">
424
+ </div>
425
+ </section>
387
426
  ```
@@ -0,0 +1,2 @@
1
+ import Madj2kSimpleFadeSlider from './simple-fade-slider-2.0';
2
+ export { Madj2kSimpleFadeSlider };
@@ -0,0 +1 @@
1
+ @forward './simple-fade-slider-2.0';
@@ -0,0 +1,148 @@
1
+ /**
2
+ * Madj2kSimpleFadeSlider
3
+ *
4
+ * A lightweight fade slider using opacity and z-index.
5
+ * - Purely DOM based (no keyframes required)
6
+ * - Automatic looping through an arbitrary number of slides
7
+ * - Fully accessible with aria-hidden management
8
+ * - Configurable via options
9
+ * - Designed for CMS contexts with dynamic content
10
+ *
11
+ * @author Steffen Kroggel <developer@steffenkroggel.de>
12
+ * @copyright 2025 Steffen Kroggel
13
+ * @version 1.0.0
14
+ * @license GNU General Public License v3.0
15
+ * @see https://www.gnu.org/licenses/gpl-3.0.en.html
16
+ *
17
+ * @example
18
+ * // Initialize with defaults
19
+ * const slider = new Madj2kSimpleFadeSlider('.js-fade-sliderr');
20
+ *
21
+ * @example
22
+ * // Initialize with custom config
23
+ * const slider = new Madj2kSimpleFadeSlider('.js-fade-sliderr', {
24
+ * duration: 8,
25
+ * classSlide: 'fade-slider-item',
26
+ * classVisible: 'is-visible',
27
+ * debug: true
28
+ * });
29
+ *
30
+ * @example
31
+ * // Example HTML
32
+ * <section class="fade-slider js-fade-sliderr" aria-label="Image gallery">
33
+ * <div class="fade-slider-item"><img src="img1.jpg" alt="Description 1"></div>
34
+ * <div class="fade-slider-item"><img src="img2.jpg" alt="Description 2"></div>
35
+ * <div class="fade-slider-item"><img src="img3.jpg" alt="Description 3"></div>
36
+ * </section>
37
+ *
38
+ * @example
39
+ * // Example SCSS
40
+ * .fade-slider {
41
+ * position: relative;
42
+ * height: 300px;
43
+ * overflow: hidden;
44
+ * }
45
+ *
46
+ * .fade-slide, .fade-slider-item {
47
+ * position: absolute;
48
+ * inset: 0;
49
+ * opacity: 0;
50
+ * z-index: 1;
51
+ * transition: opacity 1s ease-in-out;
52
+ * }
53
+ *
54
+ * .fade-slide.is-visible, .fade-slider-item.is-visible {
55
+ * opacity: 1;
56
+ * z-index: 2;
57
+ * }
58
+ */
59
+
60
+ class Madj2kSimpleFadeSlider {
61
+ config = {
62
+ duration: 12,
63
+ classSlide: 'fade-slide',
64
+ classVisible: 'is-visible',
65
+ debug: false
66
+ };
67
+
68
+ /**
69
+ * @param {string} selector - CSS selector for the slider container
70
+ * @param {Object} config - configuration options
71
+ * @param {number} [config.duration=12] - time in seconds between slide changes
72
+ * @param {string} [config.classSlide='fade-slide'] - class for each slide
73
+ * @param {string} [config.classVisible='is-visible'] - class for visible slide
74
+ * @param {boolean} [config.debug=false] - enable debug logging
75
+ */
76
+ constructor(selector, config = {}) {
77
+ this.container = document.querySelector(selector);
78
+ if (!this.container) return;
79
+
80
+ this.config = {
81
+ ...this.config,
82
+ ...config
83
+ };
84
+
85
+ this.slides = Array.from(this.container.querySelectorAll(`.${this.config.classSlide}`));
86
+ this.total = this.slides.length;
87
+ this.current = 0;
88
+
89
+ this._log('Initialized with config:', this.config);
90
+
91
+ this.setup();
92
+ this.start();
93
+ }
94
+
95
+ /**
96
+ * Initializes all slides
97
+ * @private
98
+ */
99
+ setup() {
100
+ this.slides.forEach((slide, index) => {
101
+ slide.classList.add(this.config.classSlide);
102
+ slide.setAttribute('aria-hidden', index === 0 ? 'false' : 'true');
103
+ });
104
+ if (this.slides[0]) {
105
+ this.slides[0].classList.add(this.config.classVisible);
106
+ }
107
+ }
108
+
109
+ /**
110
+ * Starts the automatic fade loop
111
+ * @private
112
+ */
113
+ start() {
114
+ setInterval(() => this.showNext(), this.config.duration * 1000);
115
+ }
116
+
117
+ /**
118
+ * Shows the next slide
119
+ * @private
120
+ */
121
+ showNext() {
122
+ const currentSlide = this.slides[this.current];
123
+ if (currentSlide) {
124
+ currentSlide.classList.remove(this.config.classVisible);
125
+ currentSlide.setAttribute('aria-hidden', 'true');
126
+ }
127
+
128
+ this.current = (this.current + 1) % this.total;
129
+
130
+ const nextSlide = this.slides[this.current];
131
+ if (nextSlide) {
132
+ nextSlide.classList.add(this.config.classVisible);
133
+ nextSlide.setAttribute('aria-hidden', 'false');
134
+ }
135
+
136
+ this._log('Switched to slide', this.current);
137
+ }
138
+
139
+ /**
140
+ * Debug logging helper
141
+ * @private
142
+ */
143
+ _log(...args) {
144
+ if (this.config.debug) {
145
+ console.log('[Madj2kSimpleFadeSlider]', ...args);
146
+ }
147
+ }
148
+ }
@@ -0,0 +1,18 @@
1
+ .fade-slider {
2
+ position: relative;
3
+ height: 100vh;
4
+ overflow: hidden;
5
+
6
+ &-item {
7
+ position: absolute;
8
+ inset: 0;
9
+ opacity: 0;
10
+ z-index: 1;
11
+ transition: opacity 1s ease-in-out;
12
+
13
+ &.is-visible {
14
+ opacity: 1;
15
+ z-index: 2;
16
+ }
17
+ }
18
+ }