Unterformular

Ein wiederverwendbarer Formularbaustein für list-Felder, yaml-Felder und Wizard-Seiten


Ein Unterformular ist ein wiederverwendbarer Formularbaustein. Es erscheint nicht in der Kachelansicht und kann nicht direkt abgesendet werden. Stattdessen wird darauf verwiesen von:

  • einem list-Feld: öffnet das Unterformular als Drilldown-Editor für jede Zeile
  • einem yaml-Feld mit der Eigenschaft subform: öffnet das Unterformular als Drilldown-Editor für ein einzelnes Objekt
  • einem wizard-Schritt: stellt das Unterformular als eine Seite des Wizards dar

A reusable form fragment used as the per-row editor of a list field, or as the single-object editor of a yaml field with the subform property.
Subforms are not shown in the tile view and cannot be submitted directly.
They share the same field types and validation rules as regular forms.

Address subform

- name: Address
  type: subform
  fields:
    - name: street
      type: text
      label: Street
      required: true
    - name: city
      type: text
      label: City
      required: true
    - name: country
      type: text
      label: Country
      required: true
- name: My Main Form
  type: ansible
  playbook: site.yml
  roles:
    - default
  fields:
    - name: addresses
      type: list
      label: Addresses
      subform: Address

Eigenschaften

Unterformulare haben keine typspezifischen Eigenschaften. Sie verwenden nur die gemeinsamen Formulareigenschaften: name, description, help, type und fields.

Dient ein Unterformular als Wizard-Seite, liefern seine description und help die Standardwerte für title und help des Schritts. Es kann außerdem showHelp setzen, um diese Hilfe beim Laden der Seite aufzuklappen.

Ausführungseigenschaften (playbook, template, roles, inventory usw.) gelten nicht für Unterformulare, da ein Unterformular nie direkt abgesendet wird.