Configure a custom panel in the left panel
Last update: January 11, 2024
- Topics:
- Web Editor Configuration
CREATED FOR:
- Experienced
- Admin
Perform the following steps to add a custom panel within the left panel of the Web Editor:
- Create a clientlib folder and add your JavaScript and CSS file into this folder.
- Update the categories property of the clientlib folder by assigning it the value of apps.fmdita.xml_editor.page_overrides.
Sample code to configure a custom panel:
tcx.ready(function () { //Ready will call the callback after editor code is set for events and global variable excess
// APP_ADD_AUTHOR_LEFT_TAB event will add a new left tab in the left panel, user can show hide it using editor settings
tcx.eventHandler.next(tcx.eventHandler.KEYS.APP_ADD_AUTHOR_LEFT_TAB, {
id: 'my_panel',
class: 'my-panel-tab',
icon: 'file', //Any valid Adobe Spectrum icon name https://spectrum.adobe.com/page/icons/
label: 'My Tab',
prevTabID: 'repository_panel' //Existing tab ids are 'collection_panel', 'repository_panel', 'map_panel', 'outline_panel', 'conref_panel', 'glossary_panel', 'condition_panel', 'subject_scheme_panel', 'snippet_panel', 'template_panel', 'search_panel'
})
// APP_PANEL_DID_MOUNT event will be called after user has selected the panel and panel is rendered in the DOM
tcx.eventHandler.subscribe({
key: tcx.eventHandler.KEYS.APP_PANEL_DID_MOUNT,
next: function(opts) {
// TODO create panel ui inside $el
let $el = opts.$el //$el is Tab panel content html node
let id = opts.id //id is tab panel id (my_panel)
console.log("mounted", opts)
}
})
// APP_PANEL_WILL_UNMOUNT will be called before destorying the new left panel
tcx.eventHandler.subscribe({
key: tcx.eventHandler.KEYS.APP_PANEL_WILL_UNMOUNT,
next: function(opts) {
//TODO do some cleanup
let id = opts.id //id is tab panel id (my_panel)
console.log("unmounted", opts)
}
})
});
Parent topic:Customize Web Editor
Previous pageOpen DITA topic or map files in same tab
Next pageConfigure file auto-save in the Web Editor
Experience Manager
- AEM Guides overview
- Disclaimer
- Release Information
- AEM Guides releases roadmap
- Release Notes
- Cloud Services
- Deployment Instructions
- 2025 Releases
- 2024 Releases
- 2023 Releases
- 2022 Releases
- On-prem/Managed Services
- Cloud Services
- User Guide (New UI)
- Introduction
- Home page
- Author content
- Authoring overview
- Ways to Author content using AEM Guides
- Editor
- Introduction to the Editor
- Launch the Editor
- Edit topics in the Editor
- Topic creation and preview
- Know the Editor interface and features
- Additional features in the Editor
- Working with the Editor Settings
- Keyboard shortcuts in the Editor
- Editor views
- Support for Schematron files
- Author Markdown documents from the Editor
- Add citations to your content
- Use data from your data sources
- Document state
- Use labels
- Map Editor
- DITAVAL editor
- Desktop tools for authoring content
- Review content
- Collaborate using Adobe Workfront
- Metadata and tagging
- Map management and publishing
- Map console overview
- Open files in Map console
- Reports
- Content translation
- Output Generation
- Output generation basics
- Output presets in AEM Guides
- Edit, duplicate, or delete an output preset
- Conditionalize content
- Use Baseline
- Manage Global and Folder Profile output presets
- Use variables for setting the Destination Path, Site Name, or File Name options
- Pass on the metadata to the output using DITA-OT
- Generate output
- Use Map Collection for output generation
- Manage output generation process
- Manage publish tasks using the Publish Dashboard
- Basic troubleshooting
- Bulk activation of content
- Output generation of FrameMaker Documents
- AI Assistant in AEM Guides
- Appendix
- User Guide (Old UI)
- Installation and configuration
- On-premise
- On-premise basics
- Download, install, and upgrade
- Work with user groups and security
- Content migration
- Work with custom DITA-OT and specialization
- Configure post processing for a folder
- Configure filenames
- Configure auto-filenames based on UUID
- Configure Regx for valid file name characters
- Configure valid file names for AEM Site output
- Work with topic and map templates
- Work with document states
- Work with the Web Editor configurations
- Customize Web Editor
- Customize toolbar
- Configure default value for the Tags View
- Configure the title for Check in and Check out icons
- Configure display of UUID-based links
- Open DITA topic or map files in same tab
- Configure a custom panel in the left panel
- Configure file auto-save in the Web Editor
- Configure filters for file browse dialog
- Configure prompt to save as a new version on close
- Configure prompt to check in a file on close
- Configure allowed special characters
- Auto-generate element IDs
- Customize AEM’s default dictionary
- Configure text filters
- Configure the number of LimitReads for a query
- Install packages for Article-based publishing
- Configure a data source connector from the user interface
- Set the Advanced Map Editor as default
- Include @navtitle attribute by default
- Configure the option to edit in Oxygen
- Configure additional special characters
- Work with global and folder-level profiles
- Configure versions
- Work with desktop-based XML editors
- Work with output generation settings
- Configure output generation settings
- Download and install aem sites templates
- Overlay HTML tags in AEM Sites output
- Native PDF Publishing
- Configure JVM flags for Native PDF Publishing
- Configure and customize workflows
- Work with translation configurations
- Work with AEM Assets search
- Appendix
- Cloud Services
- About this guide
- Deploy and configure AEM Guides as Cloud Service
- Work with user groups and security
- Content migrate
- Work with custom DITA-OT and specialization
- Configure UUID and non-UUID based filenames
- Work with topic and map templates
- Work with document states
- Work with the Web Editor configurations
- Customize Web Editor
- Customize toolbar
- Configure the AI-powered smart suggestions for authoring
- Configure the AI-powered Smart Help to search content
- Configure default value for the Tags View
- Configure display of UUID-based links
- Configure display of pasted tables
- Open DITA topic or map files in same tab
- Configure a custom panel in the left panel
- Configure file auto-save in the Web Editor
- Configure prompt to save as a new version on close
- Configure prompt to check in a file on close
- Configure allowed special characters
- Auto-generate element IDs
- Customize AEM’s default dictionary
- Configure text filters
- Configure filters for file browse dialog
- Install packages for Article-based publishing
- Configure single topic PDF generation
- Configure Translation feature in the Web Editor
- Configure a data source connector
- Configure a data source connector from the user interface
- Set the Advanced Map Editor as default
- Include @navtitle attribute by default
- Work with global and folder-level profiles
- Configure versions
- Work with desktop-based XML editors
- Configure Workfront
- Work with output generation settings
- Work with custom workflows
- Work with translation configurations
- Work with AEM Assets search
- Appendix
- On-premise
- API Reference
- Introduction
- REST APIs for Output management
- REST API to work with DITA maps
- REST API to register a data source connector
- REST API to work with conditional attributes
- REST APIs for conversion workflow
- REST API for creating and activating packages
- Java-based API to work with output generation
- Java-based APIs to work with DITA maps
- Java-based APIs for conversion workflow
- Java-based APIs to work with baseline and labels
- Java-based API to work with folder profiles
- Java-based API for creating and activating packages
- Post-processing event handler
- Bulk activation complete event handler
- Conversion process event handler
- Knowledge Base
- Expert Session
- Expert Session Overview
- Translate content
- Manage content using baselines
- Author web-based content
- Native PDF publishing essentials
- Reports in AEM Guides
- Content and Template setup
- Learning native PDF publishing - part 1
- Learning native PDF publishing - Hands on lab - BYOS
- Extension Framework of AEM Guides
- External Datasource Integration
- Translate content in Guides - part 2
- Define, Manage and Utilize Metadata
- AEM Sites output variations
- Deployment options and migration to Cloud
- Migrate content from non-uuid to UUID
- Delta content migration
- Smarter PDF Publishing with Native PDF
- New UX and AI Capabilities in AEM Guides
- Articles
- Authoring
- Guides Extention Framework
- External data source
- Publishing
- Workflows
- Translation
- Use Cases
- Expert Session