Permalink
Browse files

Initial commit

  • Loading branch information...
bdougherty committed Aug 26, 2012
0 parents commit 25f1876a799255b217c81229c8189e9f305869fe
Showing with 1,091 additions and 0 deletions.
  1. +202 −0 LICENSE
  2. +157 −0 README.md
  3. +320 −0 bigscreen.js
  4. +327 −0 dist/bigscreen.js
  5. +7 −0 dist/bigscreen.min.js
  6. +53 −0 grunt.js
  7. +25 −0 package.json
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
157 README.md
@@ -0,0 +1,157 @@
+# BigScreen
+
+A simple library for using the JavaScript Full Screen API.
+
+
+## Why should I use it?
+
+### Before BigScreen
+
+```js
+if (element.requestFullscreen) {
+ element.requestFullscreen();
+}
+else if (element.webkitRequestFullscreen) {
+ element.webkitRequestFullscreen();
+}
+else if (element.webkitRequestFullScreen) {
+ element.webkitRequestFullScreen();
+}
+else if (element.mozRequestFullScreen) {
+ element.mozRequestFullScreen();
+}
+```
+
+## After BigScreen
+
+```js
+BigScreen.request(element);
+```
+
+BigScreen also smoothes out a couple browser bugs for you (the real before code is a little more complicated).
+
+
+## Download
+
+BigScreen is ~1 kb minified and gzipped. [Download it now](https://raw.github.com/bdougherty/BigScreen/master/dist/bigscreen.min.js).
+
+
+## Supported Browsers
+
+* Chrome 15+
+* Firefox 10+
+* Safari 5.1+
+
+These browsers are also supported for video only:
+
+* Safari 5.0
+
+
+## How do I use it?
+
+### Put the entire page in full screen
+
+```js
+document.getElementById('button').addEventListener('click', function() {
+ if (BigScreen.enabled) {
+ BigScreen.toggle();
+ }
+ else {
+ // fallback
+ }
+}, false);
+```
+
+### Put any element in full screen
+
+```js
+var element = document.getElementById('target');
+
+document.getElementById('button').addEventListener('click', function() {
+ if (BigScreen.enabled) {
+ BigScreen.request(element);
+ // You could also use .toggle(element)
+ }
+ else {
+ // fallback for browsers that don't support full screen
+ }
+}, false);
+```
+
+### Detecting full screen changes
+
+```js
+BigScreen.onenter = function() {
+ // called when entering full screen
+}
+
+BigScreen.onexit = function() {
+ // called when exiting full screen
+}
+```
+
+
+## [Demo](http://brad.is/coding/BigScreen/)
+
+
+## Documentation
+
+### BigScreen.request(element)
+
+Request that an element go into full screen. If the element is `null` or `undefined`, the `documentElement` will be used instead.
+
+You can only call this from a user-initiated event, otherwise the browser will deny the request. That means click, key, or touch events.
+
+In addition, if your page is inside an `<iframe>` it will need to have the `allowfullscreen` (and `webkitallowfullscreen` and `mozallowfullscreen`) attribute set on the `<iframe>`.
+
+Finally, BigScreen will try to fall back to full screen for `<video>` if there is a child `<video>` in the element you pass and the browser supports it (see `BigScreen.videoEnabled)`). If BigScreen falls back, it will automatically load and play the video.
+
+### BigScreen.exit()
+
+Will exit full screen. Note that if there are multiple elements in full screen, only the last one will exit full screen.
+
+### BigScreen.toggle(element)
+
+Will request full screen if there is no element in full screen, otherwise it will exit full screen.
+
+### BigScreen.onenter()
+
+Override to get notified when an element enters full screen. `BigScreen.element` will be set to the element that is entering full screen.
+
+### BigScreen.onexit()
+
+Override to get notified when fully exiting full screen (there are no more elements in full screen).
+
+### BigScreen.element
+
+Set to the element that is currently displaying full screen, or `null` if no element is in full screen.
+
+### BigScreen.enabled
+
+A boolean that will tell you if it is possible to go into full screen. If your page is in an `<iframe>` it will need to have the `allowfullscreen` attribute set or this will be `false`.
+
+### BigScreen.videoEnabled(video)
+
+Safari 5.0 and iOS 4.2+ support putting `<video>` into full screen. `BigScreen.enabled` will report `false` in those browsers, but you can use this to check for `<video> `full screen support by passing the `<video>` itself, or an ancestor.
+
+This function will report `false` if there is no child `<video>`, or if it is not possible to put a `<video>` in full screen. It will report `'maybe'` if the video's metadata has not been loaded, and `true` if it will be able to enter full screen.
+
+
+## Known Issues
+
+There is currently a bug in WebKit that causes the `webkitfullscreenchange` event to fire incorrectly when inside an `iframe`. BigScreen is able to work around the issue though. ([Chrome Bug](http://code.google.com/p/chromium/issues/detail?id=138368), Safari Bug: rdar://problem/11927884)
+
+Safari 6.0 does not work properly when putting multiple elements into full screen. [Open Radar bug report](http://openradar.appspot.com/radar?id=1878403).
+
+
+## Links
+
+* [Using the Fullscreen API in web browsers](http://hacks.mozilla.org/2012/01/using-the-fullscreen-api-in-web-browsers/)
+* [Using HTML5's Fullscreen API for Fun and Profit](http://sorcery.smugmug.com/2012/06/06/using-html5s-fullscreen-api-for-fun-and-profit/)
+* [Using full-screen mode - MDN](https://developer.mozilla.org/en/DOM/Using_full-screen_mode)
+* [Fullscreen Specification - W3C](http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html)
+
+
+## License
+
+BigScreen is licensed under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) license. Copyright 2012 Brad Dougherty.
Oops, something went wrong.

0 comments on commit 25f1876

Please sign in to comment.