Matching and ordering
Match List
Drag answers to match each prompt.
Delivery
Respond, review and evaluate
Authoring
No authoring view in this package
No print view in this package

Try the interaction
Live example: @pie-element/match-list@8.0.4 · players 1.0.0-beta.5.
Open all examples for this element →Use it in an item
Map the tag to an exact package version and match the model ID to the markup. The item player loads the views. You can use any frontend framework.
{
"elements": {
"match-list": "@pie-element/match-list@8.0.4"
},
"markup": "<match-list id=\"example\"></match-list>",
"models": [
{
"id": "example",
"element": "match-list",
"lockChoiceOrder": true,
"answers": [
{
"id": 2,
"title": "Battle of Lexington and Concord"
},
{
"id": 3,
"title": "Declaration of Independence"
},
{
"id": 1,
"title": "Boston Tea Party"
},
{
"id": 0,
"title": "French and Indian War"
},
{
"id": 4,
"title": "Constitutional Convention"
}
],
"prompt": "<p>Match each year to the corresponding historical event. Drag and drop the events.</p>",
"prompts": [
{
"id": 1,
"title": "1754",
"relatedAnswer": 0
},
{
"id": 2,
"title": "1773",
"relatedAnswer": 1
},
{
"id": 3,
"title": "1775",
"relatedAnswer": 2
},
{
"id": 4,
"title": "1776",
"relatedAnswer": 3
},
{
"id": 5,
"title": "1787",
"relatedAnswer": 4
}
]
}
]
} Responses and scoring
The controller defines scoring for this element. Browser scoring returns one outcome per element. Your application combines those outcomes into an item score and handles trusted server scoring.
Model, configuration and session reference
The model holds content, configuration controls the editor, and the session holds the response. Fields below come from generated JSON Schemas.
Schema version: @pie-element/match-list@8.0.6. Example version: 8.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.
model fields (13)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | string | Identifier to identify the Pie Element in html markup, Must be unique within a pie item config. | — |
elementRequired | string | The html Element tag name: the key in the item config's `elements` map, e.g. "multiple-choice" | — |
accessibilityCatalogs | array | QTI-aligned accessibility catalogs whose cards dock to content nodes by `data-catalog-idref` | — |
prompt | string | The question prompt or item stem | — |
prompts | array | The question prompts that are going to be displayed. The default model carries none. | — |
answers | array | The answer rows that are going to be displayed. The default model carries none. | — |
lockChoiceOrder | boolean | Indicates if answers should be locked in order according to the model or if they should be shuffed true - order is respected according to model false - order is shuffled | — |
duplicates | boolean | Indicates if duplicates are allowed | — |
partialScoring | boolean | Indicates if partial scoring should be used. Scoring treats an absent value as enabled. | — |
feedback | MatchListFeedback | Feedback shown in evaluate mode | — |
rationale | string | Indicates rationale for correct answer; shown to instructors in view and evaluate mode | — |
language | string | Indicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX | — |
config | object | Not read by this element: the controller defaults nest their values under this key, so the default model carries it, and the controller reads `prompts`, `answers` and `prompt` from the root | — |
Named object types
AccessibilityCatalog
| Field | Type | Meaning | Default / values |
|---|---|---|---|
identifierRequired | string | See the named type or the example model. | — |
cardsRequired | array | See the named type or the example model. | — |
CatalogCard
| Field | Type | Meaning | Default / values |
|---|---|---|---|
catalogRequired | string | See the named type or the example model. | — |
language | string | See the named type or the example model. | — |
content | string | See the named type or the example model. | — |
payload | CatalogCardPayload | See the named type or the example model. | — |
SignLanguageCardPayload
| Field | Type | Meaning | Default / values |
|---|---|---|---|
signLang | string | Language tag for the signed translation — BCP 47, which admits ISO 639-3 subtags for languages with no 639-1/2 code. "ase" is ASL, matching QTI 3 `xml:lang`. This is the language of the *adaptation*, not the item's base content language (AfA/PNP's `languageOfAdaptation`). The distinction is load bearing: a Spanish item's signed alternate is LSM, not ASL, so `signLang` must never be inferred from the item or assessment content language. Optional, and redundant on almost every card. The card's `language` states the same code and is the only field pie-players resolves a card on — resolution runs before anything knows the card is a signing card, so it can only key on the generic field — and the player falls back to it when this is absent. Author it only where the two differ: a card tagged with the item's content language (`language: 'en-US'`, `signLang: 'ase'`) so resolution reaches it by the default-language rung. The pie-api-aws importer emits `language` alone. | — |
mediaRequired | MediaAssetRef | See the named type or the example model. | — |
fragment | MediaFragmentRange | See the named type or the example model. | — |
MediaAssetRef
| Field | Type | Meaning | Default / values |
|---|---|---|---|
versionRequired | number | See the named type or the example model. | — |
idRequired | string | See the named type or the example model. | — |
kindRequired | MediaKind | See the named type or the example model. | — |
sourcesRequired | array | See the named type or the example model. | — |
poster | string | See the named type or the example model. | — |
thumbnail | string | See the named type or the example model. | — |
durationSeconds | number | See the named type or the example model. | — |
tracks | array | See the named type or the example model. | — |
transcript | TranscriptRef | See the named type or the example model. | — |
label | string | See the named type or the example model. | — |
description | string | See the named type or the example model. | — |
lang | string | Language of the asset itself, as authored metadata. Sign-language cards leave it unset: the card's `language` already states the adaptation language, and a second copy is a second thing to keep in agreement. | — |
MediaSource
| Field | Type | Meaning | Default / values |
|---|---|---|---|
srcRequired | string | See the named type or the example model. | — |
type | string | MIME type, e.g. "video/mp4". | — |
width | number | See the named type or the example model. | — |
height | number | See the named type or the example model. | — |
bitrate | number | See the named type or the example model. | — |
TextTrackRef
| Field | Type | Meaning | Default / values |
|---|---|---|---|
srcRequired | string | See the named type or the example model. | — |
kindRequired | string | See the named type or the example model. | —["captions","subtitles","descriptions","chapters","metadata"] |
langRequired | string | See the named type or the example model. | — |
labelRequired | string | See the named type or the example model. | — |
default | boolean | See the named type or the example model. | — |
TranscriptRef
| Field | Type | Meaning | Default / values |
|---|---|---|---|
src | string | See the named type or the example model. | — |
html | string | See the named type or the example model. | — |
plainText | string | See the named type or the example model. | — |
lang | string | See the named type or the example model. | — |
MediaFragmentRange
| Field | Type | Meaning | Default / values |
|---|---|---|---|
startSecondsRequired | number | See the named type or the example model. | — |
endSeconds | number | See the named type or the example model. | — |
SpokenAudioCardPayload
| Field | Type | Meaning | Default / values |
|---|---|---|---|
mediaRequired | MediaAssetRef | See the named type or the example model. | — |
fragment | MediaFragmentRange | See the named type or the example model. | — |
MatchListPrompt
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | string | number | Identifier for a question prompt | — |
titleRequired | string | Text that will be displayed in the question prompt row | — |
relatedAnswerRequired | string | number | Id for the correct answer for this question prompt | — |
MatchListAnswer
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | string | number | Identifier for an answer row; the response counts as complete only when every placed id is a number | — |
titleRequired | string | Text that will be displayed in the answer row | — |
MatchListFeedback
| Field | Type | Meaning | Default / values |
|---|---|---|---|
correct | MatchListFeedbackType | Indicates the configuration for feedback when answer is correct | — |
incorrect | MatchListFeedbackType | Indicates the configuration for feedback when answer is incorrect | — |
partial | MatchListFeedbackType | Indicates the configuration for feedback when answer is partially correct | — |
unanswered | MatchListFeedbackType | Indicates the configuration for feedback when there is no answer | — |
MatchListFeedbackType
| Field | Type | Meaning | Default / values |
|---|---|---|---|
typeRequired | string | Indicates the feedback type | —["default","none","custom"] |
default | string | Indicates the feedback value | — |
custom | string | Indicates the feedback custom value | — |
session fields (4)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
id | string | Identifier of the session | — |
element | string | The element the session belongs to | — |
value | object | The answer placed in each response area: the answer's `id`, keyed by the prompt's `id` | — |
shuffledValues | object | Prompt and answer ids in the order they were shuffled for this learner, when choice order is not locked | — |
Accessibility and content requirements
PIE targets WCAG 2.2 AA. Provide clear prompts and media alternatives, and test the question with a keyboard and assistive technology. Manual testing is still incomplete; see the coverage notes below.
Accessibility and evidence · Element evidence and manual checks(opens in new tab)
Element package source(opens in new tab) · Example source(opens in new tab) · Snapshot cb30a68f