Skip to content

Commit

Permalink
Fix type definition
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Jan 19, 2020
1 parent 38eeb42 commit f0a14a3
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 11 deletions.
2 changes: 1 addition & 1 deletion dist/screenfull.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ declare namespace screenfull {
}
```
*/
readonly isEnabled: boolean;
readonly isEnabled: true;

/**
Exposes the raw properties (prefixed if needed) used internally.
Expand Down
2 changes: 1 addition & 1 deletion dist/screenfull.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*!
* screenfull
* v5.0.0 - 2019-09-09
* v5.0.1 - 2020-01-19
* (c) Sindre Sorhus; MIT License
*/
(function () {
Expand Down
2 changes: 1 addition & 1 deletion dist/screenfull.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Simple wrapper for cross-browser usage of the JavaScript Fullscreen API, which lets you bring the page or any element into fullscreen.",
"license": "MIT",
"repository": "sindresorhus/screenfull.js",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "[email protected]",
Expand Down
8 changes: 1 addition & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Simple wrapper for cross-browser usage of the JavaScript [Fullscreen API](https://developer.mozilla.org/en/DOM/Using_full-screen_mode), which lets you bring the page or any element into fullscreen. Smoothens out the browser implementation differences, so you don't have to.
**This package is feature complete. No new changes will be accepted.**
**This package is feature complete. No new features will be accepted.**

#### [Demo](https://sindresorhus.com/screenfull.js)

Expand Down Expand Up @@ -50,7 +50,6 @@ $ npm install screenfull

Also available on [cdnjs](https://cdnjs.com/libraries/screenfull.js).


## Why?

### Screenfull
Expand Down Expand Up @@ -86,7 +85,6 @@ if (document.fullscreenEnabled) {
// This is not even entirely comprehensive. There's more.
```


## Support

[Supported browsers](http://caniuse.com/fullscreen)
Expand All @@ -95,7 +93,6 @@ if (document.fullscreenEnabled) {

**Note:** Safari is supported on desktop and iPad, but not on iPhone. This is a limitation in the browser, not in Screenfull.


## Documentation

### Examples
Expand Down Expand Up @@ -207,7 +204,6 @@ export class ToggleFullscreenDirective {
<button toggleFullscreen>Toggle fullscreen<button>
```


### API

#### .request()
Expand Down Expand Up @@ -268,7 +264,6 @@ Returns a boolean whether you are allowed to enter fullscreen. If your page is i

Exposes the raw properties (prefixed if needed) used internally: `requestFullscreen`, `exitFullscreen`, `fullscreenElement`, `fullscreenEnabled`, `fullscreenchange`, `fullscreenerror`


## FAQ

### How can I navigate to a new page when fullscreen?
Expand All @@ -295,7 +290,6 @@ $('#new-page-btn').click(() => {
});
```


## Resources

- [Using the Fullscreen API in web browsers](http://hacks.mozilla.org/2012/01/using-the-fullscreen-api-in-web-browsers/)
Expand Down
2 changes: 1 addition & 1 deletion src/screenfull.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ declare namespace screenfull {
}
```
*/
readonly isEnabled: boolean;
readonly isEnabled: true;

/**
Exposes the raw properties (prefixed if needed) used internally.
Expand Down

0 comments on commit f0a14a3

Please sign in to comment.