As documentation is moving forward, this page will be updated accordingly: APIs that are fully documented are pushed at the bottom of the page and ongoing documentation is put on top.

Ongoing documentation work

See the WebAPI doc schedule for details on our schedule for completing this content.

Update Required

API Name Entry Points Bugs Doc status Notes
Notification API Notification.get

Tag:
bug 899574 Needs update Not landed yet

Network APIs

API Name Entry Points Bugs Doc status Notes
ServiceWorker API Service Worker API
ServiceWorker
  none Spec: https://w3c.github.io/ServiceWorker/

Data Management APIs

API Name Entry Points Bugs Doc status Notes
IndexedDB window.indexedDB
IndexedDB root page: /IndexedDB
bug 553412 almost done The whole documentation lives under /IndexedDB. Shouldn't we moved it under /Web ?

We are waiting the end of the switch to WebIDL to update the documentation

Spec: http://www.w3.org/TR/IndexedDB/ (the draft is more accurate)

Other APIs

API Name Entry Points Bugs Doc status Notes
Progressive web apps Progressive web apps     Glossary: Progressive web apps

Implementation in progress

Those are APIs in progress. They are NOT ready to be documented yet.

API Name Entry Points Bugs Doc status Notes
AudioChannels   bug 1113086
bug 876631
none WikiMo: AudioChannels
DataStore   bug 871445 none WikiMo: DataStore
Virtual Keyboard API   bug 737110 none WikiMo: KeboardIME
WebNFC   bug 674741 none WikiMo: WebNFC
WebUSB   bug 674718 none WikiMo: WebUSB
Speaker Manager API   bug 854753 none WikiMo: unknown

Documentation complete

API Name Entry Points Bugs Doc status Notes
Ambient Light Events DeviceLightEvent
window.ondevicelight
devicelight event
Introductory article: Using Light Events

Tag:

Postoned documentation because the API is at risk:
LightLevelEvent
window.onlightlevel
lightlevel event
bug 738465
bug 842952
done Discussed with Doug Turner about the state of the spec and the implementation of LightLevelEvent: even if it's not implemented yet, we should document the LightLevelEvent interface

Discussed with Annvek the opportunity to drop LightLevelEvent from the spec.

Spec: http://www.w3.org/TR/ambient-light/ (the draft is more accurate)
MXR: DeviceLightEvent
Battery Status API navigator.battery
BatteryManager
chargingchange event
chargingtimechange event
dischargingtimechange event
levelchange event
Introductory article: Battery Status

Tag:
bug 678694 done Don't be fooled by the BatteryManager red link, it's just due to migration from DOM to Web/API within the domxref template.

Needs editorial review

Spec: http://www.w3.org/TR/battery-status/ (the draft is more accurate)
MXR: BatteryManager
Device Orientation DeviceOrientationEvent
DeviceMotionEvent
window.ondeviceorientation
window.ondevicemotion
deviceorientation event
devicemotion event
Introductory article: Detecting device orientation

Tag:

Unimplemented but in the spec
window.oncompassneedscalibration
compassneedscalibration event
bug 615597 done The introductory still need a quick technical review.

Spec: http://www.w3.org/TR/orientation-event/ (the draft is more accurate)
MXR: DeviceOrientationEvent, DeviceMotion
WikiMo: ScreenOrientation
FileHandle API FileHandle
LockedFile
FileRequest
Introductory article: FileHandle API

Tag:
bug 726593 done Still need technical review

