leaflet-burgermenu 0.1.0
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/.vscode/settings.json +8 -0
- package/LICENSE +21 -0
- package/dist/leaflet-burgermenu.css +54 -0
- package/dist/leaflet-burgermenu.umd.js +76 -0
- package/dist/leaflet-burgermenu.umd.js.map +1 -0
- package/dist/leaflet-burgermenu.umd.min.js +2 -0
- package/dist/leaflet-burgermenu.umd.min.js.map +1 -0
- package/examples/example.umd.html +73 -0
- package/package.json +28 -0
- package/readme.md +102 -0
- package/rollup.config.js +28 -0
- package/src/leaflet-burgermenu.js +66 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Benjamin W. Portner
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/* Base menu container */
|
|
2
|
+
.leaflet-control-burgermenu {
|
|
3
|
+
position: relative;
|
|
4
|
+
font-family: sans-serif;
|
|
5
|
+
user-select: none;
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
/* Menu toggle button */
|
|
9
|
+
.burger-button {
|
|
10
|
+
background: white;
|
|
11
|
+
cursor: pointer;
|
|
12
|
+
font-size: 22px;
|
|
13
|
+
padding: 5px;
|
|
14
|
+
display: inline-block;
|
|
15
|
+
border: 2px solid #ccc;
|
|
16
|
+
border-radius: 3px;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/* Hide elements */
|
|
20
|
+
.hidden {
|
|
21
|
+
display: none;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/* Menu items */
|
|
25
|
+
.burger-menu,
|
|
26
|
+
.burger-menu-item {
|
|
27
|
+
background: white;
|
|
28
|
+
cursor: pointer;
|
|
29
|
+
white-space: nowrap;
|
|
30
|
+
position: relative;
|
|
31
|
+
border: 1px solid #ccc;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
.burger-menu-item {
|
|
35
|
+
padding: 5px;
|
|
36
|
+
}
|
|
37
|
+
.burger-menu-item:hover {
|
|
38
|
+
background-color: lightskyblue;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/* Submenu container (level > 1) */
|
|
42
|
+
[class*="level-0"]>.level-1,
|
|
43
|
+
[class*="level-1"]>.level-2,
|
|
44
|
+
[class*="level-2"]>.level-3 {
|
|
45
|
+
position: absolute;
|
|
46
|
+
top: 0;
|
|
47
|
+
left: 100%;
|
|
48
|
+
margin-left: 2px;
|
|
49
|
+
z-index: 9999;
|
|
50
|
+
background: white;
|
|
51
|
+
/* border: 1px solid #ccc; */
|
|
52
|
+
min-width: 150px;
|
|
53
|
+
box-shadow: 2px 2px 6px rgba(0, 0, 0, 0.1);
|
|
54
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
(function (global, factory) {
|
|
2
|
+
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
3
|
+
typeof define === 'function' && define.amd ? define(['exports'], factory) :
|
|
4
|
+
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["leaflet-burgermenu"] = {}));
|
|
5
|
+
})(this, (function (exports) { 'use strict';
|
|
6
|
+
|
|
7
|
+
// leaflet-burgermenu.js
|
|
8
|
+
// A Leaflet plugin that adds a burger menu with submenus
|
|
9
|
+
// Author: Benjamin W. Portner
|
|
10
|
+
// License: MIT
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class BurgerMenuControl extends L.Control {
|
|
14
|
+
|
|
15
|
+
constructor(options) {
|
|
16
|
+
const defaultOptions = {
|
|
17
|
+
position: 'topleft',
|
|
18
|
+
menuIcon: '☰', // Burger icon
|
|
19
|
+
subMenuIndicator: '⊳',
|
|
20
|
+
title: 'Menu',
|
|
21
|
+
menuItems: [] // [{ title: 'Main', subItems: [{ title: 'Sub1', onClick: fn }, ...] }]
|
|
22
|
+
};
|
|
23
|
+
options = { ...defaultOptions, ...options };
|
|
24
|
+
super(options);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
_generateSubMenus(item, itemEl, level) {
|
|
28
|
+
if (item.menuItems && item.menuItems.length) {
|
|
29
|
+
if (level > 0) {
|
|
30
|
+
itemEl.textContent += ` ${this.options.subMenuIndicator}`;
|
|
31
|
+
}
|
|
32
|
+
const classList = `burger-menu level-${level} hidden`;
|
|
33
|
+
const subMenu = L.DomUtil.create('div', classList, itemEl);
|
|
34
|
+
L.DomEvent.on(itemEl, 'mouseover', function (e) {
|
|
35
|
+
subMenu.classList.remove('hidden');
|
|
36
|
+
});
|
|
37
|
+
L.DomEvent.on(itemEl, 'mouseout', function (e) {
|
|
38
|
+
subMenu.classList.add('hidden');
|
|
39
|
+
});
|
|
40
|
+
item.menuItems.forEach(subItem => {
|
|
41
|
+
const classList = `burger-menu-item level-${level}`;
|
|
42
|
+
const subItemEl = L.DomUtil.create('div', classList, subMenu);
|
|
43
|
+
subItemEl.textContent = subItem.title;
|
|
44
|
+
this._generateSubMenus(subItem, subItemEl, level + 1);
|
|
45
|
+
});
|
|
46
|
+
} else if (typeof item.onClick === 'function') {
|
|
47
|
+
L.DomEvent.on(itemEl, 'click', function(e) {
|
|
48
|
+
e.stopPropagation();
|
|
49
|
+
item.onClick(e);
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
onAdd(map) {
|
|
55
|
+
const container = L.DomUtil.create('div', 'leaflet-control-burgermenu');
|
|
56
|
+
L.DomEvent.disableClickPropagation(container);
|
|
57
|
+
|
|
58
|
+
const button = L.DomUtil.create('div', 'burger-button', container);
|
|
59
|
+
button.innerHTML = this.options.menuIcon;
|
|
60
|
+
button.title = this.options.title;
|
|
61
|
+
|
|
62
|
+
this._generateSubMenus(this.options, container, 0);
|
|
63
|
+
|
|
64
|
+
return container;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
L.Control.BurgerMenu = BurgerMenuControl;
|
|
68
|
+
|
|
69
|
+
L.control.burgerMenu = function (options) {
|
|
70
|
+
return new L.Control.BurgerMenu(options);
|
|
71
|
+
};
|
|
72
|
+
|
|
73
|
+
exports.BurgerMenuControl = BurgerMenuControl;
|
|
74
|
+
|
|
75
|
+
}));
|
|
76
|
+
//# sourceMappingURL=leaflet-burgermenu.umd.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"leaflet-burgermenu.umd.js","sources":["../src/leaflet-burgermenu.js"],"sourcesContent":["// leaflet-burgermenu.js\r\n// A Leaflet plugin that adds a burger menu with submenus\r\n// Author: Benjamin W. Portner\r\n// License: MIT\r\n\r\n\r\nexport class BurgerMenuControl extends L.Control {\r\n\r\n constructor(options) {\r\n const defaultOptions = {\r\n position: 'topleft',\r\n menuIcon: '☰', // Burger icon\r\n subMenuIndicator: '⊳',\r\n title: 'Menu',\r\n menuItems: [] // [{ title: 'Main', subItems: [{ title: 'Sub1', onClick: fn }, ...] }]\r\n };\r\n options = { ...defaultOptions, ...options };\r\n super(options);\r\n }\r\n\r\n _generateSubMenus(item, itemEl, level) {\r\n if (item.menuItems && item.menuItems.length) {\r\n if (level > 0) {\r\n itemEl.textContent += ` ${this.options.subMenuIndicator}`;\r\n }\r\n const classList = `burger-menu level-${level} hidden`;\r\n const subMenu = L.DomUtil.create('div', classList, itemEl);\r\n L.DomEvent.on(itemEl, 'mouseover', function (e) {\r\n subMenu.classList.remove('hidden');\r\n });\r\n L.DomEvent.on(itemEl, 'mouseout', function (e) {\r\n subMenu.classList.add('hidden');\r\n });\r\n item.menuItems.forEach(subItem => {\r\n const classList = `burger-menu-item level-${level}`;\r\n const subItemEl = L.DomUtil.create('div', classList, subMenu);\r\n subItemEl.textContent = subItem.title;\r\n this._generateSubMenus(subItem, subItemEl, level + 1);\r\n });\r\n } else if (typeof item.onClick === 'function') {\r\n L.DomEvent.on(itemEl, 'click', function(e) {\r\n e.stopPropagation();\r\n item.onClick(e);\r\n });\r\n }\r\n }\r\n\r\n onAdd(map) {\r\n const container = L.DomUtil.create('div', 'leaflet-control-burgermenu');\r\n L.DomEvent.disableClickPropagation(container);\r\n\r\n const button = L.DomUtil.create('div', 'burger-button', container);\r\n button.innerHTML = this.options.menuIcon;\r\n button.title = this.options.title;\r\n\r\n this._generateSubMenus(this.options, container, 0);\r\n\r\n return container;\r\n }\r\n};\r\n\r\nL.Control.BurgerMenu = BurgerMenuControl;\r\n\r\nL.control.burgerMenu = function (options) {\r\n return new L.Control.BurgerMenu(options);\r\n};\r\n"],"names":[],"mappings":";;;;;;IAAA;IACA;IACA;IACA;AACA;AACA;IACO,MAAM,iBAAiB,SAAS,CAAC,CAAC,OAAO,CAAC;AACjD;IACA,IAAI,WAAW,CAAC,OAAO,EAAE;IACzB,QAAQ,MAAM,cAAc,GAAG;IAC/B,YAAY,QAAQ,EAAE,SAAS;IAC/B,YAAY,QAAQ,EAAE,SAAS;IAC/B,YAAY,gBAAgB,EAAE,GAAG;IACjC,YAAY,KAAK,EAAE,MAAM;IACzB,YAAY,SAAS,EAAE,EAAE;IACzB,SAAS,CAAC;IACV,QAAQ,OAAO,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE,CAAC;IACpD,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,KAAK;AACL;IACA,IAAI,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;IAC3C,QAAQ,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;IACrD,YAAY,IAAI,KAAK,GAAG,CAAC,EAAE;IAC3B,gBAAgB,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC1E,aAAa;IACb,YAAY,MAAM,SAAS,GAAG,CAAC,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAClE,YAAY,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACvE,YAAY,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE;IAC5D,gBAAgB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnD,aAAa,CAAC,CAAC;IACf,YAAY,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE;IAC3D,gBAAgB,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAChD,aAAa,CAAC,CAAC;IACf,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,IAAI;IAC9C,gBAAgB,MAAM,SAAS,GAAG,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC,CAAC;IACpE,gBAAgB,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,gBAAgB,SAAS,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC;IACtD,gBAAgB,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACtE,aAAa,CAAC,CAAC;IACf,SAAS,MAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;IACvD,YAAY,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE;IACvD,gBAAgB,CAAC,CAAC,eAAe,EAAE,CAAC;IACpC,gBAAgB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChC,aAAa,CAAC,CAAC;IACf,SAAS;IACT,KAAK;AACL;IACA,IAAI,KAAK,CAAC,GAAG,EAAE;IACf,QAAQ,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAC;IAChF,QAAQ,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AACtD;IACA,QAAQ,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IAC3E,QAAQ,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjD,QAAQ,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;AAC1C;IACA,QAAQ,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AAC3D;IACA,QAAQ,OAAO,SAAS,CAAC;IACzB,KAAK;IACL,CACA;IACA,CAAC,CAAC,OAAO,CAAC,UAAU,GAAG,iBAAiB,CAAC;AACzC;IACA,CAAC,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,OAAO,EAAE;IAC1C,IAAI,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;;;;;;;;"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["leaflet-burgermenu"]={})}(this,(function(e){"use strict";class t extends L.Control{constructor(e){super(e={position:"topleft",menuIcon:"☰",subMenuIndicator:"⊳",title:"Menu",menuItems:[],...e})}_generateSubMenus(e,t,n){if(e.menuItems&&e.menuItems.length){n>0&&(t.textContent+=` ${this.options.subMenuIndicator}`);const o=`burger-menu level-${n} hidden`,i=L.DomUtil.create("div",o,t);L.DomEvent.on(t,"mouseover",(function(e){i.classList.remove("hidden")})),L.DomEvent.on(t,"mouseout",(function(e){i.classList.add("hidden")})),e.menuItems.forEach((e=>{const t=`burger-menu-item level-${n}`,o=L.DomUtil.create("div",t,i);o.textContent=e.title,this._generateSubMenus(e,o,n+1)}))}else"function"==typeof e.onClick&&L.DomEvent.on(t,"click",(function(t){t.stopPropagation(),e.onClick(t)}))}onAdd(e){const t=L.DomUtil.create("div","leaflet-control-burgermenu");L.DomEvent.disableClickPropagation(t);const n=L.DomUtil.create("div","burger-button",t);return n.innerHTML=this.options.menuIcon,n.title=this.options.title,this._generateSubMenus(this.options,t,0),t}}L.Control.BurgerMenu=t,L.control.burgerMenu=function(e){return new L.Control.BurgerMenu(e)},e.BurgerMenuControl=t}));
|
|
2
|
+
//# sourceMappingURL=leaflet-burgermenu.umd.min.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"leaflet-burgermenu.umd.min.js","sources":["../src/leaflet-burgermenu.js"],"sourcesContent":["// leaflet-burgermenu.js\r\n// A Leaflet plugin that adds a burger menu with submenus\r\n// Author: Benjamin W. Portner\r\n// License: MIT\r\n\r\n\r\nexport class BurgerMenuControl extends L.Control {\r\n\r\n constructor(options) {\r\n const defaultOptions = {\r\n position: 'topleft',\r\n menuIcon: '☰', // Burger icon\r\n subMenuIndicator: '⊳',\r\n title: 'Menu',\r\n menuItems: [] // [{ title: 'Main', subItems: [{ title: 'Sub1', onClick: fn }, ...] }]\r\n };\r\n options = { ...defaultOptions, ...options };\r\n super(options);\r\n }\r\n\r\n _generateSubMenus(item, itemEl, level) {\r\n if (item.menuItems && item.menuItems.length) {\r\n if (level > 0) {\r\n itemEl.textContent += ` ${this.options.subMenuIndicator}`;\r\n }\r\n const classList = `burger-menu level-${level} hidden`;\r\n const subMenu = L.DomUtil.create('div', classList, itemEl);\r\n L.DomEvent.on(itemEl, 'mouseover', function (e) {\r\n subMenu.classList.remove('hidden');\r\n });\r\n L.DomEvent.on(itemEl, 'mouseout', function (e) {\r\n subMenu.classList.add('hidden');\r\n });\r\n item.menuItems.forEach(subItem => {\r\n const classList = `burger-menu-item level-${level}`;\r\n const subItemEl = L.DomUtil.create('div', classList, subMenu);\r\n subItemEl.textContent = subItem.title;\r\n this._generateSubMenus(subItem, subItemEl, level + 1);\r\n });\r\n } else if (typeof item.onClick === 'function') {\r\n L.DomEvent.on(itemEl, 'click', function(e) {\r\n e.stopPropagation();\r\n item.onClick(e);\r\n });\r\n }\r\n }\r\n\r\n onAdd(map) {\r\n const container = L.DomUtil.create('div', 'leaflet-control-burgermenu');\r\n L.DomEvent.disableClickPropagation(container);\r\n\r\n const button = L.DomUtil.create('div', 'burger-button', container);\r\n button.innerHTML = this.options.menuIcon;\r\n button.title = this.options.title;\r\n\r\n this._generateSubMenus(this.options, container, 0);\r\n\r\n return container;\r\n }\r\n};\r\n\r\nL.Control.BurgerMenu = BurgerMenuControl;\r\n\r\nL.control.burgerMenu = function (options) {\r\n return new L.Control.BurgerMenu(options);\r\n};\r\n"],"names":["BurgerMenuControl","L","Control","constructor","options","super","position","menuIcon","subMenuIndicator","title","menuItems","_generateSubMenus","item","itemEl","level","length","textContent","this","classList","subMenu","DomUtil","create","DomEvent","on","e","remove","add","forEach","subItem","subItemEl","onClick","stopPropagation","onAdd","map","container","disableClickPropagation","button","innerHTML","BurgerMenu","control","burgerMenu"],"mappings":"6PAMO,MAAMA,UAA0BC,EAAEC,QAErC,WAAAC,CAAYC,GASRC,MADAD,EAAU,CANNE,SAAU,UACVC,SAAU,UACVC,iBAAkB,IAClBC,MAAO,OACPC,UAAW,MAEmBN,GAErC,CAED,iBAAAO,CAAkBC,EAAMC,EAAQC,GAC5B,GAAIF,EAAKF,WAAaE,EAAKF,UAAUK,OAAQ,CACrCD,EAAQ,IACRD,EAAOG,aAAe,IAAIC,KAAKb,QAAQI,oBAE3C,MAAMU,EAAY,qBAAqBJ,WACjCK,EAAUlB,EAAEmB,QAAQC,OAAO,MAAOH,EAAWL,GACnDZ,EAAEqB,SAASC,GAAGV,EAAQ,aAAa,SAAUW,GACzCL,EAAQD,UAAUO,OAAO,SACzC,IACYxB,EAAEqB,SAASC,GAAGV,EAAQ,YAAY,SAAUW,GACxCL,EAAQD,UAAUQ,IAAI,SACtC,IACYd,EAAKF,UAAUiB,SAAQC,IACnB,MAAMV,EAAY,0BAA0BJ,IACtCe,EAAY5B,EAAEmB,QAAQC,OAAO,MAAOH,EAAWC,GACrDU,EAAUb,YAAcY,EAAQnB,MAChCQ,KAAKN,kBAAkBiB,EAASC,EAAWf,EAAQ,EAAE,GAE5D,KAAkC,mBAAjBF,EAAKkB,SACnB7B,EAAEqB,SAASC,GAAGV,EAAQ,SAAS,SAASW,GACpCA,EAAEO,kBACFnB,EAAKkB,QAAQN,EAC7B,GAEK,CAED,KAAAQ,CAAMC,GACF,MAAMC,EAAYjC,EAAEmB,QAAQC,OAAO,MAAO,8BAC1CpB,EAAEqB,SAASa,wBAAwBD,GAEnC,MAAME,EAASnC,EAAEmB,QAAQC,OAAO,MAAO,gBAAiBa,GAMxD,OALAE,EAAOC,UAAYpB,KAAKb,QAAQG,SAChC6B,EAAO3B,MAAQQ,KAAKb,QAAQK,MAE5BQ,KAAKN,kBAAkBM,KAAKb,QAAS8B,EAAW,GAEzCA,CACV,EAGLjC,EAAEC,QAAQoC,WAAatC,EAEvBC,EAAEsC,QAAQC,WAAa,SAAUpC,GAC7B,OAAO,IAAIH,EAAEC,QAAQoC,WAAWlC,EACpC"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8" />
|
|
6
|
+
<title>Leaflet Burgermenu UMD Demo</title>
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
8
|
+
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" />
|
|
9
|
+
<link rel="stylesheet" href="../dist/leaflet-burgermenu.css" />
|
|
10
|
+
<style>
|
|
11
|
+
html,
|
|
12
|
+
body,
|
|
13
|
+
#map {
|
|
14
|
+
height: 100%;
|
|
15
|
+
margin: 0;
|
|
16
|
+
}
|
|
17
|
+
</style>
|
|
18
|
+
</head>
|
|
19
|
+
|
|
20
|
+
<body>
|
|
21
|
+
<div id="map"></div>
|
|
22
|
+
<script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"></script>
|
|
23
|
+
<script src="../dist/leaflet-burgermenu.umd.js"></script>
|
|
24
|
+
<script>
|
|
25
|
+
const map = L.map('map').setView([52.5200, 13.4050], 12);
|
|
26
|
+
|
|
27
|
+
L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
|
|
28
|
+
attribution: '© OpenStreetMap contributors'
|
|
29
|
+
}).addTo(map);
|
|
30
|
+
|
|
31
|
+
L.control.burgerMenu({
|
|
32
|
+
title: 'main',
|
|
33
|
+
menuItems: [
|
|
34
|
+
{
|
|
35
|
+
title: 'level 0 item 1',
|
|
36
|
+
onClick: () => { alert('You clicked level 0 item 1.'); },
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
title: 'level 0 submenu',
|
|
40
|
+
menuItems: [
|
|
41
|
+
{
|
|
42
|
+
title: 'level 1 item 1',
|
|
43
|
+
onClick: () => { alert('You clicked level 1 item 1.'); },
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
title: 'level 1 submenu',
|
|
47
|
+
menuItems: [
|
|
48
|
+
{
|
|
49
|
+
title: 'level 2 item 1',
|
|
50
|
+
onClick: () => { alert('You clicked level 2 item 1.'); },
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
title: 'level 2 item 2',
|
|
54
|
+
onClick: () => { alert('You clicked level 2 item 2.'); },
|
|
55
|
+
}
|
|
56
|
+
]
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
title: 'level 1 item 2',
|
|
60
|
+
onClick: () => { alert('You clicked level 1 item 2.'); },
|
|
61
|
+
}
|
|
62
|
+
]
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
title: 'level 0 item 2',
|
|
66
|
+
onClick: () => { alert('You clicked level 0 item 2.'); },
|
|
67
|
+
},
|
|
68
|
+
]
|
|
69
|
+
}).addTo(map);
|
|
70
|
+
</script>
|
|
71
|
+
</body>
|
|
72
|
+
|
|
73
|
+
</html>
|
package/package.json
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "leaflet-burgermenu",
|
|
3
|
+
"author": "Benjamin W. Portner",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"homepage": "https://github.com/BenPortner/leaflet-burgermenu",
|
|
6
|
+
"version": "0.1.0",
|
|
7
|
+
"description": "A Leaflet plugin that adds a burger menu with submenus",
|
|
8
|
+
"browser": true,
|
|
9
|
+
"scripts": {
|
|
10
|
+
"build": "rollup -c",
|
|
11
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"leaflet",
|
|
15
|
+
"menu"
|
|
16
|
+
],
|
|
17
|
+
"dependencies": {
|
|
18
|
+
"leaflet": "^1.9.4"
|
|
19
|
+
},
|
|
20
|
+
"devDependencies": {
|
|
21
|
+
"@rollup/plugin-terser": "^0.4.4",
|
|
22
|
+
"rollup": "^4.37.0"
|
|
23
|
+
},
|
|
24
|
+
"repository": {
|
|
25
|
+
"type": "git",
|
|
26
|
+
"url": "git+https://github.com/BenPortner/leaflet-burgermenu.git"
|
|
27
|
+
}
|
|
28
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# 🍔 Leaflet Burgermenu Plugin
|
|
2
|
+
|
|
3
|
+
A lightweight [Leaflet](https://leafletjs.com/) plugin that adds a burger menu with nested submenus to the map interface.
|
|
4
|
+
Hovering over menu items reveals submenus, and clicking items can trigger custom actions.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 📦 Features
|
|
9
|
+
|
|
10
|
+
- Adds a burger menu control to the Leaflet map
|
|
11
|
+
- Supports nested submenus
|
|
12
|
+
- Hover to open submenus
|
|
13
|
+
- Define custom click handlers for menu items
|
|
14
|
+
- Easily style with [CSS](dist/leaflet-burgermenu.css)
|
|
15
|
+
|
|
16
|
+
### 💡 Notes
|
|
17
|
+
|
|
18
|
+
- Submenus open on **hover**
|
|
19
|
+
- Click actions only work on **leaf** menu items (with `onClick`)
|
|
20
|
+
- Deeply nested menus work, but may need CSS adjustments
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 🧪 Usage
|
|
25
|
+
|
|
26
|
+
1. Include `leaflet` stylesheet in your HTML:
|
|
27
|
+
```html
|
|
28
|
+
<link
|
|
29
|
+
rel="stylesheet"
|
|
30
|
+
href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css"
|
|
31
|
+
/>
|
|
32
|
+
```
|
|
33
|
+
2. Include `leaflet-burgermenu` stylesheet:
|
|
34
|
+
```html
|
|
35
|
+
<link
|
|
36
|
+
rel="stylesheet"
|
|
37
|
+
href="https://unpkg.com/leaflet-burgermenu@latest/dist/leaflet.css"
|
|
38
|
+
/>
|
|
39
|
+
```
|
|
40
|
+
3. Include `leaflet` Javascript:
|
|
41
|
+
```html
|
|
42
|
+
<script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"></script>
|
|
43
|
+
```
|
|
44
|
+
4. Include `leaflet-burgermenu.js`:
|
|
45
|
+
```html
|
|
46
|
+
<script src="https://unpkg.com/leaflet-burgermenu@latest/dist/leaflet-burgermenu.umd.min.js"></script>
|
|
47
|
+
```
|
|
48
|
+
5. Add the Burger Menu Control:
|
|
49
|
+
```js
|
|
50
|
+
L.control.burgerMenu({
|
|
51
|
+
title: "main",
|
|
52
|
+
menuItems: [
|
|
53
|
+
{
|
|
54
|
+
title: "level 0 item 1",
|
|
55
|
+
onClick: () => {
|
|
56
|
+
alert("You clicked level 0 item 1.");
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
title: "level 0 submenu",
|
|
61
|
+
menuItems: [
|
|
62
|
+
{
|
|
63
|
+
title: "level 1 item 1",
|
|
64
|
+
onClick: () => {
|
|
65
|
+
alert("You clicked level 1 item 1.");
|
|
66
|
+
},
|
|
67
|
+
},
|
|
68
|
+
],
|
|
69
|
+
},
|
|
70
|
+
],
|
|
71
|
+
}).addTo(map);
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## 🧩 Options
|
|
77
|
+
|
|
78
|
+
| Option | Type | Default | Description |
|
|
79
|
+
|--------------------|------------|-------------|--------------------------------------------|
|
|
80
|
+
| `position` | `string` | `'topleft'` | Leaflet control position |
|
|
81
|
+
| `menuIcon` | `string` | `'≡'` | Icon for the burger button |
|
|
82
|
+
| `subMenuIndicator` | `string` | `'⊳'` | Submenu indicator |
|
|
83
|
+
| `title` | `string` | `'Menu'` | Tooltip/title for the burger button |
|
|
84
|
+
| `menuItems` | `array` | `[]` | (Nested) array of menu items |
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 📁 Menu Structure
|
|
89
|
+
|
|
90
|
+
Menu items are passed in as an array. Each item can have:
|
|
91
|
+
|
|
92
|
+
- `title`: **required** string
|
|
93
|
+
- `onClick`: function to call on click (optional)
|
|
94
|
+
- `menuItems`: array of **sub-items** (optional)
|
|
95
|
+
|
|
96
|
+
Supports infinite nesting (though typically 2–3 levels deep is ideal).
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 📜 License
|
|
101
|
+
|
|
102
|
+
MIT © Benjamin W. Portner
|
package/rollup.config.js
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import terser from '@rollup/plugin-terser';
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
input: 'src/leaflet-burgermenu.js',
|
|
5
|
+
output: [
|
|
6
|
+
{
|
|
7
|
+
file: 'dist/leaflet-burgermenu.umd.js',
|
|
8
|
+
format: 'umd',
|
|
9
|
+
name: 'leaflet-burgermenu',
|
|
10
|
+
sourcemap: true,
|
|
11
|
+
globals: {
|
|
12
|
+
leaflet: 'L'
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
file: 'dist/leaflet-burgermenu.umd.min.js',
|
|
17
|
+
format: 'umd',
|
|
18
|
+
name: 'leaflet-burgermenu',
|
|
19
|
+
sourcemap: true,
|
|
20
|
+
globals: {
|
|
21
|
+
leaflet: 'L'
|
|
22
|
+
},
|
|
23
|
+
plugins: [
|
|
24
|
+
terser()
|
|
25
|
+
],
|
|
26
|
+
}
|
|
27
|
+
]
|
|
28
|
+
};
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
// leaflet-burgermenu.js
|
|
2
|
+
// A Leaflet plugin that adds a burger menu with submenus
|
|
3
|
+
// Author: Benjamin W. Portner
|
|
4
|
+
// License: MIT
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
export class BurgerMenuControl extends L.Control {
|
|
8
|
+
|
|
9
|
+
constructor(options) {
|
|
10
|
+
const defaultOptions = {
|
|
11
|
+
position: 'topleft',
|
|
12
|
+
menuIcon: '☰', // Burger icon
|
|
13
|
+
subMenuIndicator: '⊳',
|
|
14
|
+
title: 'Menu',
|
|
15
|
+
menuItems: [] // [{ title: 'Main', subItems: [{ title: 'Sub1', onClick: fn }, ...] }]
|
|
16
|
+
};
|
|
17
|
+
options = { ...defaultOptions, ...options };
|
|
18
|
+
super(options);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
_generateSubMenus(item, itemEl, level) {
|
|
22
|
+
if (item.menuItems && item.menuItems.length) {
|
|
23
|
+
if (level > 0) {
|
|
24
|
+
itemEl.textContent += ` ${this.options.subMenuIndicator}`;
|
|
25
|
+
}
|
|
26
|
+
const classList = `burger-menu level-${level} hidden`;
|
|
27
|
+
const subMenu = L.DomUtil.create('div', classList, itemEl);
|
|
28
|
+
L.DomEvent.on(itemEl, 'mouseover', function (e) {
|
|
29
|
+
subMenu.classList.remove('hidden');
|
|
30
|
+
});
|
|
31
|
+
L.DomEvent.on(itemEl, 'mouseout', function (e) {
|
|
32
|
+
subMenu.classList.add('hidden');
|
|
33
|
+
});
|
|
34
|
+
item.menuItems.forEach(subItem => {
|
|
35
|
+
const classList = `burger-menu-item level-${level}`;
|
|
36
|
+
const subItemEl = L.DomUtil.create('div', classList, subMenu);
|
|
37
|
+
subItemEl.textContent = subItem.title;
|
|
38
|
+
this._generateSubMenus(subItem, subItemEl, level + 1);
|
|
39
|
+
});
|
|
40
|
+
} else if (typeof item.onClick === 'function') {
|
|
41
|
+
L.DomEvent.on(itemEl, 'click', function(e) {
|
|
42
|
+
e.stopPropagation();
|
|
43
|
+
item.onClick(e);
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
onAdd(map) {
|
|
49
|
+
const container = L.DomUtil.create('div', 'leaflet-control-burgermenu');
|
|
50
|
+
L.DomEvent.disableClickPropagation(container);
|
|
51
|
+
|
|
52
|
+
const button = L.DomUtil.create('div', 'burger-button', container);
|
|
53
|
+
button.innerHTML = this.options.menuIcon;
|
|
54
|
+
button.title = this.options.title;
|
|
55
|
+
|
|
56
|
+
this._generateSubMenus(this.options, container, 0);
|
|
57
|
+
|
|
58
|
+
return container;
|
|
59
|
+
}
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
L.Control.BurgerMenu = BurgerMenuControl;
|
|
63
|
+
|
|
64
|
+
L.control.burgerMenu = function (options) {
|
|
65
|
+
return new L.Control.BurgerMenu(options);
|
|
66
|
+
};
|