WidgetsLink to this heading

En widget är Djangos representation av ett HTML-inmatningselement. Widgeten hanterar rendering av HTML och extrahering av data från en GET/POST-ordbok som motsvarar widgeten.

Den HTML som genereras av de inbyggda widgetarna använder HTML5-syntax och riktar sig till <!DOCTYPE html>. Exempelvis används booleska attribut som checked i stället för XHTML-stilen checked='checked'.

Ange widgetarLink to this heading

När du anger ett fält i ett formulär kommer Django att använda en standardwidget som är lämplig för den typ av data som ska visas. För att ta reda på vilken widget som används för vilket fält, se dokumentationen om Inbyggda Field-klasser.

Men om du vill använda en annan widget för ett fält kan du använda argumentet widget i fältdefinitionen. Till exempel:

Code

from django import forms


class CommentForm(forms.Form):
    name = forms.CharField()
    url = forms.URLField()
    comment = forms.CharField(widget=forms.Textarea)

Detta skulle ange ett formulär med en kommentar som använder en större Textarea-widget i stället för standardwidgeten TextInput.

Ställa in argument för widgetsLink to this heading

Många widgetar har valfria extra argument; de kan anges när widgeten definieras på fältet. I följande exempel anges attributet years för en SelectDateWidget:

Code

from django import forms

BIRTH_YEAR_CHOICES = ["1980", "1981", "1982"]
FAVORITE_COLORS_CHOICES = {
    "blue": "Blue",
    "green": "Green",
    "black": "Black",
}


class SimpleForm(forms.Form):
    birth_year = forms.DateField(
        widget=forms.SelectDateWidget(years=BIRTH_YEAR_CHOICES)
    )
    favorite_colors = forms.MultipleChoiceField(
        required=False,
        widget=forms.CheckboxSelectMultiple,
        choices=FAVORITE_COLORS_CHOICES,
    )

Se inbyggda widgetar för mer information om vilka widgetar som finns tillgängliga och vilka argument de accepterar.

Anpassa widgetinstanserLink to this heading

När Django renderar en widget som HTML, renderar den bara mycket minimal markup - Django lägger inte till klassnamn eller andra widgetspecifika attribut. Detta innebär till exempel att alla TextInput-widgets kommer att se likadana ut på dina webbsidor.

Det finns två sätt att anpassa widgetar: per widget instance och per widget class.

Styling av widgetinstanserLink to this heading

Om du vill att en widgetinstans ska se annorlunda ut än en annan måste du ange ytterligare attribut när widgetobjektet instansieras och tilldelas ett formulärfält (och kanske lägga till några regler i dina CSS-filer).

Ta till exempel följande formulär:

Code

from django import forms


class CommentForm(forms.Form):
    name = forms.CharField()
    url = forms.URLField()
    comment = forms.CharField()

Detta formulär kommer att innehålla TextInput-widgetar för namn- och kommentarsfälten, och en URLInput-widget för url-fältet. Varje widget har standardrendering - ingen CSS-klass, inga extra attribut:

Python console

>>> f = CommentForm(auto_id=False)
>>> print(f)
<div>Name:<input type="text" name="name" required></div>
<div>Url:<input type="url" name="url" required></div>
<div>Comment:<input type="text" name="comment" required></div>

På en riktig webbsida vill du förmodligen anpassa detta. Du kanske vill ha ett större inmatningselement för kommentaren, och du kanske vill att widgeten ”name” ska ha någon speciell CSS-klass. Det är också möjligt att ange attributet ’type’ för att använda en annan HTML5-ingångstyp. För att göra detta använder du argumentet Widget.attrs när du skapar widgeten:

Code

class CommentForm(forms.Form):
    name = forms.CharField(widget=forms.TextInput(attrs={"class": "special"}))
    url = forms.URLField()
    comment = forms.CharField(widget=forms.TextInput(attrs={"size": "40"}))

Du kan också ändra en widget i formulärdefinitionen:

Code

class CommentForm(forms.Form):
    name = forms.CharField()
    url = forms.URLField()
    comment = forms.CharField()

    name.widget.attrs.update({"class": "special"})
    comment.widget.attrs.update(size="40")

