- Introduction
- Install
- Upgrade
- Configure
- Administer
- Overview
- Admin Tools
- Manage security
- Backup and migrate
- Query Accelerator
- High availability features
- Licenses
- File and folder templates
- File metadata extraction
- Workflows
- Transformations
- Content stores
- Database table cleanup
- JMX reference
- Troubleshooting
- Using
- Develop
- Getting started
- Software architecture
- Software Development Kits (SDK)
- Extension packaging (modules)
- Extension Inspector
- Extension points overview
- Out-of-Process extension points
- In-Process platform extension points
- Overview
- Content model
- Actions
- Web scripts
- JavaScript Root Objects
- Behavior policies
- Scheduled jobs
- Metadata Extractors and Embedders
- Mimetypes
- Content Transformers and Renditions
- Permissions and roles
- Data lists
- Ratings
- Bootstrapping content
- Patches
- Module components
- Subsystems
- Authentication
- Content Stores
- Audit Log
- Admin Console Components
- Share UI extension points
- Overview
- Share configuration
- Document Library
- Share Themes
- Site Presets
- Web Scripts
- Surf Pages
- Surf Dashlets
- Surf Widgets
- Surf Extension Modules
- Aikau Menus
- Aikau Pages
- Aikau Dashlets
- Aikau Widgets
- Evaluators
- JavaScript Root Objects
- Form Controls
- Form Processor
- Form Processor Filters
- Form Field Validation Handlers
- Modifying out-of-the-box code
- Useful tools
- ReST API guide
- Reference
Aikau Menus Extension Point
The main menu of Share is implemented with the new Aikau UI development framework. It is possible to customize this menu, so you can navigate to new custom pages for example.
Architecture Information:Share Architecture
Description
The main menu and title in Share is implemented in Aikau, it looks like this:
Adding and removing menu items from the menu is a common task. To do this we use aSurf Extension Module. It will look something like this:
<extension> <modules> <module> <id>Add custom menu item to header</id> <version>1.0</version> <auto-deploy>true</auto-deploy> <customizations> <customization> <targetPackageRoot>org.alfresco.share.header</targetPackageRoot> <sourcePackageRoot>com.example.header</sourcePackageRoot> </customization> </customizations> </module> </modules></extension>So we are targeting the/share/WEB-INF/classes/alfresco/site-webscripts/org/alfresco/share/header/share-header.get.js web script controller file, which implements the menu JSON model. Now, if we want to for example add a menu item we need to create a file with the same name and put it inalfresco/web-extension/site-webscripts/com/example/header. The file will look like this:
var headerMenu = widgetUtils.findObject(model.jsonModel, "id", "HEADER_APP_MENU_BAR");if (headerMenu != null) { headerMenu.config.widgets.push({ id: "HEADER_CUSTOM_PROFILE_LINK", name: "alfresco/menus/AlfMenuBarItem", config: { label: "My profile", targetUrl: "user/" + encodeURIComponent(user.name) + "/profile" } });}This is all that is required to extend an existing JSON model. We’re usingwidgetUtils to find theHEADER_APP_MENU_BAR widget. Once we have it, we simply push a widget into it.
Deployment - App Server
tomcat/shared/classes/alfresco/web-extension/site-webscripts- put the files that are overriding heretomcat/shared/classes/alfresco/web-extension/site-data/extensions- put the Extension Module here.
(Untouched by re-deployments and upgrades)
Deployment All-in-One SDK project
aio/share-jar/src/main/resources/alfresco/web-extension/site-webscripts- put the files that are overriding hereaio/share-jar/src/main/resources/alfresco/web-extension/site-data/extensions- put the Extension Module here.
More Information
- Creating an Aikau page with Menus
- Aikau Widget Reference - this is the place to look for menu widgets that you can use.
Tutorials
- Customizing the Admin Tools Menu
- Customizing the Sites Menu
- Removing Menu Items
- Aikau Tutorials on GitHub