Common GUI actions and objects, standardized and simplified for constructing jQ UI widget instances
So modals, buttons, datepickers, etc get created through a common interface to yield improved consistency through the FE app.
All button functions, accessible via
.button.FUNCNAME accept a common set of options to override the default behavior.
All button functions accept the options hash, and most provide some helpful defaults. Apply any button options usually fed the jQuery button API to the options hash. Additional actions supported are:
'default') - a button class to apply. see btnClasses
el[Element] - element to buttonize. If no element provided, the button config (see
returnConfig) is returned by default
returnConfig[boolean] - return the button configuration object, vs the button instance
closeDialogbooean - If button is fed to a dialog,
buttons: array, the button will close the dialog after any
clickfunction has executed, and after any
actionfunction(s) have executed. This will auto-enable click regardless if no
destroyDialogboolean - See
closeDialog, but destroys widget instance
action[Function | [Function]] - additional action function(s) to be performed on button click. This will auto-enable click regardless if no
clickis defined. All actions are run synchronously.
String indexed hash of boostrap correllated
classNames. Available classes are:
All button constructors below utilize
base. Can be used directly with above configurations as needed.
Sugar for a button titled "Close" that will attempt to close a Dialog instance on click.
Sugar for a button titled "Close" that will attempt to destroy a Dialog instance on click.
Sugar for a red button titled "Delete" that ensures that a
action attr is defined.
All dialog functions accept the options hash, and most provide some helpful defaults. Apply any dialog options usually fed the jQuery dialog API to the options hash. Additional actions supported are:
All dialog constructors below utilize
base. Can be used directly with above configurations as needed. Close buttons in the button pane destroy the dialog by default.
Generates a dialog with a default title of
"Operation Failed", a friendly error message, and a red close button.
[Deprecated] Passed an api error, builds a
fail dialog with details from the failed API call. Not recommended for use.
This is a dated means of dependency management, however, until all COINS tools migrate to a FE DI system, it shall suffice.
npm run demo and open the posted url!
demo/index.html should load with some helpful examples.
- 2.0.1/2/3 - fulfill 2.0.0 claim
- 2.0.0 -
requirejquery and lodash individually. only consumed lodash fns are required into bundle
- 1.1.1 - Force close handlers before destroy
- 1.1.0 - Added destroy button and default dialog closing to destroy
- Formally deprecate ApiError