Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andyexeter/jquery-grouprequired
jQuery plugin to use the HTML5 required attribute on one of multiple elements
https://github.com/andyexeter/jquery-grouprequired
form-validation html5 jquery jquery-plugin
Last synced: about 1 month ago
JSON representation
jQuery plugin to use the HTML5 required attribute on one of multiple elements
- Host: GitHub
- URL: https://github.com/andyexeter/jquery-grouprequired
- Owner: andyexeter
- License: mit
- Created: 2016-12-02T12:01:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T03:29:52.000Z (over 2 years ago)
- Last Synced: 2024-04-14T12:30:26.592Z (10 months ago)
- Topics: form-validation, html5, jquery, jquery-plugin
- Language: JavaScript
- Homepage:
- Size: 787 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[//]: # (Do not edit README.md as it is automatically generated from src/README.tpl.md)
# jQuery groupRequired v2.4.0
[](https://travis-ci.org/andyexeter/jquery-grouprequired)
[](https://www.npmjs.com/package/jquery-grouprequired)
[](https://david-dm.org/andyexeter/jquery-grouprequired#info=devDependencies)
A jQuery plugin to use the HTML5 required attribute and require one of many elements
Say you have form with two inputs: telephone number and mobile number. You want the user to enter at least one
of those numbers, but you don't want to make both fields required. This plugin will set both fields as `required` but
will still allow the form to be submitted as long as one of them is filled.
## Installation
#### Download
* [jquery.grouprequired.min.js](https://unpkg.com/[email protected]/dist/jquery.grouprequired.min.js) (1.47kB, 662B gzipped)
* [jquery.grouprequired.js](https://unpkg.com/[email protected]/dist/jquery.grouprequired.js) (4.27kB, 1.3kB gzipped)
#### CDN
```html
```
#### Package Managers
Install via yarn:
```sh
$ yarn add jquery-grouprequired
```
Install via NPM:
```sh
$ npm install jquery-grouprequired --save
```
## Usage
#### Standard Usage
```html
Telephone:
Mobile:
$(function () {
$('input[type=tel]').groupRequired({
errorMessage: 'Please enter at least one contact number'
});
});
```
#### Webpack / Browserify
```sh
$ yarn add jquery-grouprequired
```
```js
var $ = require('jquery');
require('jquery-grouprequired')($);
$('input[type=tel]').groupRequired();
```
## Options
| Option | Type | Description | Default |
|----------------|--------------------|----------------------------------------------------------------------------------------------|-------------------|
| errorMessage | `string\|function` | Custom error message | `''` |
| requiredFilter | `function` | Function which returns a boolean dictating whether the group of elements should be required. | `null` |
| namespace | `string` | Unique plugin namespace for events and data | `'groupRequired'` |
Using the `errorMessage` option as a function:
```js
$('input[type=tel]').groupRequired({
errorMessage: function (pluginInstance, event) {
// do some logic checking with function arguments
// 'this' is bound to the current input element
return 'Please enter a number';
}
});
```
Modify the `$.fn.groupRequired` object to change default option values:
```js
$.fn.groupRequired.namespace = 'my_namespace';
```
## License
Released under the [MIT license](LICENSE)