← Element library

Choice and text

Select Text

Select the sentences that answer the question.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

Print

Print view available

The question "What sentences contain the character 6 in them?" above four sentences about two people cutting out stars, each outlined as a selectable token.
Select Text example

Try the interaction

Live example: @pie-element/select-text@14.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": {
    "select-text": "@pie-element/select-text@14.0.4"
  },
  "markup": "<select-text id=\"example\"></select-text>",
  "models": [
    {
      "id": "example",
      "element": "select-text",
      "highlightChoices": false,
      "feedback": {
        "correct": {
          "type": "default",
          "default": "Correct"
        },
        "incorrect": {
          "type": "default",
          "default": "Incorrect"
        },
        "partial": {
          "type": "default",
          "default": "Nearly"
        }
      },
      "partialScoring": false,
      "maxSelections": 2,
      "mode": "sentence",
      "rationale": "Rationale goes here.",
      "prompt": "What sentences contain the character 6 in them?",
      "promptEnabled": true,
      "toolbarEditorPosition": "bottom",
      "text": "<p>If 'tweren't for sight and sound and smell,<br />\nI'd like the city pretty well,<br />\nBut when it comes to getting rest,<br />\nI like the country lots the best.</p>\n\n<p>Sometimes it seems to me I must<br />\nJust quit the city's din and dust,<br />\nAnd get out where the sky is blue,<br />\nAnd say, now, how does it seem to you?</p>",
      "tokens": [
        {
          "text": "If 'tweren't for sight and sound and smell,",
          "start": 0,
          "end": 43
        },
        {
          "text": "I'd like the city pretty well,",
          "start": 44,
          "end": 74
        },
        {
          "text": "But when it comes to getting rest,",
          "start": 75,
          "end": 109
        },
        {
          "text": "I like the country lots the best.",
          "start": 110,
          "end": 143
        },
        {
          "text": "Sometimes it seems to me I must",
          "start": 145,
          "end": 176
        },
        {
          "text": "Just quit the city's din and dust,",
          "start": 177,
          "end": 211
        },
        {
          "text": "And get out where the sky is blue,",
          "start": 212,
          "end": 246
        },
        {
          "text": "And say, now, how does it seem to you?",
          "start": 247,
          "end": 285
        }
      ],
      "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/select-text@14.0.6. Example version: 14.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.

model fields (25)
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`—
maxSelectionsnumberThe maximum number of token selections a user can make when responding; 0 allows any number0
modestringThe selected mode for tokenizing the text. This is only used in the config UI to present the mode by which text has been tokenized for selection. The tokenizer writes `sentence`, `words` or `paragraphs`, and an empty string after a token edit in a newly opened author; `word` and `paragraph` are accepted for content written to the legacy contract."sentence"["sentence","words","paragraphs","word","paragraph",""]
partialScoringbooleanIndicates if partial scoring should be used. Scoring treats an absent value as enabled, while the default models set false.—
feedbackComplexFeedbackTypeFeedback for student responses—
tokensRequiredarrayThe selectable text tokens in the main text content—
textRequiredstringThe passage of text from which user may select responses—
promptstringThe user prompt/item stem—
promptEnabledbooleanDetermines if prompt should showtrue
highlightChoicesbooleanIndicates if the parts of text that are choosable, should be highligned when presented to student.false
rationalestringIndicates rationale for correct answer—
scoringTypestringIndicates scoring type"auto"["auto","rubric"]
studentInstructionsstringNot read by this element: it renders no student instructions—
teacherInstructionsstringIndicates teacher instructions—
feedbackEnabledbooleanIndicates if Feedback is enabledfalse
rationaleEnabledbooleanIndicates if Rationale are enabledtrue
studentInstructionsEnabledbooleanIndicates if Student Instructions are enabled; the author shows the toggle, and nothing renders themtrue
teacherInstructionsEnabledbooleanIndicates if Teacher Instructions are enabledtrue
spellCheckEnabledbooleanIndicates if spellcheck is enabled—
toolbarEditorPositionstringIndicates the editor's toolbar position which can be 'bottom' or 'top'"bottom"["bottom","top"]
rubricEnabledbooleanIndicates if Rubric is enabled—
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.—
ComplexFeedbackType
FieldTypeMeaningDefault / values
correctRequiredFeedbackTypeIndicates the configuration for feedback when answer is correct—
incorrectRequiredFeedbackTypeIndicates the configuration for feedback when answer is incorrect—
partialFeedbackTypeIndicates the configuration for feedback when answer is partially correct—
FeedbackType
FieldTypeMeaningDefault / values
typeRequiredstringIndicates the feedback type—["default","none","custom"]
defaultstringIndicates the feedback value—
customstringIndicates the feedback custom value—
TextToken
FieldTypeMeaningDefault / values
textstringThe token text—
startRequirednumberThe start point in the main text for this token—
endRequirednumberThe end point in the main text for this token—
correctbooleanIs selected does the token represent a correct response—
oldStartnumberThe start point before the author re-parsed the text; scoring matches a selection on either position—
oldEndnumberThe end point before the author re-parsed the text; scoring matches a selection on either position—
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 (30)
FieldTypeMeaningDefault / values
baseInputConfigurationEditableHtmlConfigurePropBase editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image—
selectionCountConfigurePropSelection Count configuration—
correctAnswerConfigurePropCorrect answer count configuration—
selectionsConfigurePropSelections configuration—
modeConfigurePropMode configuration—
partialScoringConfigurePropPartial Scoring configuration—
feedbackConfigurePropFeedback configuration—
tokensConfigurePropTokens configuration—
textConfigurePropText Content configuration—
promptEditableHtmlPluginConfigureRequiredPrompt configuration—
highlightChoicesConfigurePropHighlight Choices configuration—
rationaleEditableHtmlPluginConfigureRequiredRationale configuration—
settingsPanelDisabledbooleanIndicates if the settings panel is not available—
spellCheckConfigurePropWithEnabledConfiguration for the spellcheck; `enabled` is not read—
scoringTypeConfigurePropScoring Type configuration—
studentInstructionsConfigurePropStudent Instructions configuration—
teacherInstructionsEditableHtmlPluginConfigureRequiredTeacher Instructions configuration—
maxSelectionsnumberMaximum number of selected tokens in correct answer—
minTokensnumberMinimum number of tokens2
maxTokensnumberMaximum number of tokens—
maxImageWidthConfigureMaxImageDimensionsPropMaximum image width for input fields—
maxImageHeightConfigureMaxImageDimensionsPropMaximum image height for input fields—
withRubricConfigurePropRubric configuration - only relevant in environments that use pie-player-components—
mathMlOptionsConfigureMathMLPropConfiguration for editable-html—
languageConfigurePropWithEnabledLanguage configuration—
languageChoicesConfigureLanguageOptionsLanguage choices configuration Only available if language is enabled—
contentDimensionsContentDimensionsDimensions of the authoring container—
showPromptbooleanNot read by this element: the model's `promptEnabled` shows the prompt—
promptLabelstringNot read by this element: `prompt.label` labels the prompt—
settingsPartialScoringbooleanNot read by this element: `partialScoring.settings` shows the partial scoring control—

Named object types

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.—
ConfigureProp
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—
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—
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)—
ConfigureMaxImageDimensionsProp
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—
ConfigureMathMLProp
FieldTypeMeaningDefault / values
mmlOutputbooleanIndicates if model should have mathML output instead of latex—
mmlEditingbooleanIndicates if mathML that's already in model should be editable—
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—
ContentDimensions
FieldTypeMeaningDefault / values
maxHeightstring | numberSee the named type or the example model.—
maxWidthstring | numberSee the named type or the example model.—
minHeightstring | numberSee the named type or the example model.—
minWidthstring | numberSee the named type or the example model.—
Open the complete JSON Schema
session fields (3)
FieldTypeMeaningDefault / values
idstringIdentifier of the session—
elementstringThe element the session belongs to—
selectedTokensarrayThe tokens the student selected—

Named object types

TextToken
FieldTypeMeaningDefault / values
textstringThe token text—
startRequirednumberThe start point in the main text for this token—
endRequirednumberThe end point in the main text for this token—
correctbooleanIs selected does the token represent a correct response—
oldStartnumberThe start point before the author re-parsed the text; scoring matches a selection on either position—
oldEndnumberThe end point before the author re-parsed the text; scoring matches a selection on either position—
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