{"title":"フォームアセット (Media クラス)","version":"4.1","locale":"ja","docname":"topics/forms/media","url":"/ja/4.1/topics/forms/media/","canonical":"https://djangodocs.dev/ja/4.1/topics/forms/media/","summary":"Rendering an attractive and easy-to-use web form requires more than just HTML - it also requires CSS stylesheets, and if you want to use fancy widgets, you may also…","html":"

フォームアセット (Media クラス)Link to this heading#

\n

Rendering an attractive and easy-to-use web form requires more than just\nHTML - it also requires CSS stylesheets, and if you want to use fancy widgets,\nyou may also need to include some JavaScript on each page. The exact\ncombination of CSS and JavaScript that is required for any given page will\ndepend upon the widgets that are in use on that page.

\n

This is where asset definitions come in. Django allows you to\nassociate different files -- like stylesheets and scripts -- with the\nforms and widgets that require those assets. For example, if you want\nto use a calendar to render DateFields, you can define a custom\nCalendar widget. This widget can then be associated with the CSS and\nJavaScript that is required to render the calendar. When the Calendar\nwidget is used on a form, Django is able to identify the CSS and\nJavaScript files that are required, and provide the list of file names\nin a form suitable for inclusion on your web page.

\n\n\n
\n

定数として定義されたアセットLink to this heading#

\n

アセットを定義する最も簡単な方法は、定数とすることです。この方法を利用するには、内部 Media クラスに宣言します。内部クラスのプロパティで必要なものを定義します。

\n

以下に例を示します。

\n
Code
from django import forms\n\nclass CalendarWidget(forms.TextInput):\n    class Media:\n        css = {\n            'all': ('pretty.css',)\n        }\n        js = ('animations.js', 'actions.js')\n
\n

このコードでは、CalendarWidget を定義しており、これは TextInput に基づいています。CalendarWidget をフォーム上で使用すると、CSS ファイル pretty.css と JavaScript ファイル animations.js および actions.js を読み込めるようになります。

\n

この定数定義は、実行時に media という名前のウィジェットプロパティに変換されます。CalendarWidget インスタンスに対するアセットのリストは以下のプロパティを通じて取得できます:

\n
Code
>>> w = CalendarWidget()\n>>> print(w.media)\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n
\n

以下は指定可能な Media オプションです。必須のものはありません。

\n
\n

cssLink to this heading#

\n

様々な形式の出力メディアに対して、必要な CSSファイルを定義するディクショナリです。

\n

ディクショナリの値はファイル名のタプルかリストで指定します。ファイルのパスを指定する方法は パスの章 を参照してください。

\n

ディクショナリのキーは、出力するメディアタイプを表します。これらは CSS ファイル認識可能なメディアタイプと同じです: 'all'、'aural'、'braille'、'embossed'、'handheld'、'print'、'projection'、'screen'、'tty'、'tv'。メディアタイプに応じたスタイルシートを提供する必要がある場合、各出力メディアに対して CSS ファイルを作成してください。以下の例は 2 つの CSS オプションを提供します -- 1 つはスクリーン用でもう一つは印刷用です:

\n
Code
class Media:\n    css = {\n        'screen': ('pretty.css',),\n        'print': ('newspaper.css',)\n    }\n
\n

1 つのCSS ファイルのグループを複数の出力メディアタイプに適用するには、出力メディアタイプをカンマで区切ってディス書なりのキーに指定します。以下の例では、TV とプロジェクターは同じメディアを参照します:

\n
Code
class Media:\n    css = {\n        'screen': ('pretty.css',),\n        'tv,projector': ('lo_res.css',),\n        'print': ('newspaper.css',)\n    }\n
\n

最後の例の CSS 定義を描画すると、HTML が出力されます:

\n
Code
<link href="http://static.example.com/pretty.css" media="screen" rel="stylesheet">\n<link href="http://static.example.com/lo_res.css" media="tv,projector" rel="stylesheet">\n<link href="http://static.example.com/newspaper.css" media="print" rel="stylesheet">\n
\n\n
\n
\n

jsLink to this heading#

\n

必要な JavaScript ファイルを定義したタプルです。ファイルのパスを指定する方法は パスの章 を参照してください。

\n
\n
\n

extendLink to this heading#

\n

Media 宣言に対する継承動作を定義する真偽値です。

\n

デフォルトでは、定数の Media 定義を使用するすべてのオブジェクトは、親ウィジェットに紐付いたすべてのアセットを継承します。この挙動は、親ウィジェットがどのように自身の要件を定義しているかに関わらず発生します。例えば、上の例にあるベーシックな Calendar ウィジェットを拡張するには:

\n
Code
>>> class FancyCalendarWidget(CalendarWidget):\n...     class Media:\n...         css = {\n...             'all': ('fancy.css',)\n...         }\n...         js = ('whizbang.js',)\n\n>>> w = FancyCalendarWidget()\n>>> print(w.media)\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<link href="http://static.example.com/fancy.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n<script src="http://static.example.com/whizbang.js"></script>\n
\n

FancyCalendar ウィジェットは親ウィジェットからすべてのアセットを継承します。これを回避したい場合には Media 宣言に extend=False を追加します:

\n
Code
>>> class FancyCalendarWidget(CalendarWidget):\n...     class Media:\n...         extend = False\n...         css = {\n...             'all': ('fancy.css',)\n...         }\n...         js = ('whizbang.js',)\n\n>>> w = FancyCalendarWidget()\n>>> print(w.media)\n<link href="http://static.example.com/fancy.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/whizbang.js"></script>\n
\n

継承をより詳細にコントロールするにあｈ、動的なプロパティ を使ってアセットを定義してください。 動的なプロパティを使えば、どのファイルを継承し、また継承しないかを完全にコントロールできます。

\n
\n
\n
\n

動的プロパティとしての MediaLink to this heading#

\n

アセット要件のより詳細な操作が必要な場合、media プロパティを直接定義することができます。これは、forms.Media のインスタンスを返すウィジェットプロパティを定義することで実現できます。forms.Media に対するコンストラクタは、定数によるメディア定義と同様の形式で、css と js のキーワード引数を認識します。

\n

例えば、上記例で扱ってきた Calendar Widget に対する定数の定義は、動的な方法では以下のように定義できます:

\n
Code
class CalendarWidget(forms.TextInput):\n    @property\n    def media(self):\n        return forms.Media(css={'all': ('pretty.css',)},\n                           js=('animations.js', 'actions.js'))\n
\n

動的な media プロパティに対する戻り値を構成する方法については、Media objects`_ を参照してください。

\n
\n
\n

アセット定義内のパスLink to this heading#

\n
\n

Paths as stringsLink to this heading#

\n

String paths used to specify assets can be either relative or absolute. If a\npath starts with /, http:// or https://, it will be\ninterpreted as an absolute path, and left as-is. All other paths will\nbe prepended with the value of the appropriate prefix. If the\ndjango.contrib.staticfiles app is installed, it will be used to serve\nassets.

\n

mod:django.contrib.staticfiles を使うかどうかに関わらず、ウェブページを完全に表示するために STATIC_URL と STATIC_ROOT の設定が必要となります。

\n

適切な接頭辞を特定するため、Django STATIC_URL 設定が None でないかチェックし、自動的に MEDIA_URL を使うようフォールバックします。例えば、サイトに対する MEDIA_URL が 'http://uploads.example.com/' で STATIC_URL が None だった場合:

\n
Code
>>> from django import forms\n>>> class CalendarWidget(forms.TextInput):\n...     class Media:\n...         css = {\n...             'all': ('/css/pretty.css',),\n...         }\n...         js = ('animations.js', 'http://othersite.com/actions.js')\n\n>>> w = CalendarWidget()\n>>> print(w.media)\n<link href="/css/pretty.css" media="all" rel="stylesheet">\n<script src="http://uploads.example.com/animations.js"></script>\n<script src="http://othersite.com/actions.js"></script>\n
\n

一方、STATIC_URL が 'http://static.example.com/'`` の場合:

\n
Code
>>> w = CalendarWidget()\n>>> print(w.media)\n<link href="/css/pretty.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://othersite.com/actions.js"></script>\n
\n

もしくは、staticfiles が ManifestStaticFilesStorage を使って設定されている場合:

\n
Code
>>> w = CalendarWidget()\n>>> print(w.media)\n<link href="/css/pretty.css" media="all" rel="stylesheet">\n<script src="https://static.example.com/animations.27e20196a850.js"></script>\n<script src="http://othersite.com/actions.js"></script>\n
\n
\n
\n

Paths as objectsLink to this heading#

\n\n

Asset paths may also be given as hashable objects implementing an\n__html__() method. The __html__() method is typically added using the\nhtml_safe() decorator. The object is responsible for\noutputting the complete HTML <script> or <link> tag content:

\n
Code
>>> from django import forms\n>>> from django.utils.html import html_safe\n>>>\n>>> @html_safe\n>>> class JSPath:\n...     def __str__(self):\n...         return '<script src="https://example.org/asset.js" rel="stylesheet">'\n\n>>> class SomeWidget(forms.TextInput):\n...     class Media:\n...         js = (JSPath(),)\n
\n
\n
\n
\n

Media objectsLink to this heading#

\n

ウィジェットやフォームの media 属性に応答指令信号を送ると、forms.Media オブジェクトが戻り値となります。すでに見たように、Media オブジェクトの文字列表現は HTMLで、HTML ページ内の <head> ブロックに関連ファイルを含める必要があります。

\n

ただし、Media オブジェクトにはいくつかの面白いプロパティが存在します。

\n
\n

アセットのサブセットLink to this heading#

\n

特定のタイプのファイルのみ必要な場合、サブスクリプトオペレーターを使って使用するメディアをフィルタできます。例えば:

\n
Code
>>> w = CalendarWidget()\n>>> print(w.media)\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n\n>>> print(w.media['css'])\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n
\n

サブスクリプトオペレーターを使用すると、新たな Media オブジェクトが戻り値となります -- 使用するメディアのみが含まれています。

\n
\n
\n

Media オブジェクトを結合するLink to this heading#

\n

Media オブジェクトを複数使用することもできます。2 つの Media が追加されると、両方で指定されたアセットを結合したものを含む Media オブジェクトを生成します:

\n
Code
>>> from django import forms\n>>> class CalendarWidget(forms.TextInput):\n...     class Media:\n...         css = {\n...             'all': ('pretty.css',)\n...         }\n...         js = ('animations.js', 'actions.js')\n\n>>> class OtherWidget(forms.TextInput):\n...     class Media:\n...         js = ('whizbang.js',)\n\n>>> w1 = CalendarWidget()\n>>> w2 = OtherWidget()\n>>> print(w1.media + w2.media)\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n<script src="http://static.example.com/whizbang.js"></script>\n
\n
\n
\n

アセットの順序Link to this heading#

\n

DOM に挿入されるアセットの順序が重要になることがあります。例えば、jQuery に依存したスクリプトがあるかもしれません。したがって、結合した Media オブジェクトは、各 Media クラス内で定義された順序を保持します。

\n

例:

\n
Code
>>> from django import forms\n>>> class CalendarWidget(forms.TextInput):\n...     class Media:\n...         js = ('jQuery.js', 'calendar.js', 'noConflict.js')\n>>> class TimeWidget(forms.TextInput):\n...     class Media:\n...         js = ('jQuery.js', 'time.js', 'noConflict.js')\n>>> w1 = CalendarWidget()\n>>> w2 = TimeWidget()\n>>> print(w1.media + w2.media)\n<script src="http://static.example.com/jQuery.js"></script>\n<script src="http://static.example.com/calendar.js"></script>\n<script src="http://static.example.com/time.js"></script>\n<script src="http://static.example.com/noConflict.js"></script>\n
\n

順序が矛盾した Media オブジェクトを結合すると MediaOrderConflictWarning となります。

\n
\n
\n
\n

フォームの MediaLink to this heading#

\n

ウィジェットだけでなく、フォームにも media の定義を行うことができます。フォーム上での media 定義のルールはウィジェットと同じです: 宣言は定数および動的に行えます; パスと継承についてのルールもまったく同じです。

\n

media 宣言を定義したかどうかに関わらず、すべての Form オブジェクトは media プロパティを持ちます。デフォルト値は、フォームを構成するすべてのウィジェットに対する media 定義を追加した結果です:

\n
Code
>>> from django import forms\n>>> class ContactForm(forms.Form):\n...     date = DateField(widget=CalendarWidget)\n...     name = CharField(max_length=40, widget=OtherWidget)\n\n>>> f = ContactForm()\n>>> f.media\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n<script src="http://static.example.com/whizbang.js"></script>\n
\n

If you want to associate additional assets with a form -- for example,\nCSS for form layout -- add a Media declaration to the form:

\n
Code
>>> class ContactForm(forms.Form):\n...     date = DateField(widget=CalendarWidget)\n...     name = CharField(max_length=40, widget=OtherWidget)\n...\n...     class Media:\n...         css = {\n...             'all': ('layout.css',)\n...         }\n\n>>> f = ContactForm()\n>>> f.media\n<link href="http://static.example.com/pretty.css" media="all" rel="stylesheet">\n<link href="http://static.example.com/layout.css" media="all" rel="stylesheet">\n<script src="http://static.example.com/animations.js"></script>\n<script src="http://static.example.com/actions.js"></script>\n<script src="http://static.example.com/whizbang.js"></script>\n
\n
","rootId":"form-assets-the-media-class","toc":[{"title":"定数として定義されたアセット","anchor":"assets-as-a-static-definition","children":[{"title":"css","anchor":"css","children":[]},{"title":"js","anchor":"js","children":[]},{"title":"extend","anchor":"extend","children":[]}]},{"title":"動的プロパティとしての Media","anchor":"media-as-a-dynamic-property","children":[]},{"title":"アセット定義内のパス","anchor":"paths-in-asset-definitions","children":[{"title":"Paths as strings","anchor":"paths-as-strings","children":[]},{"title":"Paths as objects","anchor":"paths-as-objects","children":[]}]},{"title":"Media objects","anchor":"media-objects","children":[{"title":"アセットのサブセット","anchor":"subsets-of-assets","children":[]},{"title":"Media オブジェクトを結合する","anchor":"combining-media-objects","children":[]},{"title":"アセットの順序","anchor":"order-of-assets","children":[]}]},{"title":"フォームの Media","anchor":"media-on-forms","children":[]}],"breadcrumbs":[{"docname":"topics/index","title":"Django を使う","url":"/ja/4.1/topics/"},{"docname":"topics/forms/index","title":"フォームを使う","url":"/ja/4.1/topics/forms/"}],"prev":{"docname":"topics/forms/modelforms","title":"モデルからフォームを作成する","url":"/ja/4.1/topics/forms/modelforms/"},"next":{"docname":"topics/templates","title":"テンプレート","url":"/ja/4.1/topics/templates/"},"formats":{"html":"/ja/4.1/topics/forms/media/","markdown":"/ja/4.1/topics/forms/media.md","json":"/ja/4.1/topics/forms/media.json"},"source":"https://github.com/django/django/blob/stable/4.1.x/docs/topics/forms/media.txt","official":"https://docs.djangoproject.com/ja/4.1/topics/forms/media/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}