Matching and ordering

Placement Ordering

Drag items into the correct order.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

No print view in this package

The prompt "Arrange the fruits alphabetically" above a vertical list of four draggable tiles in the order Melon, Blueberry, Lemon, Pear. — Placement Ordering example

Try the interaction

Live example: @pie-element/placement-ordering@15.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": {
    "placement-ordering": "@pie-element/placement-ordering@15.0.4"
  },
  "markup": "<placement-ordering id=\"example\"></placement-ordering>",
  "models": [
    {
      "id": "example",
      "element": "placement-ordering",
      "choiceLabel": "Choices",
      "choices": [
        {
          "id": "c1",
          "label": "Blueberry"
        },
        {
          "id": "c2",
          "label": "Lemon"
        },
        {
          "id": "c3",
          "label": "Melon"
        },
        {
          "id": "c4",
          "label": "Pear"
        }
      ],
      "correctResponse": [
        "c1",
        "c2",
        "c3",
        "c4"
      ],
      "alternateResponses": [
        {
          "response": [
            "c4",
            "c3",
            "c2",
            "c1"
          ]
        }
      ],
      "feedback": {
        "correct": {
          "type": "custom",
          "custom": "foo"
        },
        "incorrect": {
          "type": "custom",
          "custom": "no"
        },
        "partial": {
          "type": "custom",
          "custom": "nearly"
        }
      },
      "feedbackEnabled": true,
      "prompt": "Arrange the fruits alphabetically",
      "promptEnabled": true,
      "numberedGuides": false,
      "orientation": "vertical",
      "partialScoring": false,
      "placementArea": false,
      "scoringType": "auto",
      "targetLabel": "Answers",
      "toolbarEditorPosition": "bottom",
      "rubricEnabled": false
    }
  ]
}

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/placement-ordering@15.0.6. Example version: 15.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.

