associated/README.md

Get associated labels and inputs

# associated

```
npm install associated --save
```

## Features
- Get label(s) for a specified input
- Get form control (input, textarea, select, button) for a specified label
- Get associated form
- Get associated radios

## API

```js
var associated = require('associated')
```

### Parameters

- `$form` refers to a jQuery-wrapped `<form>` element
- `$root` refers to a jQuery-wrapped `:root` element
- `$input` refers to a jQuery-wrapped `<input>` element
- `$textarea` refers to a jQuery-wrapped `<textarea>` element
- `$select` refers to a jQuery-wrapped `<select>` element
- `$button` refers to a jQuery-wrapped `<button>` element
- `$control` refers to a jQuery-wrapped form control: `$input`, `$textarea`, `$select`, or `$button`
- `$label` refers to a jQuery-wrapped `<label>` element
- `$labels` refers to a jQuery-wrapped `<label>` collection
- `$radio` refers to a jQuery-wrapped radio input
- `$radios` refers to a jQuery-wrapped radio input collection

### Methods

#### `associated.control($label)`
- Get `$control` associated with `$label`

#### `associated.input($label)`
- Get `$input` associated with `$label`

#### `associated.textarea($label)`
- Get `$textarea` associated with `$label`

#### `associated.select($label)`
- Get `$select` associated with `$label`

#### `associated.button($label)`
- Get `$button` associated with `$label`

#### `associated.label($control)`
- Get the `$label` associated with `$control`

#### `associated.labels($control)`
- Get all `$labels` associated with `$control`

#### `associated.form($control)`
- Get associated `$form` or else `$root`

#### `associated.radios($radio)`
- Get `$radios` associated by `[name]`

### Chaining

#### Setup `associated` for use as plugin for jQuery or ender
```js
$.prototype.associated = associated
```

#### Then use `.associated` to call [methods](#methods) from the chain like
```js
$('#example').associated('form')
```

## Links
- [`associated` npm](https://www.npmjs.com/package/associated)
- [`associated` tests](https://ryanve.github.io/associated/)