Skip to content
This repository was archived by the owner on Sep 13, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (37 loc) · 1.18 KB

schema.md

File metadata and controls

54 lines (37 loc) · 1.18 KB

declare.json schema explained

version

Version numbering should look like major.small.patch, see versioning

inputs

These declarations are used to hint the program how to make the input form.

input_type

The input type is used to hint the program how to render the UI, currently we support:

  • textfiled - a single line text input
  • textarea - a multiline text input
  • picker - a dropdown menu
  • enum_picker a horizontal list of buttons
  • checkbox - a checkbox

For picker, enum_picker and checkbox you need to provide a options array, like these:

{
    "name": "key_1",
    "input_type": "picker",
    "options": [
        "option_1",
        "option_2",
        "option_3"
    ]
}

is_password

default_value

function_supported

List of reserved keywords to indicate which functionality does the js script support, you shouldn't write anything beyond your script supports

urls

List of urls the script calls network functions on, used for code review primarily and might be needed on some platform