home / documentation / reference / itemidsuffix

ItemIDSuffix

Description:

The unique suffix to be appended to the id of the menu item.

Value:

null, String, or JavaScript expression that returns a string/null. ItemIDSuffix may contain only letters, numbers, hyphens (-), and underscores (_). Spaces are not allowed.

Applies To:

Menu Items.

Browser Compatibility:

ItemIDSuffix is supported in all browsers.

Comments:

For each menu item created, HierMenus will, by default, create an id consisting of the item's MenuID, the constant _I, and then the menu item number for this menu item (with the first menu item being item number 1). So, the first item in the menu with the MenuID hm_products would have the id hm_products_I1.

For the great majority of implementations, this numbering scheme will be fine. If not, you can use ItemIDSuffix to create your own unique id for the menu item. When ItemIDSuffix is set to an actual value other than null, it is appended to the MenuID of the item instead of the standard _In string. So, given this item configuration:

MenuID:"hm_products",
ItemIDSuffix:"_prodItem1",

the resulting id for the menu item would be hm_products_prodItem1.

All IDs on a web page--including those defined outside of HierMenus--must be unique. Take care, therefore, in the creation of your ItemIDSuffix strings. See the MenuID reference entry for further information.

ItemIDSuffix is case sensitive.

Examples:

// Ok:
ItemIDSuffix:"_prodItem1",
ItemIDSuffix:window.hmSuffix+"Item1",
   // concatenate the user defined variable hmSuffix
   // with "Item1" to arrive at the ItemIDSuffix

// Incorrect:
ItemIDSuffix:_prodItem1,       // quotes required
ItemIDSuffix:"TopTen%",        // % not allowed
ItemIDSuffix:"Item 1",         // spaces not allowed
ItemIDSuffix:'window.hmSuffix+"Item1"',
   // no quoted expressions

Default:

null

See Also:

MenuID