Spry

Spry Widget の開発に関するコーディングのガイドライン

Spry の目的の 1 つに、ユーザーコミュニティが Widget を作成および共有できるようにすることが挙げられます。 Adobe は、公開配布のために Widget を作成する際に使用する一連のガイドラインを用意しています。 このガイドラインに従って、すべての Widget の基本機能を統一してください。

  • 構造には標準 HTML コードを使用します。

  • 必要のない限り CSS コードを要求しないでください。

  • 機能のために CSS コードを要求する場合は、要件を明確に文書化します。

  • 1 行 (可能な場合) の JavaScript を使用して Widget の機能を有効にします。

  • デフォルトで、キーボードによる操作のオプションを関数で記述します。

  • JavaScript がオフになっている場合でもコンテンツがページに表示されるようにします。

  • Widget は自己完結型である必要があります。 Widget に必要なものはすべて HTML、JavaScript、および CSS ファイルに提供されます。

これらのガイドラインに従うと、Widget が理解しやすく使いやすいものになり、一貫性によってすべてのユーザーのフレームワークが強化されます。

標準コードを使用することは重要です。一般的なユーザーが知識を習得する必要が少ないためです。 また、標準コードを使用すると、Widget を WYSIWYG (What You See Is What You Get) エディタで簡単に使用できます。

CSS コードは一部の Widget で使用し、CSS コードで表示ルールを切り替えることによってコンテンツを表示または非表示にします。 これは、CSS を使用する必要がある場合の一例です。 CSS コードは明らかにコンテンツを表示または非表示にするためのメカニズムであるため、このような場合は使用可能です。 ただし、純粋なスタイル設定である CSS コードは要求しないでください。 Widget は、スタイル設定なしで機能する必要があります。 CSS ファイルで必要な CSS ルールをコメント付きで文書化します。さらにマニュアルを提供する場合は、その旨も示します。

ほとんどの Widget は、実際の Widget コードの直後にある 1 行の JavaScript コードでアクティブになります。 JavaScript パラメータは最小限に抑えるようにしてください。 Widget の幅および高さは、他に方法がない場合を除き、JavaScript ではなく CSS コードで設定してください。

キーボードによる操作とアクセシビリティは、ユーザーおよび Spry にとって重要です。 ユーザーが一般的なワークフローキー (矢印キー、スペースキー) を使用して Widget のすべての部分にアクセスできるようにキーボードによる操作を記述します。 必要に応じてタブ順序などを使用してください。

スクリプティング環境以外の環境では、コンテンツが非表示にならないことが重要です。 JavaScript がオフになっている場合に、CSS 表示のオフまたはコンテンツの画面外への配置のためにコンテンツが非表示になることがないようにしてください。

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/ja_JP/Spry/1.4/WSA4B07B34-2CF3-40ab-907B-3D24E3BB6D48.html