diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /devtools/client/shared/devices.js | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip |
Add m-esr52 at 52.6.0
Diffstat (limited to 'devtools/client/shared/devices.js')
-rw-r--r-- | devtools/client/shared/devices.js | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/devtools/client/shared/devices.js b/devtools/client/shared/devices.js new file mode 100644 index 000000000..82bd493c4 --- /dev/null +++ b/devtools/client/shared/devices.js @@ -0,0 +1,88 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +"use strict"; + +const { getJSON } = require("devtools/client/shared/getjson"); + +const DEVICES_URL = "devtools.devices.url"; +const { LocalizationHelper } = require("devtools/shared/l10n"); +const L10N = new LocalizationHelper("devtools/client/locales/device.properties"); + +/* This is a catalog of common web-enabled devices and their properties, + * intended for (mobile) device emulation. + * + * The properties of a device are: + * - name: brand and model(s). + * - width: viewport width. + * - height: viewport height. + * - pixelRatio: ratio from viewport to physical screen pixels. + * - userAgent: UA string of the device's browser. + * - touch: whether it has a touch screen. + * - firefoxOS: whether Firefox OS is supported. + * + * The device types are: + * ["phones", "tablets", "laptops", "televisions", "consoles", "watches"]. + * + * You can easily add more devices to this catalog from your own code (e.g. an + * addon) like so: + * + * var myPhone = { name: "My Phone", ... }; + * require("devtools/client/shared/devices").addDevice(myPhone, "phones"); + */ + +// Local devices catalog that addons can add to. +let localDevices = {}; + +// Add a device to the local catalog. +function addDevice(device, type = "phones") { + let list = localDevices[type]; + if (!list) { + list = localDevices[type] = []; + } + list.push(device); +} +exports.addDevice = addDevice; + +// Remove a device from the local catalog. +// returns `true` if the device is removed, `false` otherwise. +function removeDevice(device, type = "phones") { + let list = localDevices[type]; + if (!list) { + return false; + } + + let index = list.findIndex(item => device); + + if (index === -1) { + return false; + } + + list.splice(index, 1); + + return true; +} +exports.removeDevice = removeDevice; + +// Get the complete devices catalog. +function getDevices() { + // Fetch common devices from Mozilla's CDN. + return getJSON(DEVICES_URL).then(devices => { + for (let type in localDevices) { + if (!devices[type]) { + devices.TYPES.push(type); + devices[type] = []; + } + devices[type] = localDevices[type].concat(devices[type]); + } + return devices; + }); +} +exports.getDevices = getDevices; + +// Get the localized string for a device type. +function getDeviceString(deviceType) { + return L10N.getStr("device." + deviceType); +} +exports.getDeviceString = getDeviceString; |