Matching and ordering

Drag In The Blank

Drag words into blanks to complete a sentence.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

No print view in this package

The prompt "Complete the sentence by dragging the correct words into the blanks." above the sentence "The ___ is the largest planet in our solar system, while ___ is the smallest." and the word tiles Mercury, Saturn, Jupiter and Mars. — Drag In The Blank example

Try the interaction

Live example: @pie-element/drag-in-the-blank@11.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": {
    "drag-in-the-blank": "@pie-element/drag-in-the-blank@11.0.4"
  },
  "markup": "<drag-in-the-blank id=\"example\"></drag-in-the-blank>",
  "models": [
    {
      "id": "example",
      "element": "drag-in-the-blank",
      "prompt": "<p>Complete the sentence by dragging the correct words into the blanks.</p>",
      "promptEnabled": true,
      "markup": "<p>The {{0}} is the largest planet in our solar system, while {{1}} is the smallest.</p>",
      "choices": [
        {
          "id": "0",
          "value": "Jupiter"
        },
        {
          "id": "1",
          "value": "Mercury"
        },
        {
          "id": "2",
          "value": "Saturn"
        },
        {
          "id": "3",
          "value": "Mars"
        }
      ],
      "correctResponse": {
        "0": "0",
        "1": "1"
      },
      "choicesPosition": "below",
      "duplicates": false,
      "lockChoiceOrder": false,
      "partialScoring": true,
      "rationaleEnabled": true,
      "rationale": "<p>Jupiter is the largest planet with a diameter of about 86,881 miles, while Mercury is the smallest with a diameter of only 3,032 miles.</p>",
      "teacherInstructionsEnabled": true,
      "teacherInstructions": "<p>This tests basic planetary knowledge.</p>",
      "toolbarEditorPosition": "bottom"
    }
  ]
}

Embed an item · Embed authoring · Print integration

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.

Scoring, partial credit and rubrics →

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/drag-in-the-blank@11.0.6. Example version: 11.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.

model fields (33)

Field	Type	Meaning	Default / values
`id`Required	`string`	Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.	`—`
`element`Required	`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`	`—`
`choices`Required	`array`	Array of all the available choices	`—`
`choicesPosition`	`string`	Indicates where the choices should be presented in relation to the markup.	`"below"`["above","below","left","right"]
`correctResponse`Required	`CorrectResponse`	Object containing the correct answer for each response area	`—`
`alternateResponses`	`AlternateResponses`	Alternative correct choices for each response area	`—`
`duplicates`	`boolean`	Indicates if duplicates are enabled	`true`
`markup`Required	`string`	The markup for the pie-ui element: response areas are `{{index}}` placeholders	`—`
`slateMarkup`	`string`	The authoring editor's markup, with response areas as elements; the author derives `markup` from it	`—`
`lockChoiceOrder`	`boolean`	Indicates if the choices are presented in a fixed order	`—`
`partialScoring`	`boolean`	Indicates that the item should use partial scoring	`—`
`prompt`	`string`	The item stem for the question	`—`
`promptEnabled`	`boolean`	Indicates if the prompt is enabled	`—`
`rationale`	`string`	Indicates correct answer rationale	`—`
`studentInstructions`	`string`	Not read by this element	`—`
`teacherInstructions`	`string`	Indicates teacher instructions	`—`
`rubric`	`string`	Not read by this element	`—`
`rationaleEnabled`	`boolean`	Indicates if Rationale are enabled	`—`
`spellCheckEnabled`	`boolean`	Indicates if spellcheck is enabled for the author. Default value is true	`—`
`studentInstructionsEnabled`	`boolean`	Not read by this element; default models include it	`—`
`teacherInstructionsEnabled`	`boolean`	Indicates if Teacher Instructions are enabled	`—`
`toolbarEditorPosition`	`string`	Indicates the editor's toolbar position which can be 'bottom' or 'top'	`"bottom"`["bottom","top"]
`rubricEnabled`	`boolean`	Indicates if Rubric is enabled	`—`
`language`	`string`	Indicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX	`—`
`fontSizeFactor`	`number`	Indicates font size adjustment factor	`—`
`autoplayAudioEnabled`	`boolean`	Indicates if the audio for the prompt should autoplay	`—`
`autoplayAudioHeld`	`boolean`	Set by the player when the host holds autoplay; it outranks `autoplayAudioEnabled`	`—`
`completeAudioEnabled`	`boolean`	Indicates if the audio should reach the end before the item can be marked as 'complete'	`—`
`customAudioButton`	`CustomAudioButton`	Indicates if the audio should be replaced with a custom audio button	`—`
`extraCSSRules`	`ExtraCSSRules`	Host-supplied CSS scoped to the element	`—`
`disabled`	`boolean`	Not read: the controller sets `disabled` from the environment. Default models include it.	`—`
`mode`	`string`	Not read: the controller sets `mode` from the environment. Default models include it.	`—`["gather","view","evaluate"]

