Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 5.57 KB

README.md

File metadata and controls

87 lines (58 loc) · 5.57 KB
Raw

mdn-browser-compat-data

https://github.com/mdn/browser-compat-data

This repository contains compatibility data for Web technologies. Browser compatibility data describes which platforms (where "platforms" are usually, but not always, web browsers) support particular Web APIs.

This data can be used in documentation, to build compatibility tables listing browser support for APIs. For example: Browser support for WebExtension APIs.

npm Build Status Twitter Follow

Maintained by the MDN team at Mozilla.

Installation

You can install mdn-browser-compat-data as a node package (tutorial).

npm install mdn-browser-compat-data

Usage

const bcd = require('mdn-browser-compat-data');
bcd.css.properties.background;
// returns a compat data object (see schema)

Repository contents

There's a top-level directory for each broad area covered: for example, "http", "javascript", "webextensions". Inside each of these directories is one or more JSON file containing the compatibility data.

Please note that we have not (yet) migrated all compatibility data from the MDN wiki pages into this repository.

  • api/ contains data for each Web API interface.

  • css/ contains data for CSS properties, selectors and at-rules.

  • html/ contains data for HTML elements, attributes and global attributes.

  • http/ contains data for HTTP headers, statuses and methods.

  • javascript/ contains data for JavaScript built-in Objects, statement, operators and or other ECMAScript language features.

  • webdriver/ contains data for WebDriver commands.

  • webextensions/ contains data for WebExtensions JavaScript APIs and manifest keys.

  • svg/ contains data for SVG elements, attributes and global attributes.

Format of the browser compat json files

The definitive description of the format used to represent compatibility data is the schema file. You can also have a look at the schema documentation.

Please note that we do not (yet) guarantee the stability of the data format. You're welcome to use the data, but its structure is subject to change without notice.

Issues?

If you find a problem, please file a bug.

Contributing

We're very happy to accept contributions to this data. Please familiarize yourself with the schema and send us a pull request. See also the Contributing file for more information.

Browser compatibility tables on MDN

It takes 1-2 weeks for changes in this data to be reflected in MDN's browser compatibility tables. The process is:

  1. A pull request is reviewed and merged to master.
  2. A new release of mdn-browser-compat-data is created by MDN staff. This happens every 4-14 days.
  3. A new image of Kumascript, which includes the BCD release, is built and deployed to production. This happens within a day of the npm package release.
  4. The MDN page using the data is regenerated. For newly converted pages, a staff member switches to the {{Compat} macro, and re-checks the conversion. For updates to converted pages, a logged-in MDN user force-refreshes the page to regenerate it.

Projects using the data

Here are some projects using the data, as an npm module or directly:

  • Compat Report - Firefox Add-on that shows compatibility data for the current site in the developer tools.
  • compat-tester - Scan local documents for compatibility issues.
  • mdncomp - View compatibility data on the command line.