Description:
This plugin is used for displaying a simple css progress bar
The look can be altered by creating a classes and setting progress_style_override=true in the config file
Example:
This would render a progress bar
#getMyPlugin("progress").renderit(8,10,"test bar")#
that looks like this
Arguments for the renderit function:
currentStep: REQUIRED The current step of the process whos progress your tracking.
totalSteps: REQUIRED The total number of steps in the process whos progress your tracking
progressText: Additional helper text for your progress bar, besides the Step x of y.
showHelperText: Flag to display any helper text. Default is true and displays text.
Usage:
With addition helper text
#getMyPlugin("progress").renderit(8,10,"test bar")#
With just "Step 8 of 10" helper text
#getMyPlugin("progress").renderit(8,10)#
With no helper text, and just the bar
#getMyPlugin("progress").renderit(8,10,"",false)#
ColdBox Settings
To override the styles, set progress_style_override=true in your coldbox config file
// custom settings
settings = {
progress_style_override=true
};
CSS Classes
.progress-container - container for the progress bar
.progress-text-container - container for the helper text
#progress_text - id of the span that contains the helper text