Named object types

AccessibilityCatalog

Field	Type	Meaning	Default / values
`identifier`Required	`string`	See the named type or the example model.	`—`
`cards`Required	`array`	See the named type or the example model.	`—`

CatalogCard

Field	Type	Meaning	Default / values
`catalog`Required	`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.	`—`
`media`Required	`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
`version`Required	`number`	See the named type or the example model.	`—`
`id`Required	`string`	See the named type or the example model.	`—`
`kind`Required	`MediaKind`	See the named type or the example model.	`—`
`sources`Required	`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
`src`Required	`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
`src`Required	`string`	See the named type or the example model.	`—`
`kind`Required	`string`	See the named type or the example model.	`—`["captions","subtitles","descriptions","chapters","metadata"]
`lang`Required	`string`	See the named type or the example model.	`—`
`label`Required	`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
`startSeconds`Required	`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
`media`Required	`MediaAssetRef`	See the named type or the example model.	`—`
`fragment`	`MediaFragmentRange`	See the named type or the example model.	`—`

Choice

Field	Type	Meaning	Default / values
`id`Required	`string`	Identifier of the choice; response areas store it as their answer	`—`
`value`Required	`string`	The markup of the choice	`—`

CustomAudioButton

Field	Type	Meaning	Default / values
`playImage`Required	`string`	image url for the play state	`—`
`pauseImage`Required	`string`	image url for the pause state	`—`

ExtraCSSRules

Field	Type	Meaning	Default / values
`names`	`array`	See the named type or the example model.	`—`
`rules`	`string`	See the named type or the example model.	`—`

Open the complete JSON Schema

configuration fields (28)

Field	Type	Meaning	Default / values
`baseInputConfiguration`	`EditableHtmlConfigureProp`	Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image	`—`
`choices`	`ConfigureProp`	Not read by this element	`—`
`choicesPosition`	`ConfigureProp`	Settings Panel control for the choices position	`—`
`duplicates`	`ConfigureProp`	Duplicates configuration	`—`
`lockChoiceOrder`	`ConfigureProp`	Settings Panel control for locking the choice order	`—`
`partialScoring`	`ConfigureProp`	Settings Panel control for partial scoring	`—`
`prompt`	`EditableHtmlPluginConfigureRequired`	Item Stem configuration	`—`
`settingsPanelDisabled`	`boolean`	Indicates if the settings panel is not available	`—`
`spellCheck`	`ConfigurePropWithEnabled`	Configuration for the author's spellcheck; `enabled` is not read	`—`
`rationale`	`EditableHtmlPluginConfigureRequired`	Rationale configuration	`—`
`studentInstructions`	`ConfigureProp`	Not read by this element	`—`
`teacherInstructions`	`EditableHtmlPluginConfigureRequired`	Teacher Instructions configuration	`—`
`addChoice`	`EditableHtmlPluginConfigure`	Add choice configuration	`—`
`rubric`	`ConfigureProp`	Not read by this element: `withRubric` shows the rubric control	`—`
`mathMlOptions`	`ConfigureMathMLProp`	Configuration for editable-html	`—`
`minChoices`	`number`	Minimum number of choices	`2`
`maxChoices`	`number`	Maximum number of choices	`—`
`maxResponseAreas`	`number`	Maximum number of response areas	`—`
`maxImageWidth`	`MaxImageDimensions`	Maximum image width for input fields	`—`
`maxImageHeight`	`MaxImageDimensions`	Maximum image height for input fields	`—`
`withRubric`	`ConfigureProp`	Rubric configuration - only relevant in environments that use pie-player-components	`—`
`language`	`ConfigurePropWithEnabled`	Language configuration	`—`
`languageChoices`	`ConfigureLanguageOptions`	Language choices configuration Only available if language is enabled	`—`
`maxLength`	`number`	Maximum character limit for each answer choice	`—`
`contentDimensions`	`ContentDimensions`	Dimensions of the authoring container	`—`
`showPrompt`	`boolean`	Not read by this element: the model's `promptEnabled` shows the prompt	`—`
`promptLabel`	`string`	Not read by this element: `prompt.label` labels the prompt	`—`
`settingsPartialScoring`	`boolean`	Not read by this element: `partialScoring.settings` shows the partial scoring control	`—`

