← Element library

Content and scoring

Passage

Read passages in tabs.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

Print

Print view available

A passage with two tabs, "Hope Is the Thing with Feathers" and "Ineskeen Road, July Evening", showing the first poem, from The Complete Poems of Emily Dickinson, with line numbers 5 and 10 in the margin.
Passage example

Try the interaction

Live example: @pie-element/passage@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": {
    "passage": "@pie-element/passage@8.0.4"
  },
  "markup": "<passage id=\"example\"></passage>",
  "models": [
    {
      "id": "example",
      "element": "passage",
      "passages": [
        {
          "teacherInstructions": "Teacher instructions for first tab",
          "title": "Hope Is the Thing with Feathers",
          "subtitle": "from <em>The Complete Poems of Emily Dickinson</em>",
          "author": "by Emily Dickinson",
          "text": "<p><font style=\"visibility:hidden\">00000</font>Hope is the thing with feathers<br /><font style=\"visibility:hidden\">00000</font>That perches in the soul,<br /><font style=\"visibility:hidden\">00000</font>And sings the tune without the words,<br /><font style=\"visibility:hidden\">00000</font>And never stops at all,</p><p>5<font style=\"visibility:hidden\">0000</font>And sweetest in the gale is heard;<br /><font style=\"visibility:hidden\">00000</font>And sore must be the storm<br /><font style=\"visibility:hidden\">00000</font>That could abash the little bird<br /><font style=\"visibility:hidden\">00000</font>That kept so many warm.</p><p><font style=\"visibility:hidden\">00000</font>I&#8217;ve heard it in the chillest land,<br />10<font style=\"visibility:hidden\">000</font>And on the strangest sea;<br /><font style=\"visibility:hidden\">00000</font>Yet, never, in extremity,<br /><font style=\"visibility:hidden\">00000</font>It asked a crumb of me.</p>"
        },
        {
          "title": "Ineskeen Road, July Evening",
          "text": "The bicycles go by in twos and threes -<br/>\n        There's a dance in Billy Brennan's barn tonight,<br/>\n        And there's the half-talk code of mysteries<br/>\n        And the wink-and-elbow language of delight.<br/>\n        Half-past eight and there is not a spot<br/>\n        Upon a mile of road, no shadow thrown<br/>\n        That might turn out a man or woman, not<br/>\n        A footfall tapping secrecies of stone. <br/>\n        <p/>\n        I have what every poet hates in spite<br/>\n        Of all the solemn talk of contemplation.<br/>\n        Oh, Alexander Selkirk knew the plight<br/>\n        Of being king and government and nation.<br/>\n        A road, a mile of kingdom. I am king<br/>\n        Of banks and stones and every blooming thing.<br/>\n        "
        }
      ]
    }
  ]
}

Embed an item · Embed authoring · Print integration

Responses and scoring

This element displays content and collects no scored response.

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/passage@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 (11)
FieldTypeMeaningDefault / values
idRequiredstringIdentifier to identify the Pie Element in html markup, Must be unique within a pie item config.—
elementRequiredstringThe html Element tag name: the key in the item config's `elements` map, e.g. "multiple-choice"—
accessibilityCatalogsarrayQTI-aligned accessibility catalogs whose cards dock to content nodes by `data-catalog-idref`—
passagesRequiredarrayThe passages, in tab order—
teacherInstructionsEnabledbooleanIndicates if Teacher Instructions are enabledtrue
titleEnabledbooleanIndicates if title is enabledtrue
subtitleEnabledbooleanIndicates if subtitle is enabledtrue
textEnabledbooleanIndicates if text is enabledtrue
authorEnabledbooleanIndicates if author is enabled. The author's default model sets true.false
languagestringIndicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX—
extraCSSRulesExtraCSSRulesHost-supplied CSS scoped to the element—

Named object types

