Bootstrap Menu Editor

Remake of old Menu Editor Library (made with Typescript), works with Bootstrap 5.

Install

Via NPM

npm install @maxsoft/bootstrap_menu_editor

How to use

Imports

import '@maxsoft/bootstrap_menu_editor/lib/css/bootstrap_menu_editor.min.css';
import { MenuEditor, initializeIconPicker } from '@maxsoft/bootstrap_menu_editor';

Creating the object

HTML

<div id="element-id"></div>

Javascript

const menuEditor = new MenuEditor('element-id', { maxLevel: 3 });

Setting the Events

menuEditor.onClickDelete((event) => {
	if (confirm('Do you want to delete the item ' + event.item.getDataset().text)) {
		event.item.remove(); // remove the item
	}
});

menuEditor.onClickEdit((event) => {
	let itemData = event.item.getDataset();
	console.log(itemData);
	menuEditor.edit(event.item); // set the item in edit mode
});

menuEditor.onDragEnd((event) => {
	let output = menuEditor.getString();
	console.log(output);
	// add logic here
});

Setting the data

The data

var nestedData = [
	{
	"text": "Home",
	"href": "/home",
	"tooltip": "Go to home page",
	"icon": "fa-solid fa-house",
	"children": []
	},
	{
	"text": "About Us",
	"href": "/about",
	"tooltip": "Learn more about our company",
	"icon": "fa-solid fa-address-card",
	"children": []
	},
	{
	"text": "Services",
	"href": "/services",
	"tooltip": "Discover the services we offer",
	"icon": "fa-solid fa-gear",
	"children": [
		{
		"text": "Service 1",
		"href": "/services/1",
		"tooltip": "Details for Service 1",
		"icon": "cog",
		"children": []
		},
		{
		"text": "Service 2",
		"href": "/services/2",
		"tooltip": "Details for Service 2",
		"icon": "cog",
		"children": []
		}
	]
	}
];

The method:

menuEditor.setArray(nestedData);

Mount the menu editor

menuEditor.mount();

Add a new item

let newItem = {
    text: txtText.value, // required
    href: txtHref.value, // required
    icon: txtIcon.value, // required
    tooltip: txtTooltip.value, // required
    something: "Something" // custom attributes are optional
};
menuEditor.add(newItem);

Update an item

The menu editor must have an item in edit mode. See onClickEdit event in Events section

let data = {
	text: txtText.value,
	href: txtHref.value,
	icon: txtIcon.value,
	tooltip: txtTooltip.value,
};
menuEditor.update(data);

Output

let output = menuEditor.getString();
console.log(output);

Remove all items

menuEditor.empty();

DEV mode

Run this command

npm run dev

Add IconPicker Modal

Include HTML:

<div class="container mt-5">
  <h1>FontAwesome Icon Picker</h1>
  <div class="input-group mb-3">
    <input type="text" id="myIconInput" class="form-control" placeholder="Kliknij, aby wybrać ikonę" readonly>
    <span class="input-group-text" id="selectedIconDisplay"></span>
  </div>
</div>
<div class="modal fade" id="iconPickerPopup" tabindex="-1" aria-labelledby="iconPickerModalLabel" aria-hidden="true">
  <div class="modal-dialog modal-lg">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="iconPickerModalLabel">Select the FontAwesome icon</h5>
        <button type="button" class="btn-close" id="closePopup" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
 		<div class="mb-3">
           <input type="text" class="form-control" id="iconSearch" placeholder="Search for an icon by name...">
         </div>
        <div id="iconList" class="icon-list"></div>
      </div>
    </div>
  </div>
</div>

Technologies Used

This project is built using the following technologies and tools:

Core Technologies

• TypeScript (v5.9.2) - Programming language for type-safe JavaScript development
• Bootstrap 5 (v5.3.7) - Front-end framework for responsive UI components
• FontAwesome (v7.0.0) - Icon library and toolkit
• SortableJS (v1.15.6) - JavaScript library for drag-and-drop functionality

Build Tools & Development

• Vite (v7.1.1) - Next-generation frontend build tool and development server
• SASS (v1.90.0) - CSS preprocessor for enhanced styling capabilities
• vite-plugin-dts (v4.5.4) - Plugin for generating TypeScript declaration files

Development Dependencies

• @types/bootstrap (v5.2.10) - TypeScript type definitions for Bootstrap
• @types/node (v24.2.1) - TypeScript type definitions for Node.js
• @types/sortablejs (v1.15.8) - TypeScript type definitions for SortableJS

License

MIT License. See LICENSE for details.

Acknowledgments

• FontAwesome for the icon library.
• Bootstrap for the responsive UI framework.
• Vite for the build tool and development server.

---