Adam / webapp_admin

Blame view

static/plugins/webshim-gh-pages/readme.md 4.8 KB
edit raw normal view history
831eac332   zhuzhenchao   add file 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
  **Important note: Webshim is not compatible with upcoming jQuery 3.x and I do not plan to work on a new major version. I will still fix critical bugs in the future though.**
  
  [Webshim](http://aFarkas.github.com/webshim/demos/index.html)
  ================================
  
  _The polyfilling, capability based loading JavaScript Library_
  
  
  General Principles
  ------------------
  * HTML5 compliant: correctly and accurately implemented (HTML5) Markup-, JS- and DOM-APIs  
  * capability based loading: extremely lightweight in modern browsers
  * cross-browser support: All A-Graded browsers including latest version of Opera are tested
  * extendable: if we have not implemented a feature you want, you can easily implement it on your own
  
  
  Features
  ------------------
  * canvas
  * HTML5 form features including: constraint validation and form widgets (input[type="range"], input[type="date"], input[type="number"], input[type="time"], input[type="month"], output, progress, input[list]/datalist)
  * HTML5 audio/video/track implementation
  * matchMedia
  * interactive elements: summary/details
  * XHR2 / filereader (including, XHR2/AJAX CORS and FormData handling)
  * picture / img[srcset]
  * promise
  * geolocation
  * ECMAScript 5 / JavaScript 1.8.5 features
  * window.URL
  * getUserMedia ('usermedia' currently only access to user's camera, not microphone)
  * sticky (position: sticky)
  
  
  Installation and Usage
  ------------------
  
  1 - [Download the Webshim Lib](https://github.com/aFarkas/webshim/releases/latest) and put the `js-webshim` folder in your project.
  
  2 - Include the JavaScript:
  
  ```html
  <script src="js/jquery.js"></script>
  
  <script src="js-webshim/minified/polyfiller.js"></script> 
  
  <script> 
  	// load and implement all unsupported features 
  	webshims.polyfill();
  		
  	// or only load a specific feature
  	//webshims.polyfill('forms es5');
  </script>
  ```
  
  
  3 - Wait till everything has been loaded and then use it:
  
  ```html
  <script> 
  	$(function(){
  		// work with the HTML5 API
  		$('input:invalid').each(function(){
  		    $(this).after( $.prop(this, 'validationMessage') );
  		});
  		// ...
  	});
  </script>
  ```
  
  
   [More information and demos](http://aFarkas.github.com/webshim/demos/index.html).
  
  
   Download via bower
   ------------------
  
   ``bower install webshim --save-dev``
  
  
  License
  ---------------------------------------
  
  The Webshims Lib core is licensed under the [MIT-License](http://aFarkas.github.com/webshim/MIT-LICENSE.txt). 
  
  Webshims Lib uses many great third party scripts:
  
  | Script          | License                                      | URL                                                                           |
  |:--------------- |:-------------------------------------------- |:----------------------------------------------------------------------------- |
  | flashcanvas     | MIT                                          | http://code.google.com/p/flashcanvas                                          |
  | flashcanvaspro  | closed                                       | http://flashcanvas.net                                                        |
  | Jaris FLV       | GPL 3.0                                      | http://jarisflvplayer.org                                                     |
  | excanvas        | Apache License 2.0                           | http://excanvas.sourceforge.net                                               |
  | moxie           | GPL 3.0                                      | https://github.com/moxiecode/moxie                                            |
  | es5             | MIT                                          | https://github.com/280north/narwhal                                           |
  | swfmini         | MIT                                          | https://code.google.com/p/swfobject                                           |
  | track           | BSD 2 clause                                 | https://github.com/cgiffard/Captionator                                       |
  | color-picker    | MIT                                          | http://johndyer.name/post/2007/09/PhotoShop-like-JavaScript-Color-Picker.aspx |
  | forms-picker    | MIT                                          | https://github.com/brandonaaron/jquery-mousewheel                             |
  | jme.woff        | GPL / CC BY 3.0                              | http://icomoon.io/#preview-free                                               |
  | picture         | MIT                                          | https://github.com/scottjehl/picturefill                                      |
  | url             | any (OSI approved) Open Source licence       | https://github.com/inexorabletash/polyfill                                    |
  
  
  
  
  Questions?
  ----------
  
  If you have any questions, please feel free to ask them on [stackoverflow.com/questions/tagged/webshim](http://stackoverflow.com/questions/tagged/webshim).
  
  **Please tag your questions with 'webshim'.**