Django forms.ChoiceField でドロップダウンメニュー、ラジオボタン、チェックボックスを作成する方法

Django forms.ChoiceField は、フォームで選択肢を提供するフィールドです。ドロップダウンメニュー、ラジオボタン、チェックボックスなど、さまざまな形式で表示できます。

使い方

1. forms.py ファイルで、ChoiceField を使用したフォームクラスを定義します。

   from django.forms import forms
   
   class MyForm(forms.Form):
       # 選択肢のリスト
       choices = (
           ('1', '選択肢1'),
           ('2', '選択肢2'),
           ('3', '選択肢3'),
       )
   
       # ChoiceField フィールド
       my_field = forms.ChoiceField(choices=choices, label='ラベル')
   

2. テンプレート ファイルで、フォームフィールドをレンダリングします。

   {% load crispy_forms_tags %}
   
   <form action="{% url 'my_view' %}" method="post">
       {% csrf_token %}
   
       {{ form|crispy }}
   
       <button type="submit">送信</button>
   </form>
   

オプション

• choices: 選択肢のリスト。タプルまたはリストで渡します。
• label: フィールドのラベル。
• required: 必須項目かどうか。デフォルトは False です。
• widget: フィールドの表示形式を指定します。デフォルトは 'select' です。
  • 'select': ドロップダウンメニュー
  • 'radio': ラジオボタン
  • 'checkbox': チェックボックス

例

• ドロップダウンメニュー:

  choices = (
      ('1', '選択肢1'),
      ('2', '選択肢2'),
      ('3', '選択肢3'),
  )
  
  field = forms.ChoiceField(choices=choices, label='ラベル')
  

• ラジオボタン:

  choices = (
      ('1', '選択肢1'),
      ('2', '選択肢2'),
      ('3', '選択肢3'),
  )
  
  field = forms.ChoiceField(choices=choices, label='ラベル', widget=forms.RadioSelect())
  

補足

• ChoiceField は、モデルフィールドの choices オプションと同様に使用できます。
• ChoiceField は、ModelChoiceField とも関連しています。ModelChoiceField は、モデルのフィールドから選択肢を自動的に生成します。

Django forms.ChoiceField サンプルコード

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル')

ラジオボタン

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', widget=forms.RadioSelect())

チェックボックス

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', widget=forms.CheckboxSelectMultiple())

ModelChoiceField

from django.db import models
from django.forms import ModelChoiceField

class MyModel(models.Model):
    name = models.CharField(max_length=255)

class MyForm(forms.Form):
    # ModelChoiceField フィールド
    my_field = ModelChoiceField(queryset=MyModel.objects.all(), label='ラベル')

初期値

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', initial='2')

無効な選択肢

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', disabled_choices=('2',))

ヘルプテキスト

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', help_text='ヘルプテキスト')

CSS クラス

from django.forms import forms

class MyForm(forms.Form):
    # 選択肢のリスト
    choices = (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

    # ChoiceField フィールド
    my_field = forms.ChoiceField(choices=choices, label='ラベル', widget_attrs={'class': 'my-class'})

これらのサンプルコードは、Django forms.ChoiceField のさまざまな使い方を示しています。これらのコードを参考に、ご自身のニーズに合ったフォームを作成してください。

• forms.ChoiceField には、他にも多くのオプションがあります。詳細は Django ドキュメントを参照してください。

Django forms.ChoiceField のその他の方法

forms.ModelChoiceField を使用して、モデルの ForeignKey フィールドから選択肢を自動的に生成できます。

from django.db import models
from django.forms import ModelChoiceField

class MyModel(models.Model):
    name = models.CharField(max_length=255)

class OtherModel(models.Model):
    my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)

class MyForm(forms.Form):
    # ModelChoiceField フィールド
    my_field = ModelChoiceField(queryset=MyModel.objects.all(), label='ラベル')

Enum

Django 3.2 以降では、Enum 型を使用して選択肢を定義できます。

from django.db import models
from django.forms import ChoiceField

class MyEnum(models.Enum):
    CHOICE_1 = '1'
    CHOICE_2 = '2'
    CHOICE_3 = '3'

class MyForm(forms.Form):
    # ChoiceField フィールド
    my_field = ChoiceField(choices=MyEnum.choices, label='ラベル')

カスタム選択肢

上記の方法以外にも、カスタム選択肢を作成できます。

from django.forms import ChoiceField

def get_choices():
    # ここに選択肢を生成する処理
    return (
        ('1', '選択肢1'),
        ('2', '選択肢2'),
        ('3', '選択肢3'),
    )

class MyForm(forms.Form):
    # ChoiceField フィールド
    my_field = ChoiceField(choices=get_choices(), label='ラベル')

JavaScript を使用して、動的に選択肢を生成したり、選択肢の表示形式を変更したりできます。

• 上記以外にも、さまざまな方法で forms.ChoiceField を使用できます。
• ご自身のニーズに合った方法を選択してください。