Skip to content

possible gui model

James Tocknell edited this page Mar 15, 2021 · 6 revisions

Sketch of GUI Specification

{
  "fields": [
    {
      "field-id": "a-field-id",
      "label": "A helpful label",
      "component": "name-of-component-to-use", # this says what web component to use to render/aquire value from
      "type-returned": "project-name::Type", # matches a type in the Project Model
      "documentation": "<p>Some HTML</p>", # the documentation on the field (a.k.a. where to put the "field manual" for lake mungo
      "component-parameters": {} # configure appearance/actions/etc. of component
    },
    ...
  ],
  "views": [
    {
      "view-id": "a-view-id",
      "fields": ["field-id1", "field-id2"], # ordering sets appearance order
      "next-view": "another-view-id", # either this gets handled by a component, or we stick it here
      "next-view-label": "Done!"
    }
  ],
  "start-view": "my-start-view-id"
}
Clone this wiki locally