Named object types

EditableHtmlConfigureProp

Field	Type	Meaning	Default / values
`math`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`audio`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`video`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`image`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`customPlugins`	`array`	An array of objects that determine custom plugins. A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when the button gets pressed (event).	`—`
`blockquote`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`h3`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`characters`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`bold`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`html`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`italic`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`ol_list`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`redo`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`strikethrough`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`sub`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`sup`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`table`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`ul_list`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`underline`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`undo`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`textAlign`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`showParagraphs`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`separateParagraphs`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`pasteFormatting`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`superscript`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`subscript`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`languageCharacters`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`responseArea`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`

EditableHtmlButtonConfigure

Field	Type	Meaning	Default / values
`disabled`	`boolean`	Indicates if the plugin is disabled or not	`—`

CustomPlugin

Field	Type	Meaning	Default / values
`event`Required	`string`	The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used). The event is emitted with the "PIE-" prefix.	`—`
`iconAlt`Required	`string`	The alt for the custom button icon	`—`
`iconType`Required	`string`	The icon type. Currently, only "SVG" is supported.	`—`
`icon`Required	`string`	The icon string. Currently, only SVG is supported, so it needs to be a valid svg.	`—`

ConfigureProp

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`

EditableHtmlPluginConfigureRequired

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`inputConfiguration`	`EditableHtmlConfigureProp`	Configuration for editable-html	`—`
`required`	`boolean`	Indicates if the item is required and the value cannot be empty	`—`

ConfigurePropWithEnabled

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`enabled`	`boolean`	Indicates the value of the item if it affects config-ui (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)	`—`

EditableHtmlPluginConfigure

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`inputConfiguration`	`EditableHtmlConfigureProp`	Configuration for editable-html	`—`

ConfigureMathMLProp

Field	Type	Meaning	Default / values
`mmlOutput`	`boolean`	Indicates if model should have mathML output instead of latex	`—`
`mmlEditing`	`boolean`	Indicates if mathML that's already in model should be editable	`—`

MaxImageDimensions

Field	Type	Meaning	Default / values
`teacherInstructions`	`number`	Indicates the max dimension for images in teacher instructions	`—`
`prompt`	`number`	Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified	`—`
`rationale`	`number`	Indicates the max dimension for images in rationale	`—`
`choice`	`number`	Indicates the max dimension for images in choices	`—`

ConfigureLanguageOptions

Field	Type	Meaning	Default / values
`label`Required	`string`	See the named type or the example model.	`—`
`options`Required	`array`	See the named type or the example model.	`—`

ConfigureLanguageOptionsProp

Field	Type	Meaning	Default / values
`value`Required	`string`	Value of the language option	`—`
`label`Required	`string`	Label of the language option	`—`

ContentDimensions

Field	Type	Meaning	Default / values
`maxHeight`	`string \| number`	See the named type or the example model.	`—`
`maxWidth`	`string \| number`	See the named type or the example model.	`—`
`minHeight`	`string \| number`	See the named type or the example model.	`—`
`minWidth`	`string \| number`	See the named type or the example model.	`—`

Open the complete JSON Schema

session fields (8)

Field	Type	Meaning	Default / values
`id`	`string`	Identifier of the session	`—`
`element`	`string`	The element the session belongs to	`—`
`value`	`object`	The id of the choice placed in each response area, keyed by the area's index	`—`
`selector`	`string`	How the learner gave the last response; the delivery writes `Mouse`	`—`
`shuffledValues`	`array`	Choice ids in the order they were shuffled for this learner, when choice order is not locked	`—`
`audioStartTime`	`number`	Timestamp (ms) when the prompt's auto-played audio started	`—`
`audioEndTime`	`number`	Timestamp (ms) when the prompt's auto-played audio ended	`—`
`waitTime`	`number`	Milliseconds the learner waited for the prompt's auto-played audio to finish	`—`

Open the complete JSON Schema

How to use the schemas →

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