Om fältet inte deklareras direkt i formuläret (t.ex. fält i modellformulär) kan du använda attributet Form.fields:

Code

class CommentForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields["name"].widget.attrs.update({"class": "special"})
        self.fields["comment"].widget.attrs.update(size="40")

Django kommer då att inkludera de extra attributen i den återgivna utdata:

Code

>>> f = CommentForm(auto_id=False)
>>> print(f)
<div>Name:<input type="text" name="name" class="special" required></div>
<div>Url:<input type="url" name="url" required></div>
<div>Comment:<input type="text" name="comment" size="40" required></div>

Du kan också ställa in HTML id med hjälp av attrs. Se BoundField.id_for_label för ett exempel.

Klasser för baswidgetarLink to this heading

Baswidgetklasserna Widget och MultiWidget är underklasser till alla inbyggda widgetar och kan fungera som en grund för anpassade widgetar.

`Widget`Link to this heading

class Widget(attrs=None)Link to this definition

This abstract class cannot be rendered, but provides the basic attribute attrs. You may also implement or override the render() method on custom widgets.

attrsLink to this definition

En ordlista som innehåller HTML-attribut som ska ställas in på den renderade widgeten.

Python console

>>> from django import forms
>>> name = forms.TextInput(attrs={"size": 10, "title": "Your name"})
>>> name.render("name", "A name")
'<input title="Your name" type="text" name="name" value="A name" size="10">'

Om du tilldelar ett värde av True eller False till ett attribut, kommer det att återges som ett HTML5 booleskt attribut:

Python console

>>> name = forms.TextInput(attrs={"required": True})
>>> name.render("name", "A name")
'<input name="name" type="text" value="A name" required>'
>>>
>>> name = forms.TextInput(attrs={"required": False})
>>> name.render("name", "A name")
'<input name="name" type="text" value="A name">'

supports_microsecondsLink to this definition: Ett attribut som har standardvärdet True. Om det sätts till False kommer mikrosekunderna i värdena datetime och time att sättas till 0.

format_value(value)Link to this definition: Rensar och returnerar ett värde för användning i widgetmallen. värde garanteras inte vara giltig indata, därför bör implementeringar av underklasser programmeras defensivt.

get_context(name, value, attrs)Link to this definition

Returnerar en ordbok med värden som ska användas vid rendering av widgetmallen. Som standard innehåller ordboken en enda nyckel, 'widget', som är en ordboksrepresentation av widgeten som innehåller följande nycklar:

'namn': Namnet på fältet från argumentet name.
'is_hidden': En boolean som anger om denna widget är dold eller inte.
'required': En boolean som anger om fältet för den här widgeten är obligatoriskt eller inte.
'värde': Det värde som returneras av format_value().
'attrs': HTML-attribut som ska ställas in på den renderade widgeten. Kombinationen av attributet attrs och argumentet attrs.
'template_name': Värdet av self.template_name.

underklasser till Widget kan tillhandahålla anpassade kontextvärden genom att åsidosätta denna metod.

id_for_label(id_)Link to this definition

Returnerar HTML ID-attributet för denna widget för användning av en <label>, givet fältets ID. Returnerar en tom sträng om ett ID inte är tillgängligt.

Denna hook är nödvändig eftersom vissa widgetar har flera HTML-element och därmed flera ID:n. I så fall bör den här metoden returnera ett ID-värde som motsvarar det första ID:t i widgetens taggar.

render(name, value, attrs=None, renderer=None)Link to this definition: Renderar en widget till HTML med hjälp av den angivna renderaren. Om renderer är None används renderaren från inställningen FORM_RENDERER.

value_from_datadict(data, files, name)Link to this definition: Givet en ordbok med data och denna widgets namn, returnerar värdet av denna widget. files kan innehålla data som kommer från request.FILES. Returnerar None om inget värde har angetts. Observera också att value_from_datadict kan anropas mer än en gång under hanteringen av formulärdata, så om du anpassar det och lägger till dyr bearbetning bör du implementera någon cachemekanism själv.

