diff --git a/server/documents/modules/accordion.html.eco b/server/documents/modules/accordion.html.eco index dc2594fc1..d459579b4 100755 --- a/server/documents/modules/accordion.html.eco +++ b/server/documents/modules/accordion.html.eco @@ -496,17 +496,17 @@ themes : ['Default', 'Chubby']
console.table
output with performance metricsA checkbox can be initialized with javascript for increase programmatic control
- -A checkbox can also be used without using javascript by matching the id
attribute of the input field to the for
attribute of the accompanying label
enable | -A checkbox can change to show a user has selected it | -
disable | -A checkbox can change to show a user has deselected it | -
toggle | -A checkbox can toggle its current selection state | -
To disable a checkbox, add the property disabled
to your input.
To make a checkbox read-only do not initialize it, or include the read-only
class which will not allow events even if initialized.
To make a user able to check a box, but unable to uncheck it, use the uncheckable
setting.
To make a user able to check a box, but unable to uncheck it, use the uncheckable
setting.
To always disable a checkbox, add the property disabled
to your input.
To make a checkbox read-only do not initialize it, or include the read-only
class which will not allow toggle events.
A checkbox can be initialized with javascript for increase programmatic control
+ +A checkbox can also be used without using javascript by matching the id
attribute of the input field to the for
attribute of the accompanying label
Behaviors are accessible with javascript using the syntax:
+
toggle | +Switches a checkbox from current state | +
check | +Set a checkbox state to checked | +
uncheck | +Set a checkbox state to unchecked | +
attach events(selector, behavior) | +Attach checkbox events to another element | +
enable | +Enable interaction with a checkbox | +
disable | +Disable interaction with a checkbox | +
is radio | +Returns whether element is radio selection | +
is checked | +Returns whether element is currently checked | +
is unchecked | +Returns whether element is not checked | +
can check | +Returns whether element is able to be checked | +
These settings are specific to checkbox, and determine the parameters of its behavior
-Setting | -Default | ++ | Default | Description | |
---|---|---|---|---|---|
required | +uncheckable | auto | Setting to true/false will determine whether an input will allow no selection. Auto will set disallow this behavior only for radio boxes | ||
context | -false | -A selector or jQuery object to use as a delegated event context | +fireOnInit | +true | +Whether callbacks for checked status should be fired on init as well as change |
Setting | -Context | ++ | Context | Description |
---|---|---|---|
onChange | -Checkbox | +HTML input element | Callback after a checkbox is either disabled or enabled. |
onChecked | +HTML input element | +Callback after a checkbox is checked. | +|
onUnchecked | +HTML input element | +Callback after a checkbox is unchecked. | +|
onEnable | -Checkbox | +HTML input element | Callback after a checkbox is enabled. |
onDisable | -Checkbox | +HTML input element | Callback after a checkbox is disabled. |
Setting | -Default | ++ | Default | Description | +
---|---|---|---|---|
name | +Checkbox | +Name used in log statements | +||
namespace | checkbox | @@ -325,22 +372,52 @@ themes : ['Default']|||
selector | -
-
- selector : {
- input : 'input',
- label : 'label'
- }
+
+ |
+
+ selector : {
+ input : 'input[type=checkbox], input[type=radio]',
+ label : 'label'
+ }
Selectors used to find parts of a module |
| |
className | +
+
+ className : {
+ checked : 'checked',
+ disabled : 'disabled',
+ radio : 'radio',
+ readOnly : 'read-only'
+ }
+
+ |
+ Class names used to determine element state | +||
debug | +false | +Debug output to console | +||
performance | +false | +Show console.table output with performance metrics |
+ ||
verbose | +false | +Debug output includes all internal behaviors | +||
errors |
- className : {
- radio : 'radio'
- }
+ error : {
+ method : 'The method you called is not defined.'
+ }
|