Skip to content

Commit

Permalink
Rename screenfull.enabled to screenfull.isEnabled
Browse files Browse the repository at this point in the history
  • Loading branch information
@sindresorhus
sindresorhus committed Sep 4, 2019
1 parent 927e361 commit 9b98fcc
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 32 deletions.
16 changes: 8 additions & 8 deletions dist/screenfull.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ declare namespace screenfull {
@example
```
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
}
```
*/
readonly enabled: boolean;
readonly isEnabled: boolean;

/**
Exposes the raw properties (prefixed if needed) used internally.
Expand All @@ -54,7 +54,7 @@ declare namespace screenfull {
```
// Fullscreen the page
document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
} else {
// Ignore or do something else
Expand All @@ -65,7 +65,7 @@ declare namespace screenfull {
const element = document.getElementById('target');
document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -74,7 +74,7 @@ declare namespace screenfull {
const element = $('#target')[0]; // Get DOM element from jQuery collection
$('#button').on('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -99,7 +99,7 @@ declare namespace screenfull {
// Toggle fullscreen on a image with jQuery
$('img').on('click', event => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.toggle(event.target);
}
});
Expand All @@ -113,14 +113,14 @@ declare namespace screenfull {
@example
```
// Detect fullscreen change
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('change', () => {
console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');
});
}
// Detect fullscreen error
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('error', event => {
console.error('Failed to enable fullscreen', event);
});
Expand Down
2 changes: 1 addition & 1 deletion dist/screenfull.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
return document[fn.fullscreenElement];
}
},
enabled: {

This comment has been minimized.

# to view

Copy link
@barongello

barongello Sep 11, 2019

Thanks for breaking all softwares out there that uses CDN without deprecation warning and such!

This comment has been minimized.

# to view

Copy link
@kevva

kevva Sep 11, 2019 •
edited
Loading

I hope you are using a CDN that serves versioned packages. Why should a module author have to take how different CDN:s serves their packages into consideration?

This comment has been minimized.

# to view

Copy link
@sindresorhus

sindresorhus Sep 12, 2019

Author Owner

Screenfull follows semver and this version was released as a major version: https://github.com/sindresorhus/screenfull.js/releases/tag/v5.0.0

If you're just using a CDN version directly from master, it's really all on you.

The recommended CDN is versioned, so I'm not breaking "every software out there": https://cdnjs.com/libraries/screenfull.js
isEnabled: {
enumerable: true,
get: function () {
// Coerce to boolean in case of old WebKit
Expand Down
2 changes: 1 addition & 1 deletion dist/screenfull.min.js
View file

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

4 changes: 2 additions & 2 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ <h1>screenfull<span>.js</span></h1>
<script src="src/screenfull.js"></script>
<script>
$(function () {
$('#supported').text('Supported/allowed: ' + !!screenfull.enabled);
$('#supported').text('Supported/allowed: ' + !!screenfull.isEnabled);

if (!screenfull.enabled) {
if (!screenfull.isEnabled) {
return false;
}

Expand Down
18 changes: 9 additions & 9 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Also available on [cdnjs](https://cdnjs.com/libraries/screenfull.js).
### Screenfull

```js
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
}
```
Expand Down Expand Up @@ -78,7 +78,7 @@ if (document.fullscreenEnabled) {

```js
document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
} else {
// Ignore or do something else
Expand All @@ -92,7 +92,7 @@ document.getElementById('button').addEventListener('click', () => {
const element = document.getElementById('target');

document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -104,7 +104,7 @@ document.getElementById('button').addEventListener('click', () => {
const element = $('#target')[0]; // Get DOM element from jQuery collection

$('#button').on('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -114,7 +114,7 @@ $('#button').on('click', () => {

```js
$('img').on('click', event => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.toggle(event.target);
}
});
Expand All @@ -123,7 +123,7 @@ $('img').on('click', event => {
#### Detect fullscreen change

```js
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('change', () => {
console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');
});
Expand All @@ -139,7 +139,7 @@ screenfull.off('change', callback);
#### Detect fullscreen error

```js
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('error', event => {
console.error('Failed to enable fullscreen', event);
});
Expand Down Expand Up @@ -170,7 +170,7 @@ import screenfull = require('screenfull');
})
export class ToggleFullscreenDirective {
@HostListener('click') onClick() {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.toggle();
}
}
Expand Down Expand Up @@ -234,7 +234,7 @@ Returns a boolean whether fullscreen is active.

Returns the element currently in fullscreen, otherwise `null`.

#### .enabled
#### .isEnabled

Returns a boolean whether you are allowed to enter fullscreen. If your page is inside an `<iframe>` you will need to add a `allowfullscreen` attribute (+ `webkitallowfullscreen` and `mozallowfullscreen`).

Expand Down
16 changes: 8 additions & 8 deletions src/screenfull.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ declare namespace screenfull {
@example
```
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
}
```
*/
readonly enabled: boolean;
readonly isEnabled: boolean;

/**
Exposes the raw properties (prefixed if needed) used internally.
Expand All @@ -54,7 +54,7 @@ declare namespace screenfull {
```
// Fullscreen the page
document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request();
} else {
// Ignore or do something else
Expand All @@ -65,7 +65,7 @@ declare namespace screenfull {
const element = document.getElementById('target');
document.getElementById('button').addEventListener('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -74,7 +74,7 @@ declare namespace screenfull {
const element = $('#target')[0]; // Get DOM element from jQuery collection
$('#button').on('click', () => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Expand All @@ -99,7 +99,7 @@ declare namespace screenfull {
// Toggle fullscreen on a image with jQuery
$('img').on('click', event => {
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.toggle(event.target);
}
});
Expand All @@ -113,14 +113,14 @@ declare namespace screenfull {
@example
```
// Detect fullscreen change
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('change', () => {
console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');
});
}
// Detect fullscreen error
if (screenfull.enabled) {
if (screenfull.isEnabled) {
screenfull.on('error', event => {
console.error('Failed to enable fullscreen', event);
});
Expand Down
2 changes: 1 addition & 1 deletion src/screenfull.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
return document[fn.fullscreenElement];
}
},
enabled: {
isEnabled: {
enumerable: true,
get: function () {
// Coerce to boolean in case of old WebKit
Expand Down
4 changes: 2 additions & 2 deletions src/screenfull.test-d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import screenfull = require('..');
import {RawEventNames} from '..';

if (screenfull) {
expectType<boolean>(screenfull.enabled);
expectType<boolean>(screenfull.isEnabled);
expectType<boolean>(screenfull.isFullscreen);
expectType<Element | null>(screenfull.element);

if (screenfull.enabled) {
if (screenfull.isEnabled) {
const element: Element = document.getElementById('target')!;

expectType<Promise<void>>(screenfull.request());
Expand Down

0 comments on commit 9b98fcc

Please # to comment.