Widget smFlow

Widget smFlow

The smFlow widget displays a locale specific select field for the values of a Status Machine Flow Status.

During the life of a Form, the widget will always make the same request for the list of reachable values. The value to base this request on can be set in the formDataOriginal object next to the formDataObject. If the formDataOriginal object does not contain a value for the property, the value - is used.

Important: The schema properties minItems and enum must be set to 0 and [].

Example

{
    "schema": {
        "properties": {
            "mySmFlowProperty": {
                "type": "string",
                "minItems": 0,
                "enum": []
            }
        }
    },
    "form": [
        "mySmFlowProperty"
    ],
    "uiSchema": {
        "mySmFlowProperty": {
            "widget": "smFlow",
            "flow": "MY_SM_FLOW",
            "status": "MY_SM_FLOW_STATUS"
        }
    },
    "formData": {
        "mySmFlowProperty": "MY_SM_FLOW_STATUS_VALUE_1"
    },
    "formDataOriginal": {
        "mySmFlowProperty": "MY_SM_FLOW_STATUS_DEFAULT_VALUE"
    }
}

This will render a select field with the reachable flow status values of the MY_SM_FLOW_STATUS in the MY_SM_FLOW, using MY_SM_FLOW_STATUS_DEFAULT_VALUE as the value used to calculate reachable values. The locale of the client will be used to render the flow status value labels.