Feature status
Warning:
Do not manually update the feature statuses in mdn/content
repository.
The documentation source is automatically updated from information in the GitHub mdn/browser-compat-data
repository
A feature status broadly indicates the cross-browser implementation and standardization state of a particular web platform feature, such as a Web API method or CSS property. It is one of the following:
If none of the above statuses apply, the feature is considered stable and standard feature. For more information on these terms, see the "Experimental, deprecated, and obsolete" page.
For information on how the status for a feature is determined, see the choosing status properties section in the @mdn/browser-compat-data
(BCD) repository.
How feature statuses are added or updated?
The feature statuses of all the features documented on MDN are tracked in its accompanying @mdn/browser-compat-data (BCD) repository. An automation automatically updates the statuses in the mdn/content
repository whenever a new version of BCD is released.
The automation uses browser-compat
key in the front-matter. The key stores BCD query required to locate the feature in the compatibility data. If the browser-compat
key has multiple values then the automation uses only the first value to render status macros.
Note:
To update a feature's status in the MDN content, you need to submit a pull request in the BCD repository. After your changes are approved and merged in BCD, an automated pull request updates the statuses in the mdn/content
repository.
How are feature statuses specified in content?
The following sections document the mechanisms that are used to insert and render feature status information in MDN documents. As mentioned, these should be considered read-only, as their inclusion in the content is automated.
Feature status icons in sidebars
The status
property in page front-matter is used to generate status icons for features when they are displayed in sidebars.
---
title: Feature name
status:
- deprecated
- experimental
- non-standard
browser-compat: api.feature
---
Feature status page banners
The following macros are used to render the status banners in page headers:
{{Deprecated_Header}}
-
For
deprecated
status. It generates a Deprecated status banner:Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
{{SeeCompatTable}}
-
For
experimental
status. It generates an Experimental status banner:Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production. {{Non-standard_Header}}
-
For
non-standard
status. It generates a Non-Standard status banner:Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
Feature status icons in definition lists
The following macros are used to render inline status icons next to definition list items:
{{Experimental_Inline}}
icon: Experimental{{Non-standard_Inline}}
icon: Non-standard{{Deprecated_Inline}}
icon: Deprecated
If a web feature page has status banners then the inline macros of same statuses are used explicitly for each member/value of the feature in the definition list.
For example, if a page is marked experimental using {{SeeCompatTable}}
then each member/value of the feature is explicitly marked experimental using {{Experimental_Inline}}
macro in the definition list.