AccessibilityCatalog
FieldTypeMeaningDefault / values
identifierRequiredstringSee the named type or the example model.—
cardsRequiredarraySee the named type or the example model.—
CatalogCard
FieldTypeMeaningDefault / values
catalogRequiredstringSee the named type or the example model.—
languagestringSee the named type or the example model.—
contentstringSee the named type or the example model.—
payloadCatalogCardPayloadSee the named type or the example model.—
SignLanguageCardPayload
FieldTypeMeaningDefault / values
signLangstringLanguage 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.—
mediaRequiredMediaAssetRefSee the named type or the example model.—
fragmentMediaFragmentRangeSee the named type or the example model.—
MediaAssetRef
FieldTypeMeaningDefault / values
versionRequirednumberSee the named type or the example model.—
idRequiredstringSee the named type or the example model.—
kindRequiredMediaKindSee the named type or the example model.—
sourcesRequiredarraySee the named type or the example model.—
posterstringSee the named type or the example model.—
thumbnailstringSee the named type or the example model.—
durationSecondsnumberSee the named type or the example model.—
tracksarraySee the named type or the example model.—
transcriptTranscriptRefSee the named type or the example model.—
labelstringSee the named type or the example model.—
descriptionstringSee the named type or the example model.—
langstringLanguage 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
FieldTypeMeaningDefault / values
srcRequiredstringSee the named type or the example model.—
typestringMIME type, e.g. "video/mp4".—
widthnumberSee the named type or the example model.—
heightnumberSee the named type or the example model.—
bitratenumberSee the named type or the example model.—
TextTrackRef
FieldTypeMeaningDefault / values
srcRequiredstringSee the named type or the example model.—
kindRequiredstringSee the named type or the example model.—["captions","subtitles","descriptions","chapters","metadata"]
langRequiredstringSee the named type or the example model.—
labelRequiredstringSee the named type or the example model.—
defaultbooleanSee the named type or the example model.—
TranscriptRef
FieldTypeMeaningDefault / values
srcstringSee the named type or the example model.—
htmlstringSee the named type or the example model.—
plainTextstringSee the named type or the example model.—
langstringSee the named type or the example model.—
MediaFragmentRange
FieldTypeMeaningDefault / values
startSecondsRequirednumberSee the named type or the example model.—
endSecondsnumberSee the named type or the example model.—
SpokenAudioCardPayload
FieldTypeMeaningDefault / values
mediaRequiredMediaAssetRefSee the named type or the example model.—
fragmentMediaFragmentRangeSee the named type or the example model.—
PassageEntry
FieldTypeMeaningDefault / values
titlestringThe title of the passage; a passage without a title is labelled "Passage <n>"—
subtitlestringThe subtitle of the passage—
authorstringThe author of the passage—
textstringThe content of the passage—
teacherInstructionsstringIndicates teacher instructions—
teacherInstructionsEnabledbooleanOverrides the model's `teacherInstructionsEnabled` for this passage—
titleEnabledbooleanOverrides the model's `titleEnabled` for this passage—
subtitleEnabledbooleanOverrides the model's `subtitleEnabled` for this passage—
authorEnabledbooleanOverrides the model's `authorEnabled` for this passage—
textEnabledbooleanOverrides the model's `textEnabled` for this passage—
ExtraCSSRules
FieldTypeMeaningDefault / values
namesarraySee the named type or the example model.—
rulesstringSee the named type or the example model.—
Open the complete JSON Schema
configuration fields (13)
FieldTypeMeaningDefault / values
settingsPanelDisabledbooleanIndicates if the settings panel is not available—
titleEditableHtmlPluginConfigureRequiredTitle configuration—
subtitleEditableHtmlPluginConfigureRequiredSubtitle configuration—
authorEditableHtmlPluginConfigureRequiredAuthor configuration—
textEditableHtmlPluginConfigureRequiredText configuration—
teacherInstructionsEditableHtmlPluginConfigureRequiredTeacher Instructions configuration—
maxImageWidthPassageMaxImageDimensionsPropMaximum image width for input fields—
maxImageHeightPassageMaxImageDimensionsPropMaximum image height for input fields—
mathMlOptionsConfigureMathMLPropConfiguration for editable-html—
baseInputConfigurationEditableHtmlConfigurePropBase editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image—
languageConfigurePropWithEnabledLanguage configuration—
languageChoicesConfigureLanguageOptionsLanguage choices configuration Only available if language is enabled—
additionalPassageConfigurePropWithEnabledability to include a second passage—

Named object types

