Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow user to define element other than map container for full screen control #7548

Merged
merged 4 commits into from
Nov 13, 2018
Merged

Allow user to define element other than map container for full screen control #7548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ac4092
Allow user to define element other than map container for full screen…
Nov 2, 2018
9dfd431
Add warning for non DOM element sources
Nov 8, 2018
d5da51e
Use 'container' instead of 'source' for option name
Nov 13, 2018
97baa5d
Add unit test
Nov 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 33 additions & 19 deletions src/ui/control/fullscreen_control.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,40 @@ import window from '../../util/window';

import type Map from '../map';

type Options = {
container?: HTMLElement
};

/**
* A `FullscreenControl` control contains a button for toggling the map in and out of fullscreen mode.
*
* @implements {IControl}
* @param {Object} [options]
* @param {HTMLElement} [options.container] `container` is the [compatible DOM element](https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullScreen#Compatible_elements) which should be made full screen. By default, the map container element will be made full screen.
*
* @example
* map.addControl(new mapboxgl.FullscreenControl());
* map.addControl(new mapboxgl.FullscreenControl({container: document.querySelector('body')}));
* @see [View a fullscreen map](https://www.mapbox.com/mapbox-gl-js/example/fullscreen/)
*/

class FullscreenControl {
_map: Map;
_mapContainer: HTMLElement;
_container: HTMLElement;
_controlContainer: HTMLElement;
_fullscreen: boolean;
_fullscreenchange: string;
_fullscreenButton: HTMLElement;
_className: string;
_container: HTMLElement;

constructor() {
constructor(options: Options) {
this._fullscreen = false;
if (options && options.container) {
if (options.container instanceof window.HTMLElement) {
this._container = options.container;
} else {
warnOnce('Full screen control \'container\' must be a DOM element.');
}
}
bindAll([
'_onClickFullscreen',
'_changeIcon'
Expand All @@ -45,19 +59,19 @@ class FullscreenControl {

onAdd(map: Map) {
this._map = map;
this._mapContainer = this._map.getContainer();
this._container = DOM.create('div', `${this._className} mapboxgl-ctrl-group`);
if (!this._container) this._container = this._map.getContainer();
this._controlContainer = DOM.create('div', `${this._className} mapboxgl-ctrl-group`);
if (this._checkFullscreenSupport()) {
this._setupUI();
} else {
this._container.style.display = 'none';
this._controlContainer.style.display = 'none';
warnOnce('This device does not support fullscreen mode.');
}
return this._container;
return this._controlContainer;
}

onRemove() {
DOM.remove(this._container);
DOM.remove(this._controlContainer);
this._map = (null: any);
window.document.removeEventListener(this._fullscreenchange, this._changeIcon);
}
Expand All @@ -72,7 +86,7 @@ class FullscreenControl {
}

_setupUI() {
const button = this._fullscreenButton = DOM.create('button', (`${this._className}-icon ${this._className}-fullscreen`), this._container);
const button = this._fullscreenButton = DOM.create('button', (`${this._className}-icon ${this._className}-fullscreen`), this._controlContainer);
button.setAttribute("aria-label", "Toggle fullscreen");
button.type = 'button';
this._fullscreenButton.addEventListener('click', this._onClickFullscreen);
Expand All @@ -90,7 +104,7 @@ class FullscreenControl {
(window.document: any).webkitFullscreenElement ||
(window.document: any).msFullscreenElement;

if ((fullscreenElement === this._mapContainer) !== this._fullscreen) {
if ((fullscreenElement === this._container) !== this._fullscreen) {
this._fullscreen = !this._fullscreen;
this._fullscreenButton.classList.toggle(`${this._className}-shrink`);
this._fullscreenButton.classList.toggle(`${this._className}-fullscreen`);
Expand All @@ -108,14 +122,14 @@ class FullscreenControl {
} else if (window.document.webkitCancelFullScreen) {
(window.document: any).webkitCancelFullScreen();
}
} else if (this._mapContainer.requestFullscreen) {
this._mapContainer.requestFullscreen();
} else if ((this._mapContainer: any).mozRequestFullScreen) {
(this._mapContainer: any).mozRequestFullScreen();
} else if ((this._mapContainer: any).msRequestFullscreen) {
(this._mapContainer: any).msRequestFullscreen();
} else if ((this._mapContainer: any).webkitRequestFullscreen) {
(this._mapContainer: any).webkitRequestFullscreen();
} else if (this._container.requestFullscreen) {
this._container.requestFullscreen();
} else if ((this._container: any).mozRequestFullScreen) {
(this._container: any).mozRequestFullScreen();
} else if ((this._container: any).msRequestFullscreen) {
(this._container: any).msRequestFullscreen();
} else if ((this._container: any).webkitRequestFullscreen) {
(this._container: any).webkitRequestFullscreen();
}
}
}
Expand Down
17 changes: 16 additions & 1 deletion test/unit/ui/control/fullscreen.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test('FullscreenControl appears when fullscreen is enabled', (t) => {
t.end();
});

test('FullscreenControl does not appears when fullscreen is not enabled', (t) => {
test('FullscreenControl does not appear when fullscreen is not enabled', (t) => {
window.document.fullscreenEnabled = false;

const consoleWarn = t.stub(console, 'warn');
Expand All @@ -27,3 +27,18 @@ test('FullscreenControl does not appears when fullscreen is not enabled', (t) =>
t.equal(consoleWarn.getCall(0).args[0], 'This device does not support fullscreen mode.');
t.end();
});

test('FullscreenControl makes optional container element full screen', (t) => {
window.document.fullscreenEnabled = true;

const map = createMap(t);
const fullscreen = new FullscreenControl({container: window.document.querySelector('body')});
map.addControl(fullscreen);
const control = map._controls.find((ctrl) => {
return ctrl.hasOwnProperty('_fullscreen');
});
control._onClickFullscreen();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe set a spy on body.requestFullscreen and then check t.calledOnce after this?

Copy link
Contributor Author

@ryanhamley ryanhamley Nov 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be missing something but it doesn't seem like JSDOM supports the Full Screen API. I don't see any documentation or code that mentions it and window.document.requestFullScreen and body.requestFullScreen are both undefined (along with their prefixed alternatives) in the context of the test suite.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh ok nvm then!


t.equal(control._container.tagName, 'BODY');
t.end();
});