Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
swashbuck committed Sep 27, 2023
1 parent ae4fe6e commit a7aa0cc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
* failed
* passed

The 'incomplete' image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false` - otherwise it can safely be left out.
The `_assessmentIncomplete` image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion (i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false`). Otherwise, it can safely be left out.

You *must* specify both the failed and passed images. If you don't want to have a different graphic for each of those assessment states you should probably just be using the standard graphic component..!
You *must* specify both the failed and passed images (`_assessmentFailed` and `_assessmentPassed`). If you don't want to have a different graphic for each of those assessment states, you should probably just be using the standard Graphic component.

It is expected that most of the time this component will have `_isOptional: true` - but if not, it does support the same `_setCompletionOn` settings as the Assessment Results component.
It is expected that most of the time this component will have `_isOptional: true`. If it is _not_ optional, it does support the same `_setCompletionOn` settings as the Assessment Results component.

## Limitations
Hasn't yet had a properties.schema added and set up - so isn't Adapt Authoring Tool compatible.
Hasn't yet had schemas added and set up, so it isn't Adapt Authoring Tool compatible.

----------------------------
**Framework versions:** 5+
Expand Down

0 comments on commit a7aa0cc

Please sign in to comment.