EditableHtmlPluginConfigureRequired
FieldTypeMeaningDefault / values
settingsbooleanIndicates if the item has to be displayed in the Settings Panel—
labelstringIndicates the label for the item that has to be displayed in the Settings Panel—
inputConfigurationEditableHtmlConfigurePropConfiguration for editable-html—
requiredbooleanIndicates if the item is required and the value cannot be empty—
EditableHtmlConfigureProp
FieldTypeMeaningDefault / values
mathEditableHtmlButtonConfigureSee the named type or the example model.—
audioEditableHtmlButtonConfigureSee the named type or the example model.—
videoEditableHtmlButtonConfigureSee the named type or the example model.—
imageEditableHtmlButtonConfigureSee the named type or the example model.—
customPluginsarrayAn 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).—
blockquoteEditableHtmlButtonConfigureSee the named type or the example model.—
h3EditableHtmlButtonConfigureSee the named type or the example model.—
charactersEditableHtmlButtonConfigureSee the named type or the example model.—
boldEditableHtmlButtonConfigureSee the named type or the example model.—
htmlEditableHtmlButtonConfigureSee the named type or the example model.—
italicEditableHtmlButtonConfigureSee the named type or the example model.—
ol_listEditableHtmlButtonConfigureSee the named type or the example model.—
redoEditableHtmlButtonConfigureSee the named type or the example model.—
strikethroughEditableHtmlButtonConfigureSee the named type or the example model.—
subEditableHtmlButtonConfigureSee the named type or the example model.—
supEditableHtmlButtonConfigureSee the named type or the example model.—
tableEditableHtmlButtonConfigureSee the named type or the example model.—
ul_listEditableHtmlButtonConfigureSee the named type or the example model.—
underlineEditableHtmlButtonConfigureSee the named type or the example model.—
undoEditableHtmlButtonConfigureSee the named type or the example model.—
textAlignEditableHtmlButtonConfigureSee the named type or the example model.—
showParagraphsEditableHtmlButtonConfigureSee the named type or the example model.—
separateParagraphsEditableHtmlButtonConfigureSee the named type or the example model.—
pasteFormattingEditableHtmlButtonConfigureSee the named type or the example model.—
superscriptEditableHtmlButtonConfigureSee the named type or the example model.—
subscriptEditableHtmlButtonConfigureSee the named type or the example model.—
languageCharactersEditableHtmlButtonConfigureSee the named type or the example model.—
responseAreaEditableHtmlButtonConfigureSee the named type or the example model.—
EditableHtmlButtonConfigure
FieldTypeMeaningDefault / values
disabledbooleanIndicates if the plugin is disabled or not—
CustomPlugin
FieldTypeMeaningDefault / values
eventRequiredstringThe 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.—
iconAltRequiredstringThe alt for the custom button icon—
iconTypeRequiredstringThe icon type. Currently, only "SVG" is supported.—
iconRequiredstringThe icon string. Currently, only SVG is supported, so it needs to be a valid svg.—
PassageMaxImageDimensionsProp
FieldTypeMeaningDefault / values
teacherInstructionsnumberIndicates the max dimension for images in teacher instructions—
promptnumberIndicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified—
rationalenumberIndicates the max dimension for images in rationale—
textnumberIndicates the max dimension for images in the passage text—
ConfigureMathMLProp
FieldTypeMeaningDefault / values
mmlOutputbooleanIndicates if model should have mathML output instead of latex—
mmlEditingbooleanIndicates if mathML that's already in model should be editable—
ConfigurePropWithEnabled
FieldTypeMeaningDefault / values
settingsbooleanIndicates if the item has to be displayed in the Settings Panel—
labelstringIndicates the label for the item that has to be displayed in the Settings Panel—
enabledbooleanIndicates 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)—
ConfigureLanguageOptions
FieldTypeMeaningDefault / values
labelRequiredstringSee the named type or the example model.—
optionsRequiredarraySee the named type or the example model.—
ConfigureLanguageOptionsProp
FieldTypeMeaningDefault / values
valueRequiredstringValue of the language option—
labelRequiredstringLabel of the language option—
Open the complete JSON Schema
session fields (2)
FieldTypeMeaningDefault / values
idstringIdentifier of the session—
elementstringThe element the session belongs to—
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