菜单
Use this skill when extending the ContentBox admin UI with custom menus, views, interception points, editor integrations, workflows, and secure admin-only module behaviors.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use this skill when building WebSocket features with SocketBox in ColdBox/CFML/BoxLang. Covers the real SocketBox APIs for core WebSocket handling and STOMP broker usage, including correct base classes, method signatures, server-side sends, and client examples.
Use this skill when working with CacheBox as a standalone caching framework (outside ColdBox) -- installing, creating and bootstrapping the CacheFactory, configuring the DSL, choosing object stores and eviction policies, selecting cache providers (CacheBoxProvider, CF, Lucee), implementing cache-aside/stampede-protection patterns, registering standalone listeners, named caches, disk/JDBC stores, reaping, shutdown, or monitoring cache performance.
Use this skill when integrating AI capabilities into a ColdBox application using the BoxLang AI library (bx-ai module) -- including simple chat, streaming, pipelines, agents, RAG with vector memory, document loading, tool calling, and injecting the AI service into handlers or models.
Use this skill when choosing a ColdBox application layout (flat, boxlang, or modern), scaffolding a new ColdBox project, understanding project directory structure, deciding between app structure options, or migrating from one layout to another. Use when asked about flat layout, boxlang template, modern template, app structure, project skeleton, or web root separation.
Use this skill when building async pipelines, working with ColdBox Futures, running parallel computations with all()/allApply()/anyOf(), registering and managing thread-pool executors, or accessing the AsyncManager via the async() helper.
Use this skill when implementing caching inside a ColdBox application -- configuring CacheBox via ColdBox.cfc or config/CacheBox.cfc, injecting caches with WireBox (cachebox:name), using getCache() in handlers, event/view output caching with setEventCacheableEntry(), view fragment caching with renderView(cache=true), query caching, cache listeners as ColdBox interceptors, Redis/distributed provider setup, or choosing between default and template caches.
| name | contentbox-boxlang-admin-extension |
| description | Use this skill when extending the ContentBox admin UI with custom menus, views, interception points, editor integrations, workflows, and secure admin-only module behaviors. |
| applyTo | **/*.{bx,bxm,cfc,cfm,cfml} |
Extend the ContentBox admin interface using BoxLang. Add custom panels, modify existing screens, inject HTML into admin layouts, hook into content lifecycle events, and register new admin functionality.
The admin module lives at modules/contentbox/modules/contentbox-admin/ with entry point cbadmin. It provides:
Inject custom HTML into the admin layout at specific points:
| Interception Point | Location |
|---|---|
cbadmin_beforeHeadEnd | Before </head> tag |
cbadmin_afterBodyStart | After <body> tag |
cbadmin_beforeBodyEnd | Before </body> tag |
cbadmin_footer | Admin footer area |
cbadmin_beforeContent | Before main content area |
cbadmin_afterContent | After main content area |
cbadmin_onTagLine | Tag line area |
cbadmin_onTopBar | Top navigation bar |
// interceptors/AdminAssets.bx
component {
function configure(){
}
function onCbadmin_beforeHeadEnd( event, data, buffer, rc, prc ){
buffer.append( '<link rel="stylesheet" href="/modules/mymodule/includes/css/admin.css">' )
}
function onCbadmin_beforeBodyEnd( event, data, buffer, rc, prc ){
buffer.append( '<script src="/modules/mymodule/includes/js/admin.js"></script>' )
}
}
Extend the content editor (entry/page editing screens):
| Interception Point | Location |
|---|---|
cbadmin_contentEditorSidebar | Sidebar area |
cbadmin_contentEditorSidebarAccordion | Sidebar accordion sections |
cbadmin_contentEditorSidebarFooter | Bottom of sidebar |
cbadmin_contentEditorFooter | Editor footer |
cbadmin_contentEditorInBody | Inside editor body |
cbadmin_contentEditorNav | Editor navigation |
cbadmin_contentEditorNavContent | Editor nav content |
// interceptors/EditorSidebar.bx
component {
function configure(){
}
function onCbadmin_contentEditorSidebarAccordion( event, data, buffer, rc, prc ){
content = '
<div class="accordion-section">
<h4>My Custom Panel</h4>
<div class="accordion-content">
<p>Custom panel content here</p>
</div>
</div>
'
buffer.append( content )
}
}
Hook into content save, remove, and status change events:
| Point | When |
|---|---|
cbadmin_preEntrySave | Before entry is saved |
cbadmin_postEntrySave | After entry is saved |
cbadmin_preEntryRemove | Before entry is deleted |
cbadmin_postEntryRemove | After entry is deleted |
cbadmin_onEntryStatusUpdate | When entry status changes |
| Point | When |
|---|---|
cbadmin_prePageSave | Before page is saved |
cbadmin_postPageSave | After page is saved |
cbadmin_prePageRemove | Before page is deleted |
cbadmin_postPageRemove | After page is deleted |
cbadmin_onPageStatusUpdate | When page status changes |
// interceptors/EntryAudit.bx
component {
property name="log" inject="logbox:logger:EntryAudit"
function configure(){
}
function onCbadmin_postEntrySave( event, data, buffer, rc, prc ){
// data.entry contains the saved entry
entry = data.entry
log.info( "Entry saved: #{entry.getTitle()}# by #{entry.getAuthor().getUsername()}#" )
// Could also trigger external API, send notifications, etc.
}
}
Extend author management screens:
| Point | Location |
|---|---|
cbadmin_UserPreferencePanel | User preferences panel |
cbadmin_onAuthorEditorNav | Author editor navigation |
cbadmin_onAuthorEditorContent | Author editor content area |
cbadmin_onAuthorEditorSidebar | Author editor sidebar |
cbadmin_onAuthorEditorActions | Author editor action buttons |
cbadmin_onNewAuthorForm | New author form |
cbadmin_onNewAuthorActions | New author form actions |
cbadmin_preNewAuthorSave | Before new author saved |
cbadmin_postNewAuthorSave | After new author saved |
cbadmin_onAuthorPasswordChange | When author password changes |
cbadmin_preAuthorPreferencesSave | Before preferences saved |
cbadmin_postAuthorPreferencesSave | After preferences saved |
// interceptors/AuthorExtension.bx
component {
property name="authorService" inject="authorService@contentbox"
function configure(){
}
function onCbadmin_onAuthorEditorSidebar( event, data, buffer, rc, prc ){
content = '
<div class="form-group">
<label>Department</label>
<input type="text" name="department"
value="#{prc.author?.getDepartment() ?: ''}#"
class="form-control">
</div>
'
buffer.append( content )
}
function onCbadmin_postAuthorSave( event, data, buffer, rc, prc ){
// Save custom field
if( structKeyExists( rc, "department" ) ){
data.author.setDepartment( rc.department )
authorService.save( data.author )
}
}
}
Add content to the admin dashboard:
| Point | Location |
|---|---|
cbadmin_onDashboard | Dashboard main area |
cbadmin_preDashboardContent | Before dashboard content |
cbadmin_postDashboardContent | After dashboard content |
cbadmin_preDashboardSideBar | Before dashboard sidebar |
cbadmin_postDashboardSideBar | After dashboard sidebar |
cbadmin_onDashboardTabNav | Dashboard tab navigation |
cbadmin_preDashboardTabContent | Before tab content |
cbadmin_postDashboardTabContent | After tab content |
Register custom menu items via cbadmin_onAdminMenuLoad:
// interceptors/AdminMenu.bx
component {
function configure(){
}
function onCbadmin_onAdminMenuLoad( event, data, buffer, rc, prc ){
// data.menuItems is the array of menu items
arrayAppend( data.menuItems, {
name : "My Module",
link : event.buildLink( "cbadmin/myModule" ),
icon : "star",
permission : "MYMODULE_ACCESS",
order : 50
} )
}
}
Register your interceptors in your module's ModuleConfig.bx:
// ModuleConfig.bx
interceptors = [
{
class : "mymodule.interceptors.AdminAssets",
name : "AdminAssets@mymodule"
},
{
class : "mymodule.interceptors.EditorSidebar",
name : "EditorSidebar@mymodule"
},
{
class : "mymodule.interceptors.EntryAudit",
name : "EntryAudit@mymodule"
}
]
Extend baseHandler for admin handlers:
// handlers/MyModule.bx
component extends="contentbox.modules.contentbox-admin.handlers.baseHandler" singleton {
function index(){
prc.pageTitle = "My Module"
setView( "myModule/index" )
}
function settings(){
prc.pageTitle = "My Module Settings"
prc.settings = settingService.getSettings()
setView( "myModule/settings" )
}
}
Define routes in your module's ModuleConfig.bx:
routes = [
{ pattern : "/cbadmin/myModule", handler : "myModule", action : "index" },
{ pattern : "/cbadmin/myModule/settings", handler : "myModule", action : "settings" },
{ pattern : "/cbadmin/myModule/:action", handler : "myModule" }
]
Admin handlers inherit security from the admin firewall. Configure permissions:
// In your module's ModuleConfig.bx
settings.cbsecurity = {
firewall : {
rules : {
provider : {
source : "model",
properties : {
model : "securityRuleService@contentbox",
method : "getSecurityRules"
}
}
}
}
}
ModuleConfig.bxbaseHandler for admin handlersprc scope for passing data to admin viewsbuffer.append() for HTML injection interceptorsprovider: injection to avoid circular dependenciesThis skill targets BoxLang engine. For CFML-specific syntax (Lucee 5+, Adobe ColdFusion 2018+), see the CFML variant of this skill.
Key BoxLang advantages:
<cfcomponent> / <cffunction> tags#{...}# for inline expression output in .bx templates?: null coalescing, ?. safe navigation