https://github.com/vebersol/jquery-custom-forms

A plugin to generate custom forms with accessibility
https://github.com/vebersol/jquery-custom-forms

Last synced: 4 months ago
JSON representation

A plugin to generate custom forms with accessibility

• Host: GitHub
• URL: https://github.com/vebersol/jquery-custom-forms
• Owner: vebersol
• Created: 2012-05-04T17:15:47.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2015-09-08T02:47:04.000Z (over 9 years ago)
• Last Synced: 2023-04-12T04:26:44.433Z (almost 2 years ago)
• Language: JavaScript
• Size: 271 KB
• Stars: 17
• Watchers: 4
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jQuery Custom Forms

A plugin to generate accessible custom forms: select, radio, checkbox.

Demo: http://vebersol.net/demos/jquery-custom-forms/

# Usage

```html

	

	Option 1

	Option 2

	$(function() {

		$('form').customForm();

	});

```

# API

### $.customForm(options)

Use this method to build the custom forms.

### Options

Options should be an object like:

```javascript

var options = {

	prefix: 'my-own-prefix',

	keyClass: 'my-own-key-class',

	enableWrapper: false

};

$.customForm(options);

```

* **prefix:** (String)  

A prefix to add to all class names used on elements created by this plugin.  

*Default value: 'custom-form-'*

* **keyClass:** (String)  

The class used to allow element to be replaced by a custom form element.  

*Default value: 'cform'*

* **enableWrapper:** (String)  

A boolean to enable a wrapper around the custom element and the original element. Very usefull to change position of the element.  

*Default value: false*

# License

MIT License - http://www.opensource.org/licenses/MIT