value_omitted_from_data(data, files, name)Link to this definition

Med hjälp av ordböckerna data och files och widgetens namn returneras om det finns data eller filer för widgeten eller inte.

Metodens resultat påverkar om ett fält i ett modellformulär faller tillbaka till sin standard eller inte.

Specialfall är CheckboxInput, CheckboxSelectMultiple och SelectMultiple, som alltid returnerar False eftersom en avmarkerad kryssruta och omarkerad <select multiple> inte visas i data från en HTML-formulärinlämning, så det är okänt om användaren skickade in ett värde eller inte.

use_fieldsetLink to this definition: Ett attribut för att identifiera om widgeten ska grupperas i en <fieldset> med en <legend> när den renderas. Standardvärdet är False men är True när widgeten innehåller flera <input> taggar som CheckboxSelectMultiple, RadioSelect, MultiWidget, SplitDateTimeWidget, och SelectDateWidget.

use_required_attribute(initial)Link to this definition

Med tanke på ett formulärfälts initial-värde returneras huruvida widgeten kan återges med HTML-attributet required eller inte. Formulär använder den här metoden tillsammans med Field.required och Form.use_required_attribute för att avgöra om attributet required ska visas eller inte för varje fält.

Som standard returneras False för dolda widgetar och True annars. Specialfall är FileInput och ClearableFileInput, som returnerar False när initial är inställt, och CheckboxSelectMultiple, som alltid returnerar False eftersom webbläsarvalidering skulle kräva att alla kryssrutor är markerade istället för minst en.

Override this method in custom widgets that aren’t compatible with browser validation. For example, a WYSIWYG text editor widget backed by a hidden textarea element may want to always return False to avoid browser validation on the hidden field.

`MultiWidget`Link to this heading

class MultiWidget(widgets, attrs=None)Link to this definition

En widget som består av flera widgetar. MultiWidget arbetar hand i hand med MultiValueField.

MultiWidget har ett obligatoriskt argument:

widgetsLink to this definition

En iterabel som innehåller de widgetar som behövs. Till exempel:

Python console

>>> from django.forms import MultiWidget, TextInput
>>> widget = MultiWidget(widgets=[TextInput, TextInput])
>>> widget.render("name", ["john", "paul"])
'<input type="text" name="name_0" value="john"><input type="text" name="name_1" value="paul">'

Du kan tillhandahålla en ordbok för att ange anpassade suffix för attributet name på varje subwidget. I det här fallet kommer nyckeln för varje par (nyckel, widget) att läggas till widgetens namn för att generera attributvärdet. Du kan ange den tomma strängen ('') för en enda nyckel, för att undertrycka suffixet för en widget. Till exempel:

Python console

>>> widget = MultiWidget(widgets={"": TextInput, "last": TextInput})
>>> widget.render("name", ["john", "paul"])
'<input type="text" name="name" value="john"><input type="text" name="name_last" value="paul">'

Och en nödvändig metod:

decompress(value)Link to this definition

Denna metod tar ett enda ”komprimerat” värde från fältet och returnerar en lista med ”dekomprimerade” värden. Inmatningsvärdet kan antas vara giltigt, men inte nödvändigtvis icke-tomt.

Denna metod måste implementeras av underklassen, och eftersom värdet kan vara tomt måste implementeringen vara defensiv.

Tanken bakom ”dekomprimering” är att det är nödvändigt att ”dela upp” det kombinerade värdet för formulärfältet i värden för varje widget.

Ett exempel på detta är hur SplitDateTimeWidget förvandlar ett datetime-värde till en lista med datum och tid uppdelade i två separata värden:

Code

from django.forms import MultiWidget


class SplitDateTimeWidget(MultiWidget):
    # ...

    def decompress(self, value):
        if value:
            return [value.date(), value.time()]
        return [None, None]

Det ger ett anpassat sammanhang:

get_context(name, value, attrs)Link to this definition

Förutom nyckeln 'widget' som beskrivs i Widget.get_context(), lägger MultiWidget till en nyckel widget['subwidgets'].

Dessa kan loopas över i widgetmallen:

Django template

