Options Specification Property

Name

http://lynx-json.org/options

Meaning

The options property of a specification identifies another value that provides options for the current input value.

Format Rules

The options property is OPTIONAL. If present, its value MUST be the property name of the value that provides options for the value being described by the specification.

Examples

{
  "favoriteMovie": null,
  "listOfMovies": [
    "Fletch",
    "Caddyshack",
    "Christmas Vacation"
  ],
  "spec": {
    "hints": [ "form" ],
    "children": [
      {
        "name": "favoriteMovie",
        "visibility": "hidden",
        "hints": [ "http://example.com/movie-title", "text" ],
        "input": true,
        "options": "listOfMovies"
      },
      {
        "name": "listOfMovies",
        "hints": [ "container" ],
        "children": {
          "hints": [ "http://example.com/movie-title", "text" ],
          "option": true
        }
      }
    ]
  }
}

{
  "favoriteMovie": null,
  "listOfMovies": [
    { "title": "Fletch", "id": "1" },
    { "title": "Caddyshack", "id": "2" },
    { "title": "Christmas Vacation", "id": "3" }
  ],
  "spec": {
    "hints": [ "form" ],
    "children": [
      {
        "name": "favoriteMovie",
        "visibility": "hidden",
        "hints": [ "http://example.com/movie-id", "text" ],
        "input": true,
        "options": "listOfMovies"
      },
      {
        "name": "listOfMovies",
        "hints": [ "container" ],
        "children": {
          "hints": [ "container" ],
          "children": [
            {
              "name": "title",
              "hints": [ "text" ]
            },
            {
              "name": "id",
              "hints": [ "http://example.com/movie-id", "text" ],
              "visibility": "hidden"
            }
          ],
          "option": true
        }
      }
    ]
  }
}

{
  "favoriteMovie": null,
  "listOfMovies": {
    "src": "http://example.com/movies/fav/options",
    "type": "application/lynx+json"
  },
  "spec": {
    "hints": [ "form" ],
    "children": [
      {
        "name": "favoriteMovie",
        "visibility": "hidden",
        "hints": [ "http://example.com/movie-title", "text" ],
        "input": true,
        "options": "listOfMovies"
      },
      {
        "name": "listOfMovies",
        "hints": [ "content" ]
      }
    ]
  }
}

Multi-Valued Text Input with Options

{
  "favoriteMovies": null,
  "listOfMovies": {
    "src": "http://example.com/movies/fav/options",
    "type": "application/lynx+json"
  },
  "spec": {
    "hints": [ "form" ],
    "children": [
      {
        "name": "favoriteMovies",
        "visibility": "hidden",
        "input": true,
        "options": "listOfMovies",
        "children": {
          "hints": [ "http://example.com/movie-title", "text" ],
          "input": true
        }
      },
      {
        "name": "listOfMovies",
        "hints": [ "content" ]
      }
    ]
  }
}

Authoring Rules

None

Authoring Considerations

None

User Agent Rules

An "option" is defined as a value that is described by a hint matching the most specific hint describing the input value.

• When finding the value identified by the options property, the user agent MUST use the process for finding values.
• For the value identified by the options property, the user agent MUST identify the options in the value (including the value itself).
• The user agent MUST provide the user with a control to select and deselect each identified option. Starting from the option and then its ancestors, the first value that is described by a specification with an option property MUST be the control.
• For multi-valued inputs, selecting an option adds the value to the input container and deselecting an option removes the value from the input container.

User Agent Considerations

None