機能の状態

機能の状態を追加または更新する方法

MDN で文書化されたすべての機能の状態は、付随する @mdn/browser-compat-data (BCD) リポジトリーで追跡されています。BCD の新しいバージョンがリリースされるたびに、自動化によって mdn/content リポジトリー内の状態が更新されます。

この自動化では、フロントマターの browser-compat キーを使用します。このキーには、互換性データから機能を探すために必要な BCD クエリーが格納されます。browser-compat キーに複数の値がある場合、状態マクロのレンダリングには最初の値のみが使用されます。

機能の状態はコンテンツでどのように指定するのか

以下では、 MDN 文書に機能の状態情報を挿入して表示するための仕組みについて説明します。前述のとおり、コンテンツへの挿入は自動化されているため、これらの仕組みは読み取り専用と考えてください。

サイドバーの機能の状態アイコン

ページのフロントマターの status プロパティは、サイドバーに表示される機能の状態アイコンを生成するために使用されます。

---
title: 機能名
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: api.feature
---

機能の状態のページバナー

以下のマクロは、ページヘッダーに状態バナーを表示するために使用します。

{{SeeCompatTable}}

experimental の状態です。これは実験的状態バナーを生成します。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

{{Non-standard_Header}}

non-standard の状態です。これは標準外状態バナーを生成します。

非標準: この機能は標準化されていません。非標準の機能はブラウザーの対応が限られ、将来的に変更または削除される可能性があるため、本番環境での使用は推奨されません。ただし、標準の選択肢が存在しない特定のケースでは、有効な代替手段となる場合があります。

定義リスト内の機能の状態アイコン

以下のマクロは、定義リストアイテムの横にインラインの状態アイコンを表示するために使用されます。

• {{Experimental_Inline}} アイコン:
• {{Non-standard_Inline}} アイコン:
• {{Deprecated_Inline}} アイコン:

ウェブ機能のページに状態バナーがある場合、同じ状態のインラインマクロを使用して、定義リスト内の機能の各メンバーや値に明示的にその状態を示します。 例えば、ページが {{SeeCompatTable}} で実験的と示されている場合、定義リスト内の機能の各メンバーや値も {{Experimental_Inline}} マクロで実験的と明示します。

関連情報

• サイドバーマクロ
• リンクマクロ