{% for subwidget in widget.subwidgets %}
    {% include subwidget.template_name with widget=subwidget %}
{% endfor %}

Här är ett exempel på en widget som underklassar MultiWidget för att visa ett datum med dag, månad och år i olika valboxar. Denna widget är avsedd att användas med en DateField snarare än en MultiValueField, därför har vi implementerat value_from_datadict():

Code

from datetime import date
from django import forms


class DateSelectorWidget(forms.MultiWidget):
    def __init__(self, attrs=None):
        days = {day: day for day in range(1, 32)}
        months = {month: month for month in range(1, 13)}
        years = {year: year for year in [2018, 2019, 2020]}
        widgets = [
            forms.Select(attrs=attrs, choices=days),
            forms.Select(attrs=attrs, choices=months),
            forms.Select(attrs=attrs, choices=years),
        ]
        super().__init__(widgets, attrs)

    def decompress(self, value):
        if isinstance(value, date):
            return [value.day, value.month, value.year]
        elif isinstance(value, str):
            year, month, day = value.split("-")
            return [day, month, year]
        return [None, None, None]

    def value_from_datadict(self, data, files, name):
        day, month, year = super().value_from_datadict(data, files, name)
        # DateField expects a single string that it can parse into a date.
        return "{}-{}-{}".format(year, month, day)

Konstruktören skapar flera Select widgetar i en lista. Metoden super() använder denna lista för att konfigurera widgeten.

Den nödvändiga metoden decompress() delar upp ett datetime.date-värde i värdena för dag, månad och år som motsvarar varje widget. Om ett ogiltigt datum valdes, till exempel den icke-existerande 30 februari, skickar DateField den här metoden en sträng istället, så det måste analyseras. Den sista return hanterar när value är None, vilket innebär att vi inte har några standardvärden för våra underwidgets.

Standardimplementeringen av value_from_datadict() returnerar en lista med värden som motsvarar varje Widget. Detta är lämpligt när man använder en MultiWidget med en MultiValueField. Men eftersom vi vill använda denna widget med en DateField, som tar ett enda värde, har vi åsidosatt denna metod. Implementationen här kombinerar data från underwidgetarna till en sträng i det format som DateField förväntar sig.

Inbyggda widgetarLink to this heading

Django tillhandahåller en representation av alla grundläggande HTML-widgets, plus några vanligt förekommande grupper av widgets i modulen django.forms.widgets, inklusive inmatning av text, olika kryssrutor och väljare, uppladdning av filer och hantering av flervärdesinmatning.

Widgets som hanterar inmatning av textLink to this heading

Dessa widgets använder HTML-elementen input och textarea.

`TextInput`Link to this heading

class TextInputLink to this definition

inmatningstyp: ”text
template_name: 'django/forms/widgets/text.html'
Renderas som: <input type="text" ...>

`NummerInmatning`Link to this heading

class NumberInputLink to this definition

inmatningstyp: ”tal
template_name: 'django/forms/widgets/number.html'
Renderas som: <input type="number" ...>

Tänk på att inte alla webbläsare stöder inmatning av lokaliserade siffror i inmatningstyperna number. Django själv undviker att använda dem för fält som har sin localize egenskap inställd på True.

`EmailInput`Link to this heading

class EmailInputLink to this definition

input_type: 'email'
template_name: 'django/forms/widgets/email.html'
Renderas som: <input type="email" ...>

`URLInput`Link to this heading

class URLInputLink to this definition

inmatningstyp: ”url
template_name: 'django/forms/widgets/url.html'
Renderas som: <input type="url" ...>

`FärgInmatning`Link to this heading

class ColorInputLink to this definition

inmatningstyp: ”färg
template_name:'django/forms/widgets/color.html'
Renderas som: <input type="color" ...>

`SökningInput`Link to this heading

class SearchInputLink to this definition

input_type: 'search'
template_name: 'django/forms/widgets/search.html'
Renderas som: <input type="search" ...>

`TelInput`Link to this heading

class TelInputLink to this definition

inmatningstyp: ”tel
template_name: 'django/forms/widgets/tel.html'
Renderas som: <input type="tel" ...>

