<choiceInput>

<choiceInput> is an Input component that defines a block of code for multiple choice questions. It serves as a container element for the individual <choice> components that are nested within.

Attributes and Properties

Example: <choiceInput> for survey question

<choiceInput>
  <choice>Agree</choice>
  <choice>Neutral</choice>
  <choice>Disagree</choice>
</choiceInput>

A <choiceInput> is used to collect user responses that do not require validation.

Example: <choiceInput> in <answer>

<answer>
  <choiceInput>
    <choice credit="1">This is correct.</choice>
    <choice credit="0.5">This is partially correct.</choice>
    <choice>This is all the way wrong.</choice>
  </choiceInput>
</answer> 

A <choiceInput> can be nested within an <answer> to collect user responses with validation.

Example: <choiceInput> as a menu

A <choiceInput> can be used in combination with <conditionalContent> to create a simple menu.

Attribute Example: selectMultiple

<choiceInput selectMultiple>
    <choice>Red</choice>
    <choice>Purple</choice>
    <choice>Blue</choice>
    <choice>Yellow</choice>
  </choiceInput>

The selectMultiple allows users to select multiple <choice> components in a <choiceInput>.

Attribute Example: matchPartial

<p>What colors combine to make green?</p>
  <answer>
  <choiceInput selectMultiple matchPartial>
    <choice>Red</choice>
    <choice>Purple</choice>
    <choice credit="1">Blue</choice>
    <choice credit="1">Yellow</choice>
  </choiceInput>
  </answer>

If an <answer> requires more than one <choice> selection for full credit, the matchPartial attribute can be used to assign partial credit if one or more of the total number of correct choices are selected within a <choiceInput>.

Attribute Example: inline

<choiceInput inline>
  <choice>A</choice>
  <choice>B</choice>
  <choice>C</choice>
</choiceInput>

The inline attribute provides a pull-down menu for <choice> selection rather than the default radio buttons.

Attribute Example: shuffleOrder

<choiceInput shuffleOrder>
  <choice>A</choice>
  <choice>B</choice>
  <choice>C</choice>
  <choice>D</choice>
  <choice>E</choice>
</choiceInput>

With the shuffleOrder attribute, the sequenceing of the choices is different for each page variant.

Attribute Example: preselectChoice

<choiceInput preselectChoice="2">
  <choice>A</choice>
  <choice>B</choice>
  <choice>C</choice>
</choiceInput>

The preselectChoice attributes takes the index of the choice to preselect.

Attribute Example: bindValueTo

<slider name="m" from="1" to="4"/>
<choiceInput bindValueTo="$m">
  <choice>1</choice>
  <choice>2</choice>
  <choice>3</choice>
  <choice>4</choice>
</choiceInput>

The <bindValueTo> takes a named component as input. The value of the <choiceInput> then becomes linked to that component’s value.

Attribute Example: submitLabel

Guess my age: <answer>
<choiceInput submitLabel="Enter guess">
  <choice>0 - 10 years</choice>
  <choice>10 - 20 years</choice>
  <choice credit="1">20 - 200 years</choice>
</choiceInput>
</answer>      

The submitLabel attribute can be used to create a custom label for the “Check Work” button.

Attribute Example: submitLabelNoCorrectness

<p>What's the magic number?</p>
<answer showCorrectness="false">
<choiceInput submitLabelNoCorrectness="Guess Magic Number">
  <choice><m>\pi</m></choice>
  <choice>100</choice>
  <choice credit="1">42</choice>
</choiceInput>
</answer> 

The submitLabelNoCorrectness attribute modifies the standard “Submit Response” button label for answers where it is not desired to show correctness.

Property Example: numChoices

The numChoices property returns the number of nested <choice> children in the named <choiceInput>.

Property Example: choiceTexts

The choiceTexts property renders the texts contained in the <choiceInput> in an array.

Property Example: choiceMaths

The choiceMaths property renders the maths contained in the <choiceInput> in an array.

Property Example: selectedIndices

The selectedIndices property renders an array of the indices of all choices selected by the user.

Property Example: selectedValues

The selectedValues property renders an array of the values contained in all of the choices selected by the user.

Property Example: feedbacks

The feedbacks property should be copied in the document at the location where feedback should appear based on the specified interactions.