UXDL 0.1 Specification

1uxdl: "0.1"          # REQUIRED format version string
2app: String           # Optional application name
3title: String         # Optional specification title
4screens: Object       # REQUIRED dictionary of screens
5actors: Object        # Optional dictionary of actors
6groups: Object        # Optional dictionary of screen clusters
7slices: Object        # Optional dictionary of requirement slices
8metadata: Object      # Optional open document metadata

1screens:
2  <screen_id>:
3    name: String      # REQUIRED human surface label
4    type: String      # page | modal | sheet | drawer | panel | overlay
5    parent: String    # Optional host screen ID for sub-screens
6    states:
7      <state_id>: String | Object
8    actions:
9      <action_id>: Object

1actions:
2  <action_id>:
3    name: String      # Human action label
4    actor: String     # Identifier of initiating actor
5    relations:
6      <relation_id>:
7        to: String         # Target screen or state ID
8        external: String   # External URL string
9        end: Boolean       # True if terminal flow
10        when: String       # Natural language condition