Module: js-whatever/js/checkbox-modal

Classes

CheckboxModal

Type Definitions

CheckboxModalOptions

Properties:

Name	Type	Argument	Default	Description
templateModal	String	<optional>		The template for the modal
templateTableModal	String	<optional>		The template for the table.
tables	Array.<CheckboxModalTable>			The configuration for the tables
parameters	object	<optional>	[]	Additional parameters passed to templateModal
okCallback	function	<optional>	$.noop	Callback called when the OK button is pressed
okIcon	string	<optional>	'icon-refresh'	Icon for the OK button
okClass	string	<optional>	'btn-success'	Class for the OK button
cancelClass	string	<optional>	''	Class for the cancel button
atLeastOneElementSelected	boolean	<optional>	false	Set this to true if a checkbox
i18n	object			Object containing i18n strings
vent	module:js-whatever/js/vent-constructor.Vent			Instance of Vent used to track resize events
checkboxOrRadio	string	<optional>	checkbox	Should be set to 'checkbox' or 'radio' according to the inputs used in your template

Source:

• checkbox-modal.js, line 27

CheckboxModalTable

Properties:

Name	Type	Argument	Description
initialState	boolean | Array.<string>		The initial state of the checkboxes. Can be either a boolean, or a list of row names which should start checked
tableHeader	string		The i18n key for the table header.
inputName	string	<optional>	The name of the radio input. Only used if checkboxOrRadio is set to radio
rows	Array.<string>		The names of the rows. These must be unique

Source:

• checkbox-modal.js, line 19

CheckboxModalTemplateParameters

Properties:

Name	Type	Description
tableConfigs	Array.<TableConfig>	The configuration for the tables
tableTemplate	function	The template for the table
i18n	object	i18n strings
okIcon	string	The icon for the OK butto
okClass	string	The class for the OK button
cancelClass	string	The class for the cancel button

Source:

• checkbox-modal.js, line 300

TableConfig

Properties:

Name	Type	Description
inputName	string	The name of the input if using radio buttons
i18n	object	strings
i18nTableHeader	string	A key in i18n which will be used as the table header
rows	object	A map from row names to booleans representing the checkbox state

Source:

• checkbox-modal.js, line 293