mirror of
https://github.com/Febbweiss/filebrowser-durandal-widget.git
synced 2026-03-05 14:45:43 +00:00
init
This commit is contained in:
205
lib/knockout-validation/README.md
Normal file
205
lib/knockout-validation/README.md
Normal file
@@ -0,0 +1,205 @@
|
||||
#Knockout Validation
|
||||
A KnockoutJS Plugin for model and property validation
|
||||
|
||||
[](https://travis-ci.org/Knockout-Contrib/Knockout-Validation)
|
||||
[](http://badge.fury.io/bo/knockout-validation)
|
||||
[](http://badge.fury.io/js/knockout.validation)
|
||||
[](http://badge.fury.io/nu/Knockout.Validation)
|
||||
|
||||
Contributors:
|
||||
|
||||
* [Eric Barnard](https://github.com/ericmbarnard)
|
||||
* [Steve Greatrex](https://github.com/stevegreatrex)
|
||||
* [Andy Booth](https://github.com/andybooth)
|
||||
* [Michal Poreba](https://github.com/michalporeba)
|
||||
* and many others!
|
||||
|
||||
License: [MIT](http://www.opensource.org/licenses/mit-license.php)
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
#### Bower
|
||||
|
||||
```sh
|
||||
bower install knockout-validation --save-dev
|
||||
```
|
||||
|
||||
#### NuGet
|
||||
|
||||
```ps1
|
||||
PM> Install-Package Knockout.Validation
|
||||
```
|
||||
|
||||
#### NPM
|
||||
|
||||
```sh
|
||||
npm install knockout.validation --save
|
||||
```
|
||||
|
||||
##Getting Started
|
||||
```javascript
|
||||
//start using it!
|
||||
var myValue = ko.observable().extend({ required: true });
|
||||
|
||||
//oooh complexity
|
||||
var myComplexValue = ko.observable().extend({
|
||||
required: true,
|
||||
minLength: 3,
|
||||
pattern: {
|
||||
message: 'Hey this doesnt match my pattern',
|
||||
params: '^[A-Z0-9].$'
|
||||
}
|
||||
});
|
||||
|
||||
//or chaining if you like that
|
||||
var myComplexValue = ko.observable()
|
||||
|
||||
myComplexValue.extend({ required: true })
|
||||
.extend({ minLength: 3 })
|
||||
.extend({ pattern: {
|
||||
message: 'Hey this doesnt match my pattern',
|
||||
params: '^[A-Z0-9].$'
|
||||
}});
|
||||
|
||||
//want to know if all of your ViewModel's properties are valid?
|
||||
var myViewModel = ko.validatedObservable({
|
||||
property1: ko.observable().extend({ required: true }),
|
||||
property2: ko.observable().extend({ max: 10 })
|
||||
});
|
||||
|
||||
console.log(myViewModel.isValid()); //false
|
||||
|
||||
myViewModel().property1('something');
|
||||
myViewModel().property2(9);
|
||||
|
||||
console.log(myViewModel.isValid()); //true
|
||||
|
||||
```
|
||||
see more examples on the Fiddle: http://jsfiddle.net/KHFn8/2971/
|
||||
|
||||
##Native Validation Rules
|
||||
**Required**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ required: true });
|
||||
```
|
||||
**Min**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ min: 2 });
|
||||
```
|
||||
**Max**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ max: 99 });
|
||||
```
|
||||
**MinLength**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ minLength: 3 });
|
||||
```
|
||||
**MaxLength**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ maxLength: 12 });
|
||||
```
|
||||
**Email**:
|
||||
|
||||
```javascript
|
||||
var myObj = ko.observable('').extend({ email: true });
|
||||
```
|
||||
|
||||
... and [MANY MORE](https://github.com/Knockout-Contrib/Knockout-Validation/wiki/Native-Rules)
|
||||
|
||||
_Much thanks to the [jQuery Validation Plug-In](https://github.com/jzaefferer/jquery-validation) team for their work on many of the rules_
|
||||
##Custom Validation Rules
|
||||
####Custom Rules
|
||||
Custom Rules can be created using the simple example below. All you need is to define a validator function and a default message.
|
||||
The validator function takes in the observable's value, and the `params` that you pass in with the `extend` method.
|
||||
|
||||
```javascript
|
||||
ko.validation.rules['mustEqual'] = {
|
||||
validator: function (val, otherVal) {
|
||||
return val === otherVal;
|
||||
},
|
||||
message: 'The field must equal {0}'
|
||||
};
|
||||
ko.validation.registerExtenders();
|
||||
|
||||
//the value '5' is the second arg ('otherVal') that is passed to the validator
|
||||
var myCustomObj = ko.observable().extend({ mustEqual: 5 });
|
||||
```
|
||||
Learn more about Custom Rules on the [WIKI](https://github.com/Knockout-Contrib/Knockout-Validation/wiki/Custom-Validation-Rules)
|
||||
|
||||
###Or Check out our [User-Contributed Custom Rules](https://github.com/Knockout-Contrib/Knockout-Validation/wiki/User-Contributed-Rules)!###
|
||||
|
||||
##HTML5 Validation Attributes
|
||||
|
||||
**Required**:
|
||||
|
||||
```html
|
||||
<input type="text" data-bind="value: myProp" required />
|
||||
```
|
||||
|
||||
**Min**:
|
||||
|
||||
```html
|
||||
<input type="number" data-bind="value: myProp" min="2" />
|
||||
<input type="week" data-bind="value:myWeek" min="2012-W03" />
|
||||
<input type="month" data-bind="value:myMonth" min="2012-08" />
|
||||
```
|
||||
|
||||
**Max**:
|
||||
|
||||
```html
|
||||
<input type="number" data-bind="value: myProp" max="99" />
|
||||
<input type="week" data-bind="value:myWeek" max="2010-W15" />
|
||||
<input type="month" data-bind="value:myMonth" min="2012-08" />
|
||||
```
|
||||
|
||||
**Pattern**:
|
||||
|
||||
```html
|
||||
<input type="text" data-bind="value: myProp" pattern="^[a-z0-9].*" />
|
||||
```
|
||||
|
||||
**Step**:
|
||||
|
||||
```html
|
||||
<input type="text" data-bind="value: myProp" step="3" />
|
||||
```
|
||||
**Special Note, the 'MinLength' attribute was removed until the HTML5 spec fully supports it**
|
||||
|
||||
##Knockout Bindings
|
||||
|
||||
###ValidationMessage
|
||||
If you want to customize the display of your objects validation message, use the `validationMessage` binding:
|
||||
|
||||
```html
|
||||
<div>
|
||||
<input type="text" data-bind="value: someValue"/>
|
||||
<p data-bind="validationMessage: someValue"></p>
|
||||
<div>
|
||||
```
|
||||
Check out more on [Validation Bindings](https://github.com/Knockout-Contrib/Knockout-Validation/wiki/Validation-Bindings)
|
||||
|
||||
##Remote Validation Rules
|
||||
Check out our [Async Validation](https://github.com/Knockout-Contrib/Knockout-Validation/wiki/Async-Rules) and [jQuery AJAX Validation](https://github.com/ericmbarnard/Knockout-Validation/wiki/Async-Rules)
|
||||
|
||||
##Localization
|
||||
|
||||
Add a reference to the localization js files after the Knockout Validation plugin
|
||||
|
||||
```html
|
||||
<script type="text/javascript" src="knockout.validation.js"></script>
|
||||
<script type="text/javascript" src="el-GR.js"></script>
|
||||
<script type="text/javascript" src="fr-FR.js"></script>
|
||||
<script type="text/javascript" src="de-DE.js"></script>
|
||||
```
|
||||
|
||||
Apply localized messages
|
||||
|
||||
```js
|
||||
ko.validation.locale('el-GR');
|
||||
```
|
||||
Reference in New Issue
Block a user