機能状態

機能状態は、ブラウザーベンダー間での機能の実装段階に関する情報を開発者に提供するもので、以下のいずれかに該当します。

上記の状態のいずれにも当てはまらない場合、その機能は安定した標準機能とみなされます。コンテンツページにこの状態を明示的に追加することはありません。 これらの用語の詳細については、「実験的、非推奨、廃止」ページを参照してください。

機能状態を選ぶ方法の詳細については、@mdn/browser-compat-data (BCD) リポジトリーの choosing status properties の節を参照してください。

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

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

警告: mdn/content リポジトリーで機能状態を手動で更新しないでください。機能状態を更新するには、BCD リポジトリーでプルリクエストを送信する必要があります。変更が BCD で承認されマージされた後、自動プルリクエスト が mdn/content リポジトリーの状態を更新します。

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

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

この節以下では、 MDN 文書内で機能状態を表示しているメカニズムについて説明します。前述したように、コンテンツへの組み込みは自動化されているため、これらのメカニズムは読み取り専用と考えるべきです。

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

サイドバーに掲載されている機能状態アイコンを表示させるには、フロントマターの status プロパティを使用します。（訳注：このキーは英語版でのみ使用します。）

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

サイドバーが表示されるとき、コードは各ページのフロントマターの状態を見ていきます。前述したように、これらの状態は自動的に更新されるので、手動で変更する必要はありません。

機能状態のページバナー

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

{{SeeCompatTable}}

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

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

{{Non-standard_Header}}

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

非標準: この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

{{Deprecated_Header}}

deprecated の状態です。これは非推奨状態バナーを生成します。

非推奨: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。

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

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

関連情報