home / documentation / reference / slideoutpercent

SlideOutPercent

Description:

The percentage of the menu's width that a sliding menu should be moved with each SlideOutInterval.

Value:

Integer, or JavaScript expression that returns an integer. Negative values are not allowed.

Applies To:

Menus.

Browser Compatibility:

SlideOutPercent is not supported in Netscape 4.x, Internet Explorer 4.x, or earlier Gecko browsers (Netscape 7.02 and earlier, Mozilla 1.2 and earlier).

Comments:

You must always specify SlideOutPercent as an integer, or a JavaScript expression that returns an integer. Do not use quoted strings or non-numerical characters when defining SlideOutPercent.

In general, we recommend settings in the range of 5 (smoothest) to 25 (fastest). Lower numbers produce a smoother sliding effect, but also result in a (generally, depending on the SlideInInterval setting) slower overall menu hide. Larger numbers produce a choppier menu slide, but a faster overall display.

SlideOutPercent is part of the custom transition routines included in the HM_Loader.js file and discussed in detail in the Custom Transitions Mini-Tutorial. In order to apply a sliding effect to a menu display, you must include the key SlideOutTo parameter, as well as register the custom functions with the HierMenus setTrans and killTrans menu event hooks:

ScrollEnabled:1,
SlideOutTo:"left",
setTrans:HM_f_SetSlide,
killTrans:HM_f_KillSlide,

For reasons having to do with the sliding effect itself, all sliding menus must be ScrollEnabled.

SlideOutPercent is applied to the menu movement width when it is hidden. SlideInPercent is applied to the menu movement width when it is being displayed.

Examples:

// Ok:
SlideOutPercent:5,   // menu moved by 5% at a time
SlideOutPercent:10,  // menu moved by 10% at a time
SlideOutPercent:(HM_Opera)?5:10, 
   // 5% if Opera, 10% otherwise

// Incorrect:
SlideOutPercent:.5,
SlideOutPercent:-20,
SlideOutPercent:15%,
SlideOutPercent:"20",      // quotes not allowed
SlideOutPercent:"(HM_Opera)?5:10", 
   // no quoted expressions

Default:

20

See Also:

SlideInInterval, SlideOutInterval, SlideInPercent, SlideInFrom, SlideOutTo, setTrans, killTrans, Custom Transitions Mini-Tutorial