https://github.com/lgsinnovations/bits-toolbar-customizer
Add toolbar items to the BITS server, and hide existing toolbar or sidebar items
https://github.com/lgsinnovations/bits-toolbar-customizer
Last synced: 6 months ago
JSON representation
Add toolbar items to the BITS server, and hide existing toolbar or sidebar items
- Host: GitHub
- URL: https://github.com/lgsinnovations/bits-toolbar-customizer
- Owner: LGSInnovations
- Created: 2018-07-06T04:26:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-23T16:44:58.000Z (over 7 years ago)
- Last Synced: 2025-05-14T10:18:47.575Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 204 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bits Toolbar Customizer
Contribute custom toolbar widgets and hide existing toolbar or sidebar items.
## Install and Build
For the following, assume the bits server is installed at `/opt/bits` and your bits modules are in `/opt/bits-modules`.
```
cd /opt/bits-modules
git clone
cd bits-toolbar-customizer
npm install
cd app/
bower install
cd /opt/bits/data/base/modules/modules
ln -s /opt/bits-modules/bits-toolbar-customizer
```
## Usage
Use this module to customize the BITS UI in two ways:
### Add Widgets to the Toolbar
Add custom widgets in `app/elements/bits-toolbar-customizer/bits-toolbar-customizer.html`. Replace the sample `` element with markup that implements your widget. Set the desired icon, add widget listeners, etc. Icons for any contributed widget will appear on the right-side of the BITS toolbar.
### Hide Selected BITS UI Framework Items
Launch the BITS server and navigate to `https://localhost:9001/bits-toolbar-customizer` (or select the `Toolbar Customizer` module from the main BITS sidebar). Select items to be hidden or de-select previously-hidden items to be shown, and click `Save Changes`. Items will be hidden or shown immediately, except for Home sidebar items (which require a page reload as described below). Your customizations will persist throughout the session and across BITS server re-starts.
## Notes
* The customizations you specify are saved as json text in the file `customizations.json` in the data directory for this module (default `/data/bits-toolbar-customizer`). In a production environment, you may want to retain a copy of this file and provide some means for restoring it in the event the module data directory is deleted or purged.
* To prevent users from changing the customizations in a production environment, remove the entries from this module's `module.json` file that have the following keys: `contentElement`, `contentImport`, and `displayName`. The module will continue to apply the customizations specified in the `customizations.json` file, but the module's UI will not be exposed.
* The implementation of the capability for hiding UI framework items is not ideal. Unless and until the BITS framework explicitly supports customization, the only two options are: 1) Modify the BITS codebase and mantain a separate baseline, or 2) Provide a capabilty to find selected items in the rendered DOM, and hide them. This module takes the latter approach, which has several implications.
* This "screen scrape" implementation is theoretically brittle, and may break with future BITS versions.
* The hiding of UI elements is sometimes noticeable. The hidden element appears for an instant when the page is loaded, and then disappears.
* When specific items from the `Home` sidebar are hidden, they are not hidden after clicking the `Home` link from the main sidebar until the page is refreshed. They are hidden immediately if you navigate directly to the `/home` route. This will hopefully be corrected in a future verison of the module.