Browse Source

added the example in documentation for rails field convention

Sanjiv Jha 11 years ago
parent
commit
66049de314
1 changed files with 17 additions and 1 deletions
  1. 17 1
      README.md

+ 17 - 1
README.md

@@ -250,6 +250,22 @@ $(form).bootstrapValidator({
 });
 ```
 
+For Rails, the input field is constructed from model name and field name. For Example, User have email as field, when form helper render
+view, the input field name will be 'user[email]'. The syntax for these is somewhat different as shown below:
+```javascript
+$(form).bootstrapValidator({
+    fields: {
+        'user[email]': {
+            // Replace <validatorName> with the name of validator
+            // <validatorOptions> will be passed as third parameter of the
+            // validate(validator, $field, options) method
+            <validatorName>: <validatorOptions>
+        }
+    }
+});
+```
+
+
 To see how built-in validators are developed, you can look at their sources located at the [```src/js/validator```](src/js/validator) directory.
 
 ## Build
@@ -319,4 +335,4 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-```
+```