form-controls/README.md

A cross-browser helper for retrieving all controls in a form

# form-controls

[![npm version](https://img.shields.io/npm/v/form-controls.svg)](https://www.npmjs.com/package/form-controls)
[![npm dependencies](https://img.shields.io/david/dominicbarnes/form-controls.svg)](https://david-dm.org/dominicbarnes/form-controls)
[![npm dev dependencies](https://img.shields.io/david/dev/dominicbarnes/form-controls.svg)](https://david-dm.org/dominicbarnes/form-controls#info=devDependencies)
[![build status](https://img.shields.io/travis/dominicbarnes/form-controls.svg)](https://travis-ci.org/dominicbarnes/form-controls)

A helper for retrieving all of the controls for a given root element.

## Usage

```html
<form id="my-form">
    <input type="hidden" name="id" value="123456">
    <input type="text" name="username" value="dominicbarnes">
    <input type="url" name="website" value="http://dbarnes.info/">
</form>
```

```js
var controls = require('form-controls');
var el = document.querySelector('#my-form');

controls(el);
// => [
//     <input type="hidden" name="id" value="123456">,
//     <input type="text" name="username" value="dominicbarnes">,
//     <input type="url" name="website" value="http://dbarnes.info/">
// ]
```


## API

### controls(root)

Returns an `Array` of `HTMLElement` that represent the
[listed controls](http://www.w3.org/TR/html5/forms.html#category-listed)
for the `root` element.

It is *recommended* that you use either a `<form>` or `<fieldset>` as the `root`,
as there is already a DOM API for this operation. However, other arbitrary elements
are supported, mostly because I needed a "brute-force" fallback for when IE doesn't
work anyways.