Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]

Modules and Plugins [+] Modules and Plugins [-]

cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]

cPAddons (Site Software) [+] cPAddons (Site Software) [-]

System Administration [+] System Administration [-]

Developer Software [+] Developer Software [-]

Back to All Documentation

Documentation Home> SoftwareDevelopmentKitEditAttach

DynamicUI Reference Charts

These charts function as reference material when using adding items, icons, and groups to your users' cPanel interfaces.

Items

Key Type Value Example
itemdesc string The name of the item as it would appear in the cPanel interface.
note Note: ExpVar Values are acceptable here. 		Support
itemorder integer Describes the location of the item in the cPanel interface.
note Note: The lower the number, the higher up on the screen the item will appear. Negative values are acceptable 		10000
group string The icon group in which the item will appear. group_pref
url string The path to which the item will link. http://support.example.com
description string The item description displayed in the Branding Editor.
note Note: ExpVar Values are acceptable here. 		support link
if
optional 		string A conditional that allows you to check configuration settings and determine whether or not the item should appear to the user. This key is useful for access control.
note Note: ExpVar Values are acceptable here 		!$CONF{'skipawstats'} $CPDATA{'FEATURE-AWSTATS'}
searchtext
optional 		string Additional keywords used with the x3 theme's Quick Find feature.
note Note: ExpVar Values are acceptable here 		support
feature
optional 		string Name of a feature the account must have access to in order for the item to be displayed. support
acontent
optional 		string Additional attributes to include in the item's <a> HTML tag. target="_blank"
onclick
optional 		string Any Javascript that should execute when the item's link is clicked. show_optionselect('leechprotect'); return false;
module
optional 		string Specifies a module in /usr/local/cpanel/Cpanel/ without which the item will not appear. ImageManager

Icons

Key Type Value Example
imgtype string Always set this key to icon. icon
subtype string Always set this key to img. img
type string Always set this key to image. image
file string The name of the icon file, which should reside in /usr/local/cpanel/base/frontend/$theme/branding/
note Note: This value should not include the file extension. 		support
height integer The height of the icon.
note Note: When using the x3 theme, always set this value to 32. 		32
width integer The width of the icon.
note Note: When using the x3 theme, always set this value to 32. 		32

Groups

Key Type Value Example
groupdesc string The name of the group as it should appear in the cPanel interface.
note Note: ExpVar Values are acceptable here. 		Custom Group
group string The name of the group as used for associated icons.
note Note: This name does not include the group_ prefix. 		pref
grouporder integer A weight indicating where the group should appear in the cPanel theme.
note Note: The lower the number, the higher up on the screen the group will appear. Negative values are acceptable. 		1
description string The group description which will appear in the x3 Branding Editor.
note ExpVar Values are acceptable here. 		Custom Group
Edit | Attach | Print version | History: r5 < r4 < r3 < r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r5 - 05 Nov 2009 - 20:12:37 - Main.JustinSchaefer
DeveloperResources.DynamicUIRef moved from Sandbox.DynamicUIRef on 05 Nov 2009 - 19:41 by Main.JustinSchaefer