IDBDatabase.mozCreateFileHandle need to be documented but it is not urgent as it is a transitory API and it does not do anything special (it's just a factory to get FileHandle objects)

Spec(?): http://dev.w3.org/2006/webapi/FileAPI/ http://w3c.github.io/filesystem-api/Overview.html
MXR: FileHandle, LockedFile, FileRequest
WikiMo: FileHandleAPI
Geolocation API NavigatorGeolocation (incl. methods/properties)
Geolocation (incl. methods/properties)
Position (incl. methods/properties)
Coordinates (incl. methods/properties)
PositionError (incl. methods/properties)
PositionOptions (incl. methods/properties)
Introductory article: Using geolocation

Tag:
  done Editorial review complete.

Spec: http://www.w3.org/TR/geolocation-API/

Maybe add basic examples?
Network Information API NetworkInformation.connection
NetworkInformation
Introductory article: Network Information

Tag:

bug 677166 bug 713199
bug 960426
 

done Spec: http://w3c.github.io/netinfo/
MXR: Connection
Notification API Notification
Introductory article: Using Web Notifications

Tag:
bug 782211 done Spec: http://www.w3.org/TR/notifications/ (W3C draft, WHATWG draft)
MXR: Notification
Pointer Lock API Element.requestPointerLock()
Document.pointerLockElement
Document.exitPointerLock()
MouseEvent
MouseEvent.movementX
MouseEvent.movementY
Introductory article: Pointer Lock API

Tag:
 
bug 633602 done Spec: http://www.w3.org/TR/pointerlock/ (the draft is more accurate)
Proximity Events DeviceProximityEvent
UserProximityEvent
window.ondeviceproximity
window.onuserproximity
deviceproximity event
userproximity event
Introductory article: Proximity API

Tag:
bug 738131 done Still needs some review here and there but it shouldn't be really troublesome.

Spec: http://www.w3.org/TR/proximity/ (the draft is more accurate)
Screen Orientation Screen.orientation
Screen.lockOrientation()
Screen.unlockOrientation()
Screen.onorientationchange
orientationchange event
Introductory article: Managing screen orientation

Tag:
bug 720794
bug 740188
bug 673922
done Spec: http://www.w3.org/TR/screen-orientation/
MXR: Screen
WikiMo: ScreenOrientation
Simple Push Notification API window.navigator.push
PushManager
Introductory article: Simple Push API

Tag:
bug 831816
bug 822712
---
See also :
bug 747907
bug 763198
done Simpler push API for B2G.

It seams it completely replace the original Push API (see bug 776501)

Spec: https://dvcs.w3.org/hg/push/raw-file/default/index.html
WikiMo: SimplePush
URL API URL
URL()
URL.createObjectURL()
URL.revokeObjectURL()
URLUtils
URLUtils.protocol
URLUtils.host
URLUtils.hostname
URLUtils.port
URLUtils.pathname
URLUtils.search
URLUtils.hash
URLUtils.username
URLUtils.password
URLUtils.origin
URLUtils.toString()
URLUtilsReadOnly
URLUtilsReadOnly.protocol
URLUtilsReadOnly.host
URLUtilsReadOnly.hostname
URLUtilsReadOnly.port
URLUtilsReadOnly.pathname
URLUtilsReadOnly.search
URLUtilsReadOnly.hash
URLUtilsReadOnly.toString()
Location (adaptation)
WorkerLocation (adaptation)
HTMLAnchorElement (adaptation)
HTMLAreaElement (adaptation)
URLQuery <--- not yet landed!!
Introductory article: none, pretty obvious

Tag:
bug 813253
bug 887364
bug 828261
bug 839912
bug 887836 (URLQuery)
done Spec: http://url.spec.whatwg.org/
Vibration API Navigator.vibrate()
Introductory article: Vibration

Tag:
bug 679966 done Spec: http://www.w3.org/TR/vibration/

Document status overview

Section Pages No tags Needs* tags Editorial reviews Technical reviews Outdated pages Dev-doc-needed bugs Documentation requests
API: CSSOM 162 n/a 49 (31%) 44 (28%) 64 (40%) 0 (0%) 7 (5%) 5 (4%)
API: Canvas 132 n/a 0 (0%) 4 (4%) 3 (3%) 10 (8%) 0 (0%) 0 (0%)
API: Device API 100 n/a 34 (34%) 7 (8%) 16 (16%) 0 (0%) 68 (68%) 2 (2%)
API: File API 35 n/a 2 (6%) 4 (12%) 4 (12%) 4 (12%) n/a 6 (18%)
API: Firefox OS APIs 677 3 (1%) 4 (1%) 5 (1%) 79 (12%) 1 (1%) n/a n/a
API: HTML API 446 n/a 117 (27%) 54 (13%) 126 (29%) 9 (3%) 74 (17%) 11 (3%)
API: IndexedDB 105 n/a 2 (2%) 3 (3%) 10 (10%) 0 (0%) 4 (4%) 16 (16%)
API: Intersection Observer 30 n/a 4 (14%) 2 (7%) 5 (17%) 23 (77%) n/a n/a
API: SVG API 148 n/a 112 (76%) 8 (6%) 13 (9%) 2 (2%) n/a 5 (4%)
API: ServiceWorkers 121 n/a 7 (6%) 5 (5%) 17 (15%) 0 (0%) 3 (3%) n/a
API: Web Animations 46 n/a 0 (0%) 1 (3%) 0 (0%) 0 (0%) 11 (24%) 0 (0%)
API: Web Authentication 34 n/a 0 (0%) 33 (98%) 33 (98%) 0 (0%) n/a n/a
API: WebAudio 224 n/a 4 (2%) 12 (6%) 48 (22%) 5 (3%) 7 (4%) 5 (3%)
API: WebCrypto 36 n/a 0 (0%) 0 (0%) 5 (14%) 0 (0%) n/a n/a
API: WebGL 293 n/a 2 (1%) 4 (2%) 9 (4%) 216 (74%) 1 (1%) n/a
API: WebRTC 356 n/a 24 (7%) 133 (38%) 156 (44%) 3 (1%) 25 (8%) 18 (6%)
API: WebSpeech 88 n/a 0 (0%) 0 (0%) 1 (2%) 0 (0%) n/a n/a
API: WebVR 103 n/a 0 (0%) 0 (0%) 0 (0%) 71 (69%) n/a n/a
API: WebWorkers 38 n/a 0 (0%) 1 (3%) 5 (14%) 0 (0%) 5 (14%) 3 (8%)
Total 3174 3 361 320 594 344 205 71

See also

Document Tags and Contributors

Contributors to this page: ExE-Boss, mdnwebdocs-bot, wbamberg, fscholz, jswisher, Sheppy, teoli
Last updated by: ExE-Boss,