Webbläsare utför ingen validering på klientsidan som standard eftersom telefonnummerformat varierar så mycket runt om i världen. Du kan lägga till några genom att ställa in pattern, minlength eller maxlength i argumentet Widget.attrs.

Dessutom kan du lägga till validering på serversidan till ditt formulärfält med en validerare som RegexValidator eller via tredjepartspaket, t.ex. django-phonenumber-field.

`LösenordInmatning`Link to this heading

class PasswordInputLink to this definition

inmatningstyp: ”Lösenord
template_name: 'django/forms/widgets/password.html'
Renderas som: <input type="password" ...>

Tar emot ett valfritt argument:

render_valueLink to this definition: Bestämmer om widgeten ska ha ett värde ifyllt när formuläret visas igen efter ett valideringsfel (standard är False).

`HiddenInput`Link to this heading

class HiddenInputLink to this definition

inmatningstyp: ”dold
template_name: 'django/forms/widgets/hidden.html'
Renderas som: <input type="hidden" ...>

Observera att det också finns en widget av typen MultipleHiddenInput som innehåller en uppsättning dolda inmatningselement.

`DatumInmatning`Link to this heading

class DateInputLink to this definition

inmatningstyp: ”text
template_name: 'django/forms/widgets/date.html'
Renderas som: <input type="text" ...>

Tar samma argument som TextInput, med ytterligare ett valfritt argument:

formatLink to this definition: Det format som fältets initiala värde ska visas i.

Om inget format-argument anges är standardformatet det första formatet som hittas i DATE_INPUT_FORMATS och respekterar Lokalisering av format. formaten %U, %W och %j stöds inte av den här widgeten.

Using the HTML5 ”date” input type

If you are targeting browsers that support the HTML5 ”date” input type, you can override the input_type attribute to enable the browser’s native date picker:

Code

class MyDateInput(forms.DateInput):
    input_type = "date"
    format = "%Y-%m-%d"

Alternatively:

Code

DateInput(attrs={"type": "date"}, format="%Y-%m-%d")

HTML5 date inputs expect values in the ISO format YYYY-MM-DD. If a different format is provided, the field may appear empty even when a value exists. Setting the format attribute controls how Django provides the value, but the browser controls how it is displayed. Hence, the format attribute and the DATE_INPUT_FORMATS setting will have no effect on the displayed value.

`DateTimeInput`Link to this heading

class DateTimeInputLink to this definition

inmatningstyp: ”text
template_name: 'django/forms/widgets/datetime.html'
Renderas som: <input type="text" ...>

Tar samma argument som TextInput, med ytterligare ett valfritt argument:

formatLink to this definition: Det format som fältets initiala värde ska visas i.

Om inget format-argument anges är standardformatet det första formatet som hittas i DATETIME_INPUT_FORMATS och respekterar Lokalisering av format. formaten %U, %W och %j stöds inte av den här widgeten.

Som standard är mikrosekunderdelen av tidsvärdet alltid satt till 0. Om mikrosekunder krävs, använd en subklass med attributet supports_microseconds satt till True.

`TimeInput`Link to this heading

class TimeInputLink to this definition

inmatningstyp: ”text
template_name: 'django/forms/widgets/time.html'
Renderas som: <input type="text" ...>

Tar samma argument som TextInput, med ytterligare ett valfritt argument:

formatLink to this definition: Det format som fältets initiala värde ska visas i.

Om inget format-argument anges är standardformatet det första formatet som hittas i TIME_INPUT_FORMATS och respekterar Lokalisering av format.

För behandling av mikrosekunder, se DateTimeInput.

`Textarea`Link to this heading

class TextareaLink to this definition

template_name: 'django/forms/widgets/textarea.html'
Återges som: .<textarea>.</textarea>.

Väljare och kryssrutorLink to this heading

Dessa widgets använder HTML-elementen <select>, <input type="checkbox"> och <input type="radio">.

Widgetar som återger flera val har ett attribut option_template_name som anger den mall som används för att återge varje val. Till exempel:, för widgeten Select, select_option.html renderar <option> för en <select>.

`CheckboxInput`Link to this heading