model fields (32)

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`	`—`
`choiceLabel`	`string`	The label for possible choices	`—`
`choices`Required	`array`	Array of all the available choices	`—`
`correctResponse`	`array`	Array of the correct responses in the correct order. A bare string is a choice id; the author converts it to `{ id, weight: 0 }`.	`—`
`alternateResponses`	`array`	Array that contains the correct alternate responses	`—`
`feedback`	`ComplexFeedbackType`	Feedback for student answer	`—`
`prompt`	`string`	The item stem for the question	`—`
`promptEnabled`	`boolean`	Determines if prompt should show	`—`
`lockChoiceOrder`	`boolean`	Not read by this element.	`—`
`numberedGuides`	`boolean`	If placement type is placement; show ordering indicates if the boxes are numbered	`—`
`orientation`	`string`	The layout for displaying the choices	`"vertical"`["vertical","horizontal"]
`partialScoring`	`boolean`	Indicates if partialScoring is enabled	`—`
`placementArea`	`boolean`	Indicates if the items can be replaced with each other or if they can be placed inside other boxes	`—`
`rationale`	`string`	Indicates correct answer rationale	`—`
`removeTilesAfterPlacing`	`boolean`	Indicates if each choice will be removed from choices after becoming a target	`—`
`scoringType`	`string`	Indicates scoring type. The author's settings panel sets it; the controller does not read it.	`—`["auto","rubric"]
`studentInstructions`	`string`	Not read by this element.	`—`
`targetLabel`	`string`	The label for answer area if placement area is enabled	`—`
`feedbackEnabled`	`boolean`	Indicates if Feedback is enabled	`—`
`teacherInstructions`	`string`	Indicates teacher instructions	`—`
`rationaleEnabled`	`boolean`	Indicates if Rationale are enabled	`—`
`studentInstructionsEnabled`	`boolean`	Not read by this element. The author's settings panel toggles it and default models include it.	`—`
`teacherInstructionsEnabled`	`boolean`	Indicates if Teacher Instructions are enabled	`—`
`choiceLabelEnabled`	`boolean`	Indicates if Choice Label is enabled	`—`
`spellCheckEnabled`	`boolean`	Indicates if spellcheck is enabled for the author. Default value is true	`—`
`note`	`string`	Indicates the note for the answer	`—`
`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	`—`
`extraCSSRules`	`ExtraCSSRules`	Host-supplied CSS scoped to the element	`—`

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`	The id of the choice	`—`
`label`	`string`	The label of the choice	`—`

CorrectResponse

Field	Type	Meaning	Default / values
`id`Required	`string`	The id of the correct response	`—`
`weight`	`number`	The weight of the correct response Note: weights are not configurable in the existing component so we'll ignore it for now	`—`

AlternateResponse

Field	Type	Meaning	Default / values
`response`Required	`array`	Array that contains the alternate response ids	`—`

ComplexFeedbackType

Field	Type	Meaning	Default / values
`correct`	`FeedbackConfig`	Indicates the configuration for feedback when answer is correct	`—`
`incorrect`	`FeedbackConfig`	Indicates the configuration for feedback when answer is incorrect	`—`
`partial`	`FeedbackConfig`	Indicates the configuration for feedback when answer is partially correct	`—`

FeedbackConfig

Field	Type	Meaning	Default / values
`type`Required	`string`	Indicates the feedback type	`—`["default","custom","none"]
`default`	`string`	Indicates the feedback value	`—`
`custom`	`string`	Indicates the feedback custom value	`—`

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	`—`
`choiceLabel`	`EditableHtmlPluginConfigure`	Choice Label configuration	`—`
`choices`	`EditableHtmlPluginConfigure`	Choices configuration	`—`
`feedback`	`ConfigurePropWithEnabled`	Indicates whether feedback is enabled; `enabled` is not read	`—`
`prompt`	`EditableHtmlPluginConfigureRequired`	Item Stem configuration	`—`
`lockChoiceOrder`	`ConfigureProp`	Not read by this element.	`—`
`numberedGuides`	`ConfigureProp`	Numbered Guides configuration	`—`
`orientation`	`ConfigureProp`	Orientation configuration	`—`
`partialScoring`	`ConfigureProp`	Partial Scoring configuration	`—`
`placementArea`	`ConfigureProp`	Placement Area configuration	`—`
`rationale`	`EditableHtmlPluginConfigureRequired`	Rationale configuration	`—`
`spellCheck`	`ConfigurePropWithEnabled`	Configuration for the author's spellcheck; `enabled` is not read	`—`
`removeTilesAfterPlacing`	`ConfigureProp`	Remove tiles after placing configuration	`—`
`settingsPanelDisabled`	`boolean`	Indicates if the settings panel is not available	`—`
`scoringType`	`ConfigureProp`	Scoring Type configuration	`—`
`studentInstructions`	`ConfigureProp`	Student Instructions configuration	`—`
`targetLabel`	`ConfigureProp`	Target Label configuration	`—`
`teacherInstructions`	`EditableHtmlPluginConfigureRequired`	Teacher Instructions configuration	`—`
`maxImageWidth`	`PlacementOrderingMaxImageDimensions`	Maximum image width for input fields	`—`
`maxImageHeight`	`PlacementOrderingMaxImageDimensions`	Maximum image height for input fields	`—`
`withRubric`	`ConfigureProp`	Rubric configuration - only relevant in environments that use pie-player-components	`—`
`mathMlOptions`	`ConfigureMathMLProp`	Configuration for editable-html	`—`
`language`	`ConfigurePropWithEnabled`	Language configuration	`—`
`languageChoices`	`ConfigureLanguageOptions`	Language choices configuration Only available if language is enabled	`—`
`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.	`—`

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	`—`

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)	`—`

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	`—`

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	`—`

PlacementOrderingMaxImageDimensions

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	`—`
`choicesWithPlacementArea`	`number`	Only available for the width prop: indicates the max width for images in choices and choices labels when placement area is enabled	`—`
`choicesWithoutPlacementArea`	`number`	Only available for the width prop: indicates the max width for images in choices and choices labels when placement area is disabled	`—`
`choices`	`number`	Only available for the height prop: indicates the max height for images in choices and choices labels	`—`

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	`—`

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 (3)

Field	Type	Meaning	Default / values
`id`	`string`	Identifier of the session	`—`
`element`	`string`	The element the session belongs to	`—`
`value`	`array`	The choice ids in the order the learner placed them. With a placement area, an empty target is a hole in the array, which serializes as null.	`—`

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