Choice and text
Select Text
Select the sentences that answer the question.
Delivery
Respond, review and evaluate
Authoring
Visual editor available
Print view available

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
}
]
} 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/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)
| 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` | — |
maxSelections | number | The maximum number of token selections a user can make when responding; 0 allows any number | 0 |
mode | string | The 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",""] |
partialScoring | boolean | Indicates if partial scoring should be used. Scoring treats an absent value as enabled, while the default models set false. | — |
feedback | ComplexFeedbackType | Feedback for student responses | — |
tokensRequired | array | The selectable text tokens in the main text content | — |
textRequired | string | The passage of text from which user may select responses | — |
prompt | string | The user prompt/item stem | — |
promptEnabled | boolean | Determines if prompt should show | true |
highlightChoices | boolean | Indicates if the parts of text that are choosable, should be highligned when presented to student. | false |
rationale | string | Indicates rationale for correct answer | — |
scoringType | string | Indicates scoring type | "auto"["auto","rubric"] |
studentInstructions | string | Not read by this element: it renders no student instructions | — |
teacherInstructions | string | Indicates teacher instructions | — |
feedbackEnabled | boolean | Indicates if Feedback is enabled | false |
rationaleEnabled | boolean | Indicates if Rationale are enabled | true |
studentInstructionsEnabled | boolean | Indicates if Student Instructions are enabled; the author shows the toggle, and nothing renders them | true |
teacherInstructionsEnabled | boolean | Indicates if Teacher Instructions are enabled | true |
spellCheckEnabled | boolean | Indicates if spellcheck is 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 | — |
extraCSSRules | ExtraCSSRules | Host-supplied CSS scoped to the element | — |
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. | — |
ComplexFeedbackType
| Field | Type | Meaning | Default / values |
|---|---|---|---|
correctRequired | FeedbackType | Indicates the configuration for feedback when answer is correct | — |
incorrectRequired | FeedbackType | Indicates the configuration for feedback when answer is incorrect | — |
partial | FeedbackType | Indicates the configuration for feedback when answer is partially correct | — |
FeedbackType
| 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 | — |
TextToken
| Field | Type | Meaning | Default / values |
|---|---|---|---|
text | string | The token text | — |
startRequired | number | The start point in the main text for this token | — |
endRequired | number | The end point in the main text for this token | — |
correct | boolean | Is selected does the token represent a correct response | — |
oldStart | number | The start point before the author re-parsed the text; scoring matches a selection on either position | — |
oldEnd | number | The end point before the author re-parsed the text; scoring matches a selection on either position | — |
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. | — |
configuration fields (30)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
baseInputConfiguration | EditableHtmlConfigureProp | Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image | — |
selectionCount | ConfigureProp | Selection Count configuration | — |
correctAnswer | ConfigureProp | Correct answer count configuration | — |
selections | ConfigureProp | Selections configuration | — |
mode | ConfigureProp | Mode configuration | — |
partialScoring | ConfigureProp | Partial Scoring configuration | — |
feedback | ConfigureProp | Feedback configuration | — |
tokens | ConfigureProp | Tokens configuration | — |
text | ConfigureProp | Text Content configuration | — |
prompt | EditableHtmlPluginConfigureRequired | Prompt configuration | — |
highlightChoices | ConfigureProp | Highlight Choices configuration | — |
rationale | EditableHtmlPluginConfigureRequired | Rationale configuration | — |
settingsPanelDisabled | boolean | Indicates if the settings panel is not available | — |
spellCheck | ConfigurePropWithEnabled | Configuration for the spellcheck; `enabled` is not read | — |
scoringType | ConfigureProp | Scoring Type configuration | — |
studentInstructions | ConfigureProp | Student Instructions configuration | — |
teacherInstructions | EditableHtmlPluginConfigureRequired | Teacher Instructions configuration | — |
maxSelections | number | Maximum number of selected tokens in correct answer | — |
minTokens | number | Minimum number of tokens | 2 |
maxTokens | number | Maximum number of tokens | — |
maxImageWidth | ConfigureMaxImageDimensionsProp | Maximum image width for input fields | — |
maxImageHeight | ConfigureMaxImageDimensionsProp | 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 |
|---|---|---|---|
eventRequired | 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. | — |
iconAltRequired | string | The alt for the custom button icon | — |
iconTypeRequired | string | The icon type. Currently, only "SVG" is supported. | — |
iconRequired | 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) | — |
ConfigureMaxImageDimensionsProp
| 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 | — |
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 |
|---|---|---|---|
labelRequired | string | See the named type or the example model. | — |
optionsRequired | array | See the named type or the example model. | — |
ConfigureLanguageOptionsProp
| Field | Type | Meaning | Default / values |
|---|---|---|---|
valueRequired | string | Value of the language option | — |
labelRequired | 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. | — |
session fields (3)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
id | string | Identifier of the session | — |
element | string | The element the session belongs to | — |
selectedTokens | array | The tokens the student selected | — |
Named object types
TextToken
| Field | Type | Meaning | Default / values |
|---|---|---|---|
text | string | The token text | — |
startRequired | number | The start point in the main text for this token | — |
endRequired | number | The end point in the main text for this token | — |
correct | boolean | Is selected does the token represent a correct response | — |
oldStart | number | The start point before the author re-parsed the text; scoring matches a selection on either position | — |
oldEnd | number | The end point before the author re-parsed the text; scoring matches a selection on either position | — |
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