form-schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "WSM Form Format",
    "title": "Form",
    "properties": {
        "id": {
            "type": "string",
            "description": "Identifier, should be the filename without `.json`"
        },
        "name": {
            "type": "string",
            "description": "Display Name"
        },
        "description": {
            "type": "string",
            "description": "Short description displayed on the main page"
        },
        "icon": {
            "description": "Icon to display on the main page",
            "$ref": "./icon-schema.json"
        },
        "hidden": {
            "type": "boolean",
            "description": "If true, it will be hidden from the main page."
        },
        "items": {
            "type": "array",
            "minItems": 1,
            "items": {
                "type": "object",
                "properties": {
                    "type": {
                        "enum": ["text", "number", "counter", "boolean","header","radio","checkbox","text-area","date","dropdown","time"],
                        "description": "Sets the form component that this item uses. Required for all form elements."
                    },
                    "label": {
                        "type": "string",
                        "description": "The display text explaining what this form item is. Required for all form elements."
                    }
                },
                "required": [
                    "label", "type"
                ],
                "anyOf": [
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "not": {
                                        "enum": ["header"]
                                    }
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "exportLabel": {
                                    "type": "string",
                                    "description": "A short description which will be used when the form is exported or viewed in a table."
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "text"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "helperText": {
                                    "type": "string",
                                    "description": "Extra text below the input element to help the user type the right data in."
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "number"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "helperText": {
                                    "type": "string",
                                    "description": "Extra text below the input element to help the user type the right data in."
                                },
                                "errorText": {
                                    "type": "string",
                                    "description": "Extra text below the input element when you type a non number. Defaults to 'You can only enter numbers'"
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "counter"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "min": {
                                    "type": ["number", "null"],
                                    "description": "Minimum value this counter goes to, null to disable. Defaults to 0"
                                },
                                "max": {
                                    "type": ["number", "null"],
                                    "description": "Maximum value this counter goes to, null to disable. Defaults to 0"
                                },
                                "step": {
                                    "type": "number",
                                    "description": "The amount the + and - buttons change the value by. Defaults to 1"
                                },
                                "default": {
                                    "type": "number",
                                    "description": "The starting number of this counter. Defaults to 0"
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "boolean"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "default": {
                                    "type": "boolean",
                                    "description": "Override the default value, default false."
                                },
                                "trueValue": {
                                    "type": "string",
                                    "description": "Change the label of the true button, default 'True'"
                                },
                                "falseValue": {
                                    "type": "string",
                                    "description": "Change the label of the false button, default 'False'"
                                },
                                "trueColor": {
                                    "type": "string",
                                    "description": "HEX color of the true button when chosen, default shade of green."
                                },
                                "falseColor": {
                                    "type": "string",
                                    "description": "HEX color of the false button when chosen, default a shade of red."
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "header"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "description": {
                                    "type": "string",
                                    "description": "The text below the header. Commonly used to describe the section."
                                }
                            }
                        }
                    }, 
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "radio"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "options": {
                                    "type": "array",
                                    "description": "An array of strings representing each possible selection."
                                },
                                "default": {
                                    "type": "integer",
                                    "description": "The index of the default selected radio input. (Default: None)"
                                }
                                
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "checkbox"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "default": {
                                    "type": "boolean",
                                    "description": "Determines whether or not the checkbox should start checked."
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "text-area"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "helperText": {
                                    "type": "string",
                                    "description": "The text to display below the textbox to help users know what to enter."
                                }
                            }
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "dropdown"
                                    ]
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "options": {
                                    "type": "array",
                                    "description": "An array of strings representing each possible selection."
                                },
                                "default": {
                                    "type": "integer",
                                    "description": "The index of the default selected dropdown input. (Default: None)"
                                }
                                
                            }
                        }
                    }
                ]
            },
            "description": "List of form elements for this form."
        }
    },
    "required": [ "id", "name", "items"]
}