Skip to content

Question model

kirsty-hames edited this page Jun 19, 2024 · 8 revisions

Question model

The following covers Core question model functionality: Feedback titles, Feedback image support.

Feedback titles

As of v6.50.2, feedback titles that use the old style of _feedback object will work as follows:

  1. If _feedback.altTitle is set, this will be used as a title aria label. No visual title is displayed.
  2. If _feedback.title is set and _feedback.altTitle is not set, a title is displayed with this value.
  3. If neither _feedback.title nor _feedback.altTitle are set, a title is displayed with the component's title.
  4. If none of the above are set, _globals._accessibility.altFeedbackTitle is used as an aria label and no visual title is displayed.
  5. Otherwise, no title is displayed or used as an aria label

Feedback image support

Support for feedback images was introduced in v6.20.5. This behaviour is fully backward compatible if the old style of _feedback objects are used. The new style feedback can be used in the new AAT when building by hand. It will not be supported in the classic AAT.

Images mirror the question feedback text so there are _feedback._correct, _feedback._partlyCorrectNotFinal, _feedback._partlyCorrectFinal, _feedback._incorrectNotFinal, _feedback._incorrectFinal and for _items[].feedback.

If an image is defined, the layout of the text and image is split 60% / 40% in favour of the text. If no image is defined the text defaults to 100% width.

The image position can be configured per feedback text via _imageAlignment. Options include: left: Image aligned to the left of the text area, top: Image aligned above the text area, right: Image aligned to the right of the text area and bottom: Image aligned below the text area. The default alignment is right.

Example _feedback JSON to be added to question component in component.json:

        "_feedback": {
          "title": "Global feedback title",
          "_classes": "",
          "_correct": {
            "altTitle": "",
            "title": "",
            "body": "Correct feedback final",
            "_classes": "",
            "_imageAlignment": "left",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "",
              "attribution": ""
            }
          },
          "_incorrectNotFinal": {
            "altTitle": "",
            "title": "",
            "body": "Incorrect feedback not final",
            "_classes": "",
            "_imageAlignment": "right",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "",
              "attribution": ""
            }
          },
          "_incorrectFinal": {
            "altTitle": "",
            "title": "",
            "body": "Incorrect feedback final",
            "_classes": "",
            "_imageAlignment": "left",
            "_graphic": {
              "_src": "course/en/images/single-width.png",
              "alt": "",
              "attribution": ""
            }
          }
        }

As per other Adapt images, alt and attribution properties are supported per feedback _graphic.


Clone this wiki locally