class CheckboxInputLink to this definition

inmatningstyp: ”Checkbox
template_name: 'django/forms/widgets/checkbox.html'
Renderas som: <input type="checkbox" ...>

Tar emot ett valfritt argument:

check_testLink to this definition: En anropsbar funktion som tar värdet i CheckboxInput och returnerar True om kryssrutan ska markeras för det värdet.

`Välj`Link to this heading

class SelectLink to this definition

template_name: 'django/forms/widgets/select.html'
option_template_name: 'django/forms/widgets/select_option.html'
Renderas som: ``<select><option …>…``</select>

choicesLink to this definition: Detta attribut är valfritt om formulärfältet inte har något choices-attribut. Om det gör det kommer det att åsidosätta allt du anger här när attributet uppdateras på Field.

`NullBooleanSelect`Link to this heading

class NullBooleanSelectLink to this definition

template_name: 'django/forms/widgets/select.html'
option_template_name: 'django/forms/widgets/select_option.html'

Välj widget med alternativen ”Okänd”, ”Ja” och ”Nej

`VäljMultipel`Link to this heading

class SelectMultipleLink to this definition

template_name: 'django/forms/widgets/select.html'
option_template_name: 'django/forms/widgets/select_option.html'

Liknar Select, men tillåter flera val: .<select multiple>.</select>.

`RadioSelect`Link to this heading

class RadioSelectLink to this definition

template_name: 'django/forms/widgets/radio.html'
option_template_name: 'django/forms/widgets/radio_option.html'

Liknar Select, men återges som en lista med alternativknappar inom <div> taggar:

Html

<div>
  <div><input type="radio" name="..."></div>
  ...
</div>

Om du vill ha mer detaljerad kontroll över den genererade markeringen kan du loopa över radioknapparna i mallen. Anta ett formulär myform med ett fält beatles som använder en RadioSelect som sin widget:

Django template

<fieldset>
    <legend>{{ myform.beatles.label }}</legend>
    {% for radio in myform.beatles %}
    <div class="myradio">
        {{ radio }}
    </div>
    {% endfor %}
</fieldset>

Detta skulle generera följande HTML:

Html

<fieldset>
    <legend>Radio buttons</legend>
    <div class="myradio">
        <label for="id_beatles_0"><input id="id_beatles_0" name="beatles" type="radio" value="john" required> John</label>
    </div>
    <div class="myradio">
        <label for="id_beatles_1"><input id="id_beatles_1" name="beatles" type="radio" value="paul" required> Paul</label>
    </div>
    <div class="myradio">
        <label for="id_beatles_2"><input id="id_beatles_2" name="beatles" type="radio" value="george" required> George</label>
    </div>
    <div class="myradio">
        <label for="id_beatles_3"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" required> Ringo</label>
    </div>
</fieldset>

Det inkluderade taggarna <label>. För att bli mer detaljerad kan du använda varje radioknapps attribut tag, choice_label och id_for_label. Till exempel:, den här mallen…

Django template

<fieldset>
    <legend>{{ myform.beatles.label }}</legend>
    {% for radio in myform.beatles %}
    <label for="{{ radio.id_for_label }}">
        {{ radio.choice_label }}
        <span class="radio">{{ radio.tag }}</span>
    </label>
    {% endfor %}
</fieldset>

…kommer att resultera i följande HTML:

Html

<fieldset>
    <legend>Radio buttons</legend>
    <label for="id_beatles_0">
        John
        <span class="radio"><input id="id_beatles_0" name="beatles" type="radio" value="john" required></span>
    </label>
    <label for="id_beatles_1">
        Paul
        <span class="radio"><input id="id_beatles_1" name="beatles" type="radio" value="paul" required></span>
    </label>
    <label for="id_beatles_2">
        George
        <span class="radio"><input id="id_beatles_2" name="beatles" type="radio" value="george" required></span>
    </label>
    <label for="id_beatles_3">
        Ringo
        <span class="radio"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" required></span>
    </label>
</fieldset>

Om du bestämmer dig för att inte loopa över alternativknapparna - t.ex. om din mall innehåller {{ myform.beatles }} - kommer de att matas ut i en <div> med <div>-taggar, enligt ovan.

