======================== Odex Sidebar Backend Theme v2 ======================== Overview ======== This module provides a modern, collapsible sidebar menu system that replaces the default Odex app menu bar with an enhanced navigation experience. It delivers an improved user interface with better space management and responsive design. Features ======== * **Collapsible/Expandable Sidebar Menu**: Toggle the sidebar to maximize screen space for your work * **Smooth Navigation**: Seamlessly navigate across all Odex applications and menus * **Responsive Design**: Adapts beautifully to different screen sizes (desktop, tablet, mobile) * **Persistent State**: Sidebar collapse/expand state is saved and persists across user sessions * **Enable/Disable Toggle**: Control the sidebar feature through the Settings panel * **Optimized Performance**: Minimal performance impact with efficient menu rendering Installation ============ 1. Download or clone this module into your Odex addons directory 2. Restart the Odex server 3. Navigate to **Apps** and search for "Odex Sidebar Backend Theme 2" 4. Click **Install** Dependencies ============ This module requires: * Odex 18.0 (or compatible version) * web module * base module Configuration ============= After installation, you can configure the sidebar menu feature: 1. Navigate to **Settings > General Settings** (or **Settings > Sidebar Menu** if available) 2. Find the **Sidebar Menu** section 3. Enable or disable the sidebar menu feature as needed 4. Click **Save** The setting is automatically saved and persists across all user sessions. Usage ===== Once enabled: * Click the **menu icon** (≡) at the top of the sidebar to collapse/expand it * The sidebar state is automatically saved for your next session * All applications and menu items are accessible through the sidebar * The responsive design automatically adjusts on smaller screens Module Structure ================ :: odex_sidebar_backend_theme2/ ├── __init__.py # Python initialization ├── __manifest__.py # Module metadata ├── views/ │ └── res_config_settings.xml # Settings configuration ├── static/ │ └── src/ │ ├── scss/ │ │ └── sidebar_menu.scss # Sidebar styling │ ├── js/ │ │ ├── sidebar_menu.js # Main sidebar logic │ │ ├── sidebar_css_loader.js # CSS loading functionality │ │ ├── menu_item.js # Menu item handling │ │ └── navbar_patch.js # Navigation bar customizations │ └── xml/ │ ├── sidebar_menu_template.xml # Sidebar template │ ├── menu_item_template.xml # Menu item template │ └── navbar_patch.xml # Navbar patches └── README.rst # This file Technologies ============= * JavaScript (ES6+) * SCSS/CSS * XML (Odex QWeb templates) * Python Browser Support =============== * Chrome/Edge 90+ * Firefox 88+ * Safari 14+ * Mobile browsers (iOS Safari, Chrome Mobile) Troubleshooting =============== **Sidebar not appearing:** - Clear your browser cache - Log out and log back in - Check that the module is enabled in Settings **Sidebar not saving state:** - Ensure cookies are enabled in your browser - Check browser console for JavaScript errors (F12) **Performance issues:** - Clear browser cache and local storage - Try disabling and re-enabling the module Support ======= For issues, questions, or feature requests, please contact Epxert Ltd. * Website: https://www.exp-sa.com * Email: support@exp-sa.com License ======= This module is licensed under the LGPL-3 License. See the LICENSE file for details. Authors ======= * Epxert Ltd. (https://www.exp-sa.com) Changelog ========= **Version 1.0.0** (Initial Release) - Initial release of Odex Sidebar Backend Theme 2 - Collapsible sidebar menu functionality - Persistent state management - Responsive design support - Enable/disable toggle in settings