diff --git a/DOM-States.md b/DOM-States.md new file mode 100644 index 0000000..b088b4a --- /dev/null +++ b/DOM-States.md @@ -0,0 +1,165 @@ +* [`checked`](#usage-checked) | [`check`](#usage-check) | [`uncheck`](#usage-uncheck) +* [`selected`](#usage-selected) | [`select`](#usage-select) +* [`disabled`](#usage-disabled) | [`disable`](#usage-disable) | [`enable`](#usage-enable) + +--- + +## .checked + +**Description** +Get the checked state of the first element or set the state for all matched elements. + +**Parameters** + +* `state` (Boolean, optional): True to check, false to uncheck. + +**Returns** + +* (Boolean): Current state (if getter). +* (jBase): Current instance (if setter). + +**Example** + +```javascript +if ($('#agree').checked()) { + // do something +} +$('#agree').checked(true); + +``` + +--- + +## .selected + +**Description** +Get the selected state of an option or set it. + +**Parameters** + +* `state` (Boolean, optional): True to select, false to deselect. + +**Returns** + +* (Boolean): Current state (if getter). +* (jBase): Current instance (if setter). + +**Example** + +```javascript +$('option[value="de"]').selected(true); + +``` + +--- + +## .disabled + +**Description** +Get the disabled state of an element or set it. + +**Parameters** + +* `state` (Boolean, optional): True to disable, false to enable. + +**Returns** + +* (Boolean): Current state (if getter). +* (jBase): Current instance (if setter). + +**Example** + +```javascript +$('button').disabled(true); + +``` + +--- + +## .check + +**Description** +Alias for `.checked(true)`. Checks all matched checkboxes or radio buttons. + +**Parameters** +* None. + +**Returns** +* (jBase): Current instance for chaining. + +**Example** +```javascript +$('.terms-checkbox').check(); +``` + +--- + +## .uncheck + +**Description** +Alias for `.checked(false)`. Unchecks all matched checkboxes or radio buttons. + +**Parameters** +* None. + +**Returns** +* (jBase): Current instance for chaining. + +**Example** +```javascript +$('.optional-options').uncheck(); +``` + +--- + +## .select + +**Description** +Alias for `.selected(true)`. Selects the matched `