--- title: "An API rindreáil foirm" version: 5.2 locale: ga source: https://docs.djangoproject.com/ga/5.2/ref/forms/renderers/ canonical: https://djangodocs.dev/ga/5.2/ref/forms/renderers/ --- # An API rindreáil foirm Déantar giuirléidí foirme Django a léiriú ag baint úsáide as Django's:doc: córas innill teimpléad \. Is féidir an próiseas rindreála foirme a shaincheapadh ag roinnt leibhéil: - Is féidir le giuirléidí ainmneacha teimpléad sain - Is féidir le foirmeacha agus giuirléidí ranganna saincheaptha rindheartaíochta - Is féidir le tionscadal teimpléad giuirléid a shárú. (De ghnáth níor cheart d'iarratais in-athúsáidte teimpléid ionsuite a shárú toisc go bhféadfadh siad coinbhleacht le teimpléid saincheap ## An API rindreála ar leibhéal íseal Tá rindreáil teimpléid fhoirme á rialú ag rang rindreálaí inoiriúnaithe. Is féidir renderer saincheaptha a shonrú tríd an socrú: setting: FORM\_RENDER a nuashonrú. Tá sé réamhshocraithe go `'`:class: django.forms.renderers.djangoTemplates. Trí léiritheoir foirme saincheaptha a shonrú agus ró-ridin:attr: ~.baserenderer.form\_template\_name is féidir leat an marcáil foirme réamhshocraithe ar fud do thionscadail a choigeartú ó aon áit amháin. Is féidir leat rindreoir saincheaptha in aghaidh foirme nó in aghaidh giuirléid a sholáthar freisin trí:attr: .form.default\_renderer a shocrú nó tríd an argóint `renderer` de:meth: .form.render, no:meth: .widget.render a úsáid. Baineann pointí meaitseála le rindreáil formset. Féach: ref: formset-rendering le haghaidh plé. Use one of the [built-in template form renderers](#built-in-template-form-renderers) or implement your own. Custom renderers must implement a `render(template_name, context, request=None)` method. It should return a rendered template (as a string) or raise [`TemplateDoesNotExist`](/ga/5.2/topics/templates/#django.template.TemplateDoesNotExist). #### `class BaseRenderer` An bunaicme do na léirseoirí foirme ionsuite. #### `form_template_name` Ainm réamhshocraithe an teimpléid le húsáid chun foirm a léiriú. Réamhshocraithe go teimpléad `” django/forms/div.html “`. #### `formset_template_name` Ainm réamhshocraithe an teimpléid le húsáid chun tacar foirme a rinneadh. Réamhshocraithe go teimpléad `” django/forms/formsets/div.html “`. #### `field_template_name` Ainm réamhshocraithe an teimpléid a úsáidtear chun Boundfield\` a rinneadh. Réamhshocraithe go `” django/forms/field.html “` #### `bound_field_class` > **New in Django 5.2** The default class used to represent form fields across the project. Defaults to [`BoundField`](/ga/5.2/ref/forms/api/#django.forms.BoundField) class. This can be customized further using [`Form.bound_field_class`](/ga/5.2/ref/forms/api/#django.forms.Form.bound_field_class) for per-form overrides, or [`Field.bound_field_class`](/ga/5.2/ref/forms/fields/#django.forms.Field.bound_field_class) for per-field overrides. #### `get_template(template_name)` Caithfidh fo-aicmí an modh seo a chur i bhfeidhm leis an loighic aimsithe teimpl #### `render(template_name, context, request=None)` Déanann sé an teimpléad a thugtar, nó ardaíonn sé: exc: ~django.template.templateDoesNotExist. ## Rendeoirí foirm teimpléad ionsuite ### `DjangoTeimpléad` #### `class DjangoTemplates` Úsáideann an renderer seo inneall standalone:class: ~django.template.backends.django.djangoTemplates (gan nasc leis an méid a d'fhéadfadh a bheith cumraithe agat sa socrú:: TEMPLATES). \Luchtaíonn sé teimpléid ar dtús ón eolaire teimpléid foirme ionsuite in:source: django/forms/temples agus ansin ó eolairí teimpléid na n-aipeanna suiteáilte ag baint úsáide as an lódóirí:class: app\_directory . Más mian leat teimpléid a rindreáil le saincheaptha ó do shuíomh: Setting: TEMPLATES, mar shampla próiseálaithe comhthéacs mar shampla, bain úsáid as an rindearálóir:class: TEMPLATESSETTING. #### `class DjangoDivFormRenderer` > **Deprecated since Django 5.0** > > Deprecated since version 5.0. An t-ainm de:class: DjangoTemplates. ### `Jinja2` #### `class Jinja2` Tá an renderer seo mar an gcéanna leis an rindreálaítheoir: class: DjangoTemplates ach amháin go n-úsáideann sé a:class: ~django.template.backends.jinja2.jinja2 backend. Tá teimpléid do na giuirléidí ionsuite in:source: django/forms/jinja2 agus is féidir le feidhmchláir suiteáilte teimpléid a sholáthar in eolaire jinja2\`. Chun an cúltaca seo a úsáid, caithfidh teimpléid Jinja2 a bheith ag na foirmeacha agus na giuirléidí go léir i do thionscadal agus ina aipeanna tríú Mura soláthraíonn tú do theimpléid Jinja2 féin le haghaidh giuirléidí nach bhfuil aon cheann acu, ní féidir leat an renderer seo a úsáid. Mar shampla, :mod: django.contrib.admin ní chuimsíonn teimpléid Jinja2 dá giuirléidí mar gheall ar a n-úsáid clibeanna teimpléad Django. #### `class Jinja2DivFormRenderer` > **Deprecated since Django 5.0** > > Deprecated since version 5.0. An t-ainm de:aicme: Jinja2. ### Teimpléad a choinneáil \`\` #### `class TemplatesSetting` Tugann an renderer seo smacht iomlán duit ar an gcaoi a bhfoinsítear teimpléid fhoirme agus giuirléid. Úsáideann sé: func: ~django.template.loader.get\_template chun teimpléid a aimsiú bunaithe ar an méid atá cumraithe sa socrú:: TEMPLATES. Úsáid an renderer seo in éineacht leis na teimpléid ionsuite teastaíonn ceachtar: - \\`\`'django.forms'\`\` in:setting: INSTALLED\_APPS agus inneall amháin ar a laghad le:setting: APP\_DIRS=True . - An eolaire teimpléid ionsuite a chur leis in:socrú: DIRS \\`de cheann de d'innill teimpléad. Chun an cosán sin a ghiniúint: ``` import django django.__path__[0] + "/forms/templates" # or '/forms/jinja2' ``` Úsáid an renderóir seo éilíonn tú a chinntiú gur féidir na teimpléid foirme a theastaíonn ó thionscadal a bheith suite. ## Comhthéacs ar fáil i dteimpléid formset Faigheann teimpléid Formset comhthéacs ó:meth: .baseFormSet.get\_Context. De réir réamhshocraithe, faigheann foirmeacha foclóir leis na luachanna seo a leanas: - `formset`: An sampla formset. ## Comhthéacs ar fáil i dteimpléid Faigheann teimpléid fhoirme comhthéacs ó:meth: .form.get\_context. De réir réamhshocraithe, faigheann foirmeacha foclóir leis na luachanna seo a leanas - `foirm`: An fhoirm cheangailte. - `fields`: Gach réimse ceangailte, seachas na réimsí i bhfolach. - `hidden_fields`: Gach réimse ceangailte i bhfolach. - earráidí : Gach earráid foirme neamh-bhaineann le réimse nó i bhfolach a bhaineann le réimse. ## Comhthéacs ar fáil i dteimpléid Faigheann teimpléid réimse comhthéacs ó:meth: .boundfield.get\_context. De réir réamhshocraithe, faigheann réimsí foclóir leis na luachanna seo a leanas: - `field`: Aicme: ~Django.Forms.BoundField. ## Comhthéacs ar fáil i dteimpléid Faigheann teimpléid giuirléid comhthéacs ó:meth: .widget.get\_context. De réir réamhshocraithe, faigheann giuirléidí luach amháin sa chomhthéacs, `giuirléid`. Is foclóir é seo ina bhfuil luachanna mar: - ainm \` - `luach` - `` `Attrs `` - `Is _fhidden` - `ainmne_teimpléad` Cuireann roinnt giuirléidí breise faisnéise leis an gcomhthéacs Mar shampla, gach giuirléid a shainmhíníonn fo-aicme `Input` `giuirléid ['cineál']` agus:class: .MultiWidget `widget ['subwidgets']` chun críocha lúbtha. ## Teimpléid foirmeacha ionsuite a shárú [`BaseFormSet.template_name`](/ga/5.2/topics/forms/formsets/#django.forms.formsets.BaseFormSet.template_name) Chun teimpléid foirmshraith a shárú, ní mór duit an renderer: class: TemplateSetting a úsáid. Ansin oibríonn teimpléid foirmshraith a shárú: doc: mar an gcéanna le a sháraíonn aon teimpléad eile i do thi\ onscadal. ## Teimpléid fhoirme ionsuite a shárú [`Form.template_name`](/ga/5.2/ref/forms/api/#django.forms.Form.template_name) Chun teimpléid fhoirme a shárú, ní mór duit an renderóir:class: TemplateSetting a úsáid. Ansin oibríonn teimpléid fhoirme thábhacht:doc: mar an gcéanna le a sháraíonn aon te\ impléad eile i do thionscadal. ## Teimpléid réimse ionsuite a shárú [`Field.template_name`](/ga/5.2/ref/forms/fields/#django.forms.Field.template_name) Chun teimpléid réimse a shárú, ní mór duit an renderer: class: TemplateSetting a úsáid. Ansin oibríonn teimpléid allamuigh a shárú: doc: mar an gcéanna le a sháraíonn aon te\ impléad eile i do thionscadal. ## Teimpléid giuirléid ionsuite a chur Tá tréith `template_name` ag gach giuirléid le luach mar `input.html`. Stóráiltear teimpléid giuirléid ionsuite sa chosán ```django/foirmeach/giuirléidí ``. Is féidir leat teimpléad saincheaptha a sholáthar do ``input.html``` trí `django/forms/widgets/input.html` a shainiú, mar shampla. Féach: ref: “giuirléidí ionsuite” le haghaidh ainm teimpléad gach giuirléid. Chun teimpléid giuirléid a athsháiriú, ní mór duit an renderer: class: TemplateSetting a úsáid. Ansin oibríonn teimpléid giuirléid thábhachtach: doc: mar an gcéanna le a sháraíonn aon teimpléad eile \ i do thionscadal.