Collapse-Pro-Matic | Documentation
Plugin Settings
Collapse-Pro-Matic plugin options page is located under Dashboard > Settings > Collapse-Pro-Matic.
Settings
- Scroll Target Offset
- Style
- Collapse Management
- Scroll Speed
- Wrap Tag
- Tag
- Wrap Class
- Trigclass
- Anchor Click Pause
- Tabindex
- Animation Effect
- Targtag
- Slide Direction
- Targclass
- Global Cookie Name
- No Title
- Cookie Expires
- Add Touchstart
- Nested Sub Expands
- Initial Pause
- Omit Default CSS
- Collapse/Expand Duration
- CID
- Animation Effect
- Use on Login/Registration Pages
- Custom Style
- Expand On
- Content Filter
- Pre Expand Callback
- Shortcode Loads CSS
- Expand Callback
- Script Load Location
- Expand All Callback
- Pre Collapse Callback
- Collapse Callback
- Collapse All Callback
- Pre Expand/Collapse Callback
- Expand/Collapse Callback
Pro Only
Scroll Target Offset
Global offset value for all scroll targets.
Style
Default style of accordion elements. Select light for sites with lighter background and dark for sites with darker backgrounds. Select none to remove all built-in style.
Collapse Management
Collapse Commander is an add-on plugin that introduces an advanced management interface to better organize expand elements and simplify expand shortcodes.
Pro Only
Scroll Speed
Global scrolling speed for all scroll targets.
Pro Only
Wrap Tag
Default HTML tag use to wrap the entire collapse element when using the Startwrap/Endwrap Attributes. Can be overwritten in the shortcode by using the Elwraptag Attribute.
Tag
The default HTML tag attribute used to wrap the trigger text.
Pro Only
Wrap Class
Default class use to wrap the entire collapse element when using the Startwrap/Endwrap Attributes. Can be overwritten in the shortcode by using the Elwrapclass Attribute.
Trigclass
Default class to be added to the trigger element. Any custom class provided will be added to the trigger after the required collapseomatic class that is assigned by default.
Pro Only
Anchor Click Pause
Amount of time in milliseconds to pause before an element that matches an anchor url is triggered to expand.
Tabindex
Default tabindex value to be assigned to the trigger element. Assigning the tabindex attribute a numerical value will assign the trigger element the same tabindex value. The default is tabindex="0" and allows the trigger element’s tabindex to be placed in the default tab navigation order.
Pro Only
Animation Effect
Animation effect used to collapse and expand the content.
- Slide Only – only slide the content open/close using jQuery .slideToggle()
- Slide & Fade (default) – simultaneously slide the content open/close while fading in/out using jQuery .animate()
- Directional Slide – slide the content open/closed using jQuery .toggle() and Side Effects
Targtag
Default HTML tag to be used for the target element. Any default tag assigned in the plugin options can be overridden by defining the targtag attribute in the shortcode.
Pro Only
Slide Direction
The direction of the slide if Directional Slide is set as the Animation Effect. Uses jQuery .toggle() with jQuery Slide Effect. Accepted values are:
- left (default)
- right
- up
- down
Targclass
Default class to be added to the target element. Any custom class provided will be added to the target after the required collapseomatic_content class that is assigned by default.
Pro Only
Global Cookie Name
Global cookie name to use for storing the collapse status of all expand elements.
No Title
Selecting this option will prevent the title attribute from being displayed on trigger mouse-over.
Pro Only
Cookie Expires
Default time in days that global and element-level cookies are valid before they expire. The default value: 7 days.
Add Touchstart
Add touchstart binding to triggers to troubleshoot issues on touch screen devices. Note: This is normally not recommended and to should used only as a brute-force override if the click event is not being fired on touch devices. If adding touchstart fixes the issue, there is a very good some non-standard script is being installed some other plugin or the theme.
Pro Only
Nested Sub Expands
Number shortcodes to create for nested sub-expand levels.
Initial Pause
Amount of time in milliseconds to pause before the initial collapse is triggered on page load. Default is blank (zero/no pause).
Pro Only
Omit Default CSS
Prevent all default Collapse-Pro-Matic CSS from being loaded.
Collapse/Expand Duration
A string or number determining how long the collapse & expand animation should take to complete. Duration numbers are in milliseconds; higher values indicate slower animations, not faster ones. The default duration is 400 milliseconds. The strings ‘fast’ and ‘slow’ may also be supplied to indicate durations of 200 and 600 milliseconds, respectively. For more details see the .animate() jQuery API
Animation Effect
Animation effect to use for collapsing and expanding elements.
-
- Slide & Fade will simultaneously slide the content open/close while fading in/out using jQuery .animate()
- Slide Only will only slide the content open/close using jQuery .slideToggle()
Pro Only
Use on Login/Registration Pages
Load the Collapse-Pro-Matic script and CSS so that accordion elements may be used on WordPress login and registration pages.
Custom Style
Custom CSS for ultimate flexibility. CSS may abe added in this section if the active child-theme does not support a quick-css option.
Pro Only
Expand On
Sets a default Expand on Attribute for all expands. Accepts a comma separated list of WordPress Conditional Tags that will trigger an auto-expand if true.
Content Filter
Select this option to force-apply WordPress’ the_content filter to content hidden in the target element. This option is not active by default, as it is normally not required. The primary use for this option is to help troubleshoot rendering issues due to non-standard coding practices used in the active theme or another plugin.
Pro Only
Pre Expand Callback
Callback function name or script to fire prior to expanding any element. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.
Shortcode Loads CSS
Select this option to only load the Collapse-O-Matic CSS if the [expand] shortcode is used. Note: It is not recommended to activate this option if the roll-your-own method is being used.
Pro Only
Expand Callback
Callback function name or script to fire after any element has been expanded. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.
Script Load Location
Where to enqueue the script:
- Footer (default) – Load before the </body> closing tag
- Head – load within the <head> tag
Pro Only
Expand All Callback
Callback function name or script to fire after an expand all trigger or setall toggle is clicked. If the trigger is a grouped expand all, the group name is passed as the variable: group to this callback.
Examples
if(group){
console.log('expand all in group: ' + group);
}
See Event Callbacks for more details.
Pro Only
Pre Collapse Callback
Callback function name or script to fire prior to collapsing any element. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.
Pro Only
Collapse Callback
Callback function name or script to fire after any element has been collapsed. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.
Pro Only
Collapse All Callback
Callback function name or script to fire after an collapse all element is clicked. See Collapse-Pro-Matic Callbacks for more details.
Pro Only
Pre Expand/Collapse Callback
Callback function name or script to fire before any element is expanded or collapsed. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.
Pro Only
Expand/Collapse Callback
Callback function name or script to fire after any element has been expanded or collapsed. Both the trigger and target are passed as objects to this callback.
Examples
if(trigger.hasClass('my_trig_class')){
console.log('trigger has the class');
}
if(target.hasClass('my_targ_class')){
console.log('target has the class');
}
See Event Callbacks for more details.