Skip to content

Commit bbf31f3

Browse files
etylsarinstaabm
authored andcommitted
Entries: Documentation for step method added.
Closes #17.
1 parent a830735 commit bbf31f3

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

entries/step-method.xml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?xml version="1.0"?>
2+
<entry name="step" type="method" return="Boolean">
3+
<title>step method</title>
4+
<desc>Makes the element require a given step.</desc>
5+
<longdesc>
6+
Works with text inputs. No support for input types: date, datetime, datetime-local, month, time and week.
7+
</longdesc>
8+
<signature>
9+
<argument name="value" type="Number">
10+
<desc>
11+
Step value required
12+
</desc>
13+
</argument>
14+
</signature>
15+
<example>
16+
<desc>Makes "field" required and step of 10.</desc>
17+
<code><![CDATA[
18+
$( "#myform" ).validate({
19+
rules: {
20+
field: {
21+
required: true,
22+
step: 10
23+
}
24+
}
25+
});
26+
]]></code>
27+
<html><![CDATA[
28+
<label for="field">Required, step 10: </label>
29+
<input type="text" class="left" id="field" name="field">
30+
<br/>
31+
<input type="submit" value="Validate!">
32+
]]></html>
33+
</example>
34+
<category slug="methods"/>
35+
</entry>

pages/documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ A set of standard validation methods is provided:
115115
* [`min` - Makes the element require a given minimum.](/min-method)
116116
* [`max` - Makes the element require a given maximum.](/max-method)
117117
* [`range` - Makes the element require a given value range.](/range-method)
118+
* [`step` - Makes the element require a given step.](/step-method)
118119
* [`email` - Makes the element require a valid email](/email-method)
119120
* [`url` - Makes the element require a valid url](/url-method)
120121
* [`date` - Makes the element require a date.](/date-method)

0 commit comments

Comments
 (0)