Den yttre behållaren <div> får widgetens id-attribut, om det är definierat, eller BoundField.auto_id annars.

När du loopar över radioknapparna innehåller taggarna label och input attributen for respektive id. Varje radioknapp har ett id_for_label-attribut för att mata ut elementets ID.

`CheckboxSelectMultiple`Link to this heading

class CheckboxSelectMultipleLink to this definition

template_name: 'django/forms/widgets/checkbox_select.html'
option_template_name: 'django/forms/widgets/checkbox_option.html'

Liknar SelectMultiple, men återges som en lista med kryssrutor:

Html

<div>
  <div><input type="checkbox" name="..." ></div>
  ...
</div>

Den yttre behållaren <div> får widgetens id-attribut, om det är definierat, eller BoundField.auto_id annars.

Precis som i RadioSelect kan du loopa över de enskilda kryssrutorna för widgetens val. Till skillnad från RadioSelect kommer kryssrutorna inte att innehålla HTML-attributet required om fältet är obligatoriskt eftersom webbläsarvalidering skulle kräva att alla kryssrutor är markerade istället för minst en.

När man loopar över kryssrutorna innehåller taggarna label och input attributen for respektive id. Varje kryssruta har ett id_for_label-attribut för att mata ut elementets ID.

Widgets för filuppladdningLink to this heading

`FileInput`Link to this heading

class FileInputLink to this definition

template_name: 'django/forms/widgets/file.html'
Renderas som: <input type="file" ...>

`Rensa filinmatning`Link to this heading

class ClearableFileInputLink to this definition

template_name: 'django/forms/widgets/clearable_file_input.html'
Renderas som: <input type="file" ...> med en extra kryssruta för att rensa fältets värde, om fältet inte är obligatoriskt och har initiala data.

Sammansatta widgetarLink to this heading

`MultipleHiddenInput`Link to this heading

class MultipleHiddenInputLink to this definition

template_name: 'django/forms/widgets/multiple_hidden.html'
Renderas som: flera <input type="hidden" ...> taggar

En widget som hanterar flera dolda widgetar för fält som har en lista med värden.

`SplitDateTimeWidget`Link to this heading

class SplitDateTimeWidgetLink to this definition

template_name: 'django/forms/widgets/splitdatetime.html'

Omslag (med hjälp av MultiWidget) runt två widgets: DateInput för datum och TimeInput för tid. Måste användas med SplitDateTimeField snarare än DateTimeField.

SplitDateTimeWidget har flera valfria argument:

date_formatLink to this definition: Liknande DateInput.format

time_formatLink to this definition: Liknande TimeInput.format

date_attrsLink to this definition

time_attrsLink to this definition: Liknar Widget.attrs. En dictionary som innehåller HTML-attribut som ska ställas in på de renderade widgetarna DateInput respektive TimeInput. Om dessa attribut inte är inställda används istället Widget.attrs.

`SplitHiddenDateTimeWidget`Link to this heading

class SplitHiddenDateTimeWidgetLink to this definition

template_name: 'django/forms/widgets/splithiddendatetime.html'

Liknar SplitDateTimeWidget, men använder HiddenInput för både datum och tid.

`SelectDateWidget`Link to this heading

class SelectDateWidgetLink to this definition

template_name: 'django/forms/widgets/select_date.html'

Omslag runt tre Select widgets: en vardera för månad, dag och år.

Tar emot flera valfria argument:

yearsLink to this definition: En valfri lista/tupel av år som ska användas i valboxen ”year”. Standard är en lista som innehåller det aktuella året och de kommande 9 åren.

monthsLink to this definition

Ett valfritt antal månader som ska användas i valboxen ”månader”.

Diktens nycklar motsvarar månadsnumret (1-indexerat) och värdena är de visade månaderna:

Code

MONTHS = {
    1: _("jan"),
    2: _("feb"),
    3: _("mar"),
    4: _("apr"),
    5: _("may"),
    6: _("jun"),
    7: _("jul"),
    8: _("aug"),
    9: _("sep"),
    10: _("oct"),
    11: _("nov"),
    12: _("dec"),
}

empty_labelLink to this definition

Om DateField inte krävs kommer SelectDateWidget att ha ett tomt val längst upp i listan (som är --- som standard). Du kan ändra texten på denna etikett med attributet empty_label. empty_label kan vara en sträng, lista eller tupel. När en sträng används kommer alla valboxar att ha ett tomt val med denna etikett. Om empty_label är en list eller tuple med 3 strängelement, kommer valboxarna att ha sin egen anpassade etikett. Etiketterna bör vara i denna ordning ('year_label', 'month_label', 'day_label').

Python

# A custom empty label with string
field1 = forms.DateField(widget=SelectDateWidget(empty_label="Nothing"))

# A custom empty label with tuple
field1 = forms.DateField(
    widget=SelectDateWidget(
        empty_label=("Choose Year", "Choose Month", "Choose Day"),
    ),
)

WidgetsLink to this heading#

Ange widgetarLink to this heading#

Ställa in argument för widgetsLink to this heading#

Anpassa widgetinstanserLink to this heading#

Styling av widgetinstanserLink to this heading#

Styling av widgetklasserLink to this heading#

Klasser för baswidgetarLink to this heading#

WidgetLink to this heading#

MultiWidgetLink to this heading#

Inbyggda widgetarLink to this heading#

Widgets som hanterar inmatning av textLink to this heading#

TextInputLink to this heading#

NummerInmatningLink to this heading#

EmailInputLink to this heading#

URLInputLink to this heading#

FärgInmatningLink to this heading#

SökningInputLink to this heading#

TelInputLink to this heading#

LösenordInmatningLink to this heading#

HiddenInputLink to this heading#

DatumInmatningLink to this heading#

DateTimeInputLink to this heading#

TimeInputLink to this heading#

TextareaLink to this heading#

Väljare och kryssrutorLink to this heading#

CheckboxInputLink to this heading#

VäljLink to this heading#

NullBooleanSelectLink to this heading#

VäljMultipelLink to this heading#

RadioSelectLink to this heading#

CheckboxSelectMultipleLink to this heading#

Widgets för filuppladdningLink to this heading#

FileInputLink to this heading#

Rensa filinmatningLink to this heading#

Sammansatta widgetarLink to this heading#

MultipleHiddenInputLink to this heading#

SplitDateTimeWidgetLink to this heading#

SplitHiddenDateTimeWidgetLink to this heading#

SelectDateWidgetLink to this heading#

WidgetsLink to this heading

Ange widgetarLink to this heading

Ställa in argument för widgetsLink to this heading

Anpassa widgetinstanserLink to this heading

Styling av widgetinstanserLink to this heading

Styling av widgetklasserLink to this heading

Klasser för baswidgetarLink to this heading

`Widget`Link to this heading

`MultiWidget`Link to this heading

Inbyggda widgetarLink to this heading

Widgets som hanterar inmatning av textLink to this heading

`TextInput`Link to this heading

`NummerInmatning`Link to this heading

`EmailInput`Link to this heading

`URLInput`Link to this heading

`FärgInmatning`Link to this heading

`SökningInput`Link to this heading

`TelInput`Link to this heading

`LösenordInmatning`Link to this heading

`HiddenInput`Link to this heading

`DatumInmatning`Link to this heading

`DateTimeInput`Link to this heading

`TimeInput`Link to this heading

`Textarea`Link to this heading

Väljare och kryssrutorLink to this heading

`CheckboxInput`Link to this heading

`Välj`Link to this heading

`NullBooleanSelect`Link to this heading

`VäljMultipel`Link to this heading

`RadioSelect`Link to this heading

`CheckboxSelectMultiple`Link to this heading

Widgets för filuppladdningLink to this heading

`FileInput`Link to this heading

`Rensa filinmatning`Link to this heading

Sammansatta widgetarLink to this heading

`MultipleHiddenInput`Link to this heading

`SplitDateTimeWidget`Link to this heading

`SplitHiddenDateTimeWidget`Link to this heading

`SelectDateWidget`Link to this heading