Type Alias LookupButtonFormElement

LookupButtonFormElement: {
    elementDependencies: LookupButtonFormElementDependency[];
    type: "lookupButton";
} & LookupFormElement

An element to allow the user to run a lookup by clicking a button. The lookup will be triggered automatically if all its dependencies are auto-lookup form elements.

The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

{
"id": "b1311ae0-6bb7-11e9-a923-1681be663d3e",
"type": "lookupButton",
"name": "My_Lookup",
"label": "My Lookup",
"hint": "Please run me, I like to be run."
}

Submission value will be true if the lookup ran before submitting or false if it did not run. It will also be false if it ran but its dependencies changed before submitting the form.

{
"submission": {
"[element.name]": true
}
}

Type declaration

  • elementDependencies: LookupButtonFormElementDependency[]

    The Form Elements that will determine if the lookup should be run. If any of the dependency elements are required, the lookup will be required.

  • type: "lookupButton"

    The type of Form Element.