submit

Der Submit ist eine Aktion, die das aktuelle Formular an das Backend-System überträgt. Hierfür wird eine POST-Nachricht gesendet. Als Antwort wird eine durchzuführende Aktion erwartet. Die Struktur des Nachrichtenaustauschs ist hier zu finden.

Ein Submit wird üblicherweise vom Benutzer über einen Button ausgelöst.

Bevor der Submit gesendet wird, wird eine Validierung durchgeführt. Der Submit wird abgebrochen, wenn bei der Validierung Fehler auftreten.

Übersicht

action ("submit")

Auszuführende Aktion.

payload (SubmitActionPayload)

Objekt, das die anzugebene Url beinhaltet.

SubmitActionPayload

url (string)

Url des Servers. Falls nicht angegeben, wird die submitUrl in der Konfiguration genutzt. Wenn diese Url ebenfalls nicht angegeben wird, schlägt der Submit direkt fehl und der User erhält die Fehlermeldung "missing submitUrl".

Beispiel

In dem folgenden Beispiel führt das Auslösen des Submits zu einem Fehler, da keine Nachricht von einem Server zurückkommt. Die Submit Nachricht mit dem aktuellen Stand des Formulars wird aber verschickt, was zum Beispiel im Network Tab der Developer-Tools zu erkennen ist. Für den User wird eine "server-side failure" Nachricht angezeigt.

Beispiel submit.json
submit.json
{
  "metaData": {
    "id": 0,
    "version": 0
  },
  "configuration": {
    "submitUrl": "http://localhost:3000/test"
  },
  "components": [
    {
      "type": "container",
      "label": "Submit",
      "components": [
        {
          "type": "button",
          "action": "submit",
          "label": "Submit Button"
        },
        {
          "type": "textfield",
          "value": "${/data/someValue}"
        }
      ]
    }
  ],
  "state": {
    "data": {
      "someValue": "Hello"
    }